Menu
AWS Greengrass
API Reference

/greengrass/definition/loggers/LoggerDefinitionId/versions

POST

POST /greengrass/definition/loggers/LoggerDefinitionId/versions

Operation ID: CreateLoggerDefinitionVersion

Creates a version of a logger definition that has already been defined.

Produces: application/json

Body Parameters

CreateLoggerDefinitionVersionRequestBody

where used: body; required: true

Copy
{ "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }
LoggerDefinitionVersion

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

The id of the logger.

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

Header Parameters

X-Amzn-Client-Token

A client token used to correlate requests and responses.

where used: header; required: false

type: string

Path Parameters

LoggerDefinitionId

The ID of the logger definition.

where used: path; required: true

type: string

CLI

Copy
aws greengrass create-logger-definition-version \ --logger-definition-id <value> \ [--loggers <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "LoggerDefinitionId": "string", "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": "integer" } ], "AmznClientToken": "string" }

Responses

200 (CreateLoggerDefinitionVersionResponse)

VersionInformation

Copy
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }
VersionInformation

Information about a version.

type: object

Arn

The ARN of the version.

type: string

Id

The ID of the version.

type: string

Version

The unique ID of the version.

type: string

CreationTimestamp

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

type: string

400

invalid request

GeneralError

Copy
{ "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

GET

GET /greengrass/definition/loggers/LoggerDefinitionId/versions

Operation ID: ListLoggerDefinitionVersions

Lists the versions of a logger definition.

Produces: application/json

Path Parameters

LoggerDefinitionId

The ID of the logger definition.

where used: path; required: true

type: string

Query Parameters

NextToken

The token for the next set of results, or null if there are no additional results.

where used: query; required: false

type: string

MaxResults

The maximum number of results to be returned per request.

where used: query; required: false

type: integer

CLI

Copy
aws greengrass list-logger-definition-versions \ --logger-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "LoggerDefinitionId": "string", "NextToken": "string", "MaxResults": "integer" }

Responses

200 (ListLoggerDefinitionVersionsResponse)

ListVersionsResponse

Copy
{ "Versions": [ { "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" } ], "NextToken": "string" }
ListVersionsResponse

A list of versions.

type: object

Versions

Information about a version.

type: array

items: VersionInformation

VersionInformation

Information about a version.

type: object

Arn

The ARN of the version.

type: string

Id

The ID of the version.

type: string

Version

The unique ID of the version.

type: string

CreationTimestamp

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

type: string

NextToken

The token for the next set of results, or null if there are no additional results.

type: string

400

invalid request

GeneralError

Copy
{ "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

On this page: