You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 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> \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "LoggerDefinitionVersionId": "string", "LoggerDefinitionId": "string", "NextToken": "string" }
Parameters:
- LoggerDefinitionVersionId
-
The ID of the logger definition version. This value maps to the
Version
property of the correspondingVersionInformation
object, which is returned byListLoggerDefinitionVersions
requests. If the version is the last one that was associated with a logger definition, the value also maps to theLatestVersion
property of the correspondingDefinitionInformation
object.where used: path; required: true
type: string
- LoggerDefinitionId
-
The ID of the logger definition.
where used: path; required: true
type: string
- NextToken
-
The token for the next set of results, or
null
if there are no more results.where used: query; required: false
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. 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
- 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