AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/definition/loggers
GET
GET /greengrass/definition/loggers
Operation ID: ListLoggerDefinitions
Retrieves a list of logger definitions.
Produces: application/json
Query Parameters
- MaxResults
-
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
CLI
aws greengrass list-logger-definitions \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"MaxResults": "integer",
"NextToken": "string"
}Responses
- 200 (ListLoggerDefinitionsResponse)
-
{ "Definitions": [ { "Name": "string", "Id": "string", "Arn": "string", "tags": { "additionalProperty0": "string", "additionalProperty1": "string", "additionalProperty2": "string" }, "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" } ], "NextToken": "string" }- ListDefinitionsResponse
-
A list of definitions.
type: object
- Definitions
-
Information about a definition.
type: array
items: DefinitionInformation
- DefinitionInformation
-
Information about a definition.
type: object
- Name
-
The name of the definition.
type: string
- Id
-
The ID of the definition.
type: string
- Arn
-
The ARN of the definition.
type: string
- tags
-
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
- LastUpdatedTimestamp
-
The time, in milliseconds since the epoch, when the definition was last updated.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the definition was created.
type: string
- LatestVersion
-
The ID of the latest version associated with the definition.
type: string
- LatestVersionArn
-
The ARN of the latest version associated with the definition.
type: string
- NextToken
-
The token for the next set of results, or
nullif there are no more results.type: string
POST
POST /greengrass/definition/loggers
Operation ID: CreateLoggerDefinition
Creates a logger definition. You can provide the initial version of the logger
definition now or use CreateLoggerDefinitionVersion later.
Produces: application/json
Body Parameters
- CreateLoggerDefinitionRequestBody
-
where used: body; required: true
{ "Name": "string", "InitialVersion": { "Loggers": [ { "Id": "string", "Type": "FileSystem|AWSCloudWatch", "Component": "GreengrassSystem|Lambda", "Level": "DEBUG|INFO|WARN|ERROR|FATAL", "Space": 0 } ] }, "tags": { "keyName0": "string", "keyName1": "string", "keyName2": "string" } }- Name
-
The name of the logger definition.
type: string
- InitialVersion
-
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. Maximum length is 128 characters with the 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
- tags
-
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
CLI
aws greengrass create-logger-definition \ [--name <value>] \ [--initial-version <value>] \ [--tags <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"Name": "string",
"InitialVersion": {
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": "integer"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}Responses
- 200 (CreateLoggerDefinitionResponse)
-
{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }- DefinitionInformation
-
Information about a definition.
type: object
- Name
-
The name of the definition.
type: string
- Id
-
The ID of the definition.
type: string
- Arn
-
The ARN of the definition.
type: string
- LastUpdatedTimestamp
-
The time, in milliseconds since the epoch, when the definition was last updated.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the definition was created.
type: string
- LatestVersion
-
The ID of the latest version associated with the definition.
type: string
- LatestVersionArn
-
The ARN of the latest version associated with the definition.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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
