[ aws . greengrass ]

get-logger-definition-version

Description

Retrieves information about a logger definition version.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-logger-definition-version
--logger-definition-id <value>
--logger-definition-version-id <value>
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--logger-definition-id (string) The ID of the logger definition.

--logger-definition-version-id (string) The ID of the logger definition version. This value maps to the ‘’Version’’ property of the corresponding ‘’VersionInformation’’ object, which is returned by ‘’ListLoggerDefinitionVersions’’ requests. If the version is the last one that was associated with a logger definition, the value also maps to the ‘’LatestVersion’’ property of the corresponding ‘’DefinitionInformation’’ object.

--next-token (string) The token for the next set of results, or ‘’null’’ if there are no additional results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve information about a version of a logger definition

The following get-logger-definition-version example retrieves information about the specified version of the specified logger definition. To retrieve the IDs of all versions of the logger definition, use the list-logger-definition-versions command. To retrieve the ID of the last version added to the logger definition, use the get-logger-definition command and check the LatestVersion property.

aws greengrass get-logger-definition-version \
    --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" \
    --logger-definition-version-id "5e3f6f64-a565-491e-8de0-3c0d8e0f2073"

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073",
    "CreationTimestamp": "2019-05-08T16:10:13.866Z",
    "Definition": {
        "Loggers": []
    },
    "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23",
    "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073"
}

Output

Arn -> (string)

The ARN of the logger definition version.

CreationTimestamp -> (string)

The time, in milliseconds since the epoch, when the logger definition version was created.

Definition -> (structure)

Information about the logger definition version.

Loggers -> (list)

A list of loggers.

(structure)

Information about a logger

Component -> (string)

The component that will be subject to logging.

Id -> (string)

A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ‘’[a-zA-Z0-9:_-]+’’.

Level -> (string)

The level of the logs.

Space -> (integer)

The amount of file space, in KB, to use if the local file system is used for logging purposes.

Type -> (string)

The type of log output which will be used.

Id -> (string)

The ID of the logger definition version.

Version -> (string)

The version of the logger definition version.