create_core_definition

Greengrass.Client.create_core_definition(**kwargs)

Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

See also: AWS API Documentation

Request Syntax

response = client.create_core_definition(
    AmznClientToken='string',
    InitialVersion={
        'Cores': [
            {
                'CertificateArn': 'string',
                'Id': 'string',
                'SyncShadow': True|False,
                'ThingArn': 'string'
            },
        ]
    },
    Name='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • AmznClientToken (string) -- A client token used to correlate requests and responses.
  • InitialVersion (dict) --

    Information about the initial version of the core definition.

    • Cores (list) -- A list of cores in the core definition version.
      • (dict) -- Information about a core.
        • CertificateArn (string) -- [REQUIRED] The ARN of the certificate associated with the core.
        • Id (string) -- [REQUIRED] 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) -- [REQUIRED] The ARN of the thing which is the core.
  • Name (string) -- The name of the core definition.
  • tags (dict) --

    Tag(s) to add to the new resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Id': 'string',
    'LastUpdatedTimestamp': 'string',
    'LatestVersion': 'string',
    'LatestVersionArn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) --
    • Arn (string) -- The ARN of the definition.
    • CreationTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was created.
    • Id (string) -- The ID of the definition.
    • LastUpdatedTimestamp (string) -- The time, in milliseconds since the epoch, when the definition was last updated.
    • LatestVersion (string) -- The ID of the latest version associated with the definition.
    • LatestVersionArn (string) -- The ARN of the latest version associated with the definition.
    • Name (string) -- The name of the definition.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException