Greengrass / Client / get_logger_definition_version

get_logger_definition_version#

Greengrass.Client.get_logger_definition_version(**kwargs)#

Retrieves information about a logger definition version.

See also: AWS API Documentation

Request Syntax

response = client.get_logger_definition_version(
    LoggerDefinitionId='string',
    LoggerDefinitionVersionId='string',
    NextToken='string'
)
Parameters:

  • LoggerDefinitionId (string) – [REQUIRED] The ID of the logger definition.

  • LoggerDefinitionVersionId (string) – [REQUIRED] 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Loggers': [
            {
                'Component': 'GreengrassSystem'|'Lambda',
                'Id': 'string',
                'Level': 'DEBUG'|'INFO'|'WARN'|'ERROR'|'FATAL',
                'Space': 123,
                'Type': 'FileSystem'|'AWSCloudWatch'
            },
        ]
    },
    'Id': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) – success

    • 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 (dict) – Information about the logger definition version.

      • Loggers (list) – A list of loggers.

        • (dict) – 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.

Exceptions