Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . greengrass ]
get-core-definition-version¶
Synopsis¶
get-core-definition-version
--core-definition-id <value>
--core-definition-version-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--core-definition-id (string)
The ID of the core definition.
--core-definition-version-id (string)
The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To retrieve details about a specific version of the Greengrass core definition
The following get-core-definition-version example retrieves information about the specified version of the specified core definition. To retrieve the IDs of all versions of the core definition, use the list-core-definition-versions command. To retrieve the ID of the last version added to the core definition, use the get-core-definition command and check the LatestVersion property.
aws greengrass get-core-definition-version \
--core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" \
--core-definition-version-id "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0"
Output:
{
"Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0",
"CreationTimestamp": "2019-06-18T16:21:21.351Z",
"Definition": {
"Cores": [
{
"CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/928dea7b82331b47c3ff77b0e763fc5e64e2f7c884e6ef391baed9b6b8e21b45",
"Id": "1a39aac7-0885-4417-91f6-23e4cea6c511",
"SyncShadow": false,
"ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/GGGroup4Pi3_Core"
}
]
},
"Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46",
"Version": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0"
}
Output¶
Arn -> (string)
The ARN of the core definition version.
CreationTimestamp -> (string)
The time, in milliseconds since the epoch, when the core definition version was created.
Definition -> (structure)
Information about the core definition version.
Cores -> (list)
A list of cores in the core definition version.
(structure)
Information about a core.
CertificateArn -> (string)
The ARN of the certificate associated with the core.Id -> (string)
A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.SyncShadow -> (boolean)
If true, the core's local shadow is automatically synced with the cloud.ThingArn -> (string)
The ARN of the thing which is the core.
Id -> (string)
The ID of the core definition version.
NextToken -> (string)
The token for the next set of results, or ''null'' if there are no additional results.
Version -> (string)
The version of the core definition version.