Greengrass / Client / get_core_definition_version

get_core_definition_version#

Greengrass.Client.get_core_definition_version(**kwargs)#

Retrieves information about a core definition version.

See also: AWS API Documentation

Request Syntax

response = client.get_core_definition_version(
    CoreDefinitionId='string',
    CoreDefinitionVersionId='string'
)
Parameters:
  • CoreDefinitionId (string) – [REQUIRED] The ID of the core definition.

  • CoreDefinitionVersionId (string) – [REQUIRED] 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.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Cores': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) – success

    • 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 (dict) – Information about the core definition version.

      • Cores (list) – A list of cores in the core definition version.

        • (dict) – 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.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException