AWS Greengrass
API Reference

GetLoggerDefinitionVersion

Retrieves information about a logger definition version.

URI: GET /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId

Produces: application/json

CLI:

aws greengrass get-logger-definition-version \ --logger-definition-version-id <value> \ --logger-definition-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string" }

Parameters:

LoggerDefinitionVersionId

The ID of the logger definition version.

where used: path; required: true

type: string

LoggerDefinitionId

The ID of the logger definition.

where used: path; required: true

type: string

Responses:

200 (GetLoggerDefinitionVersionResponse)

success

GetLoggerDefinitionVersionResponse

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

Information about a logger definition version.

type: object

Arn

The ARN of the logger definition version.

type: string

Id

The ID of the logger definition version.

type: string

Version

The version of the logger definition version.

type: string

CreationTimestamp

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

type: string

Definition

Information about a logger definition version.

type: object

Loggers

A list of loggers.

type: array

items: Logger

Logger

Information about a logger

type: object

required: ["Id", "Type", "Component", "Level"]

Id

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:_-]+.

type: string

Type

type: string

enum: ["FileSystem", "AWSCloudWatch"]

Component

type: string

enum: ["GreengrassSystem", "Lambda"]

Level

type: string

enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]

Space

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

type: integer

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string