Greengrass / Client / create_connector_definition

create_connector_definition#

Greengrass.Client.create_connector_definition(**kwargs)#

Creates a connector definition. You may provide the initial version of the connector definition now or use ‘’CreateConnectorDefinitionVersion’’ at a later time.

See also: AWS API Documentation

Request Syntax

response = client.create_connector_definition(
    AmznClientToken='string',
    InitialVersion={
        'Connectors': [
            {
                'ConnectorArn': 'string',
                'Id': 'string',
                'Parameters': {
                    'string': '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 connector definition.

    • Connectors (list) – A list of references to connectors in this version, with their corresponding configuration settings.

      • (dict) – Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

        • ConnectorArn (string) – [REQUIRED] The ARN of the connector.

        • Id (string) – [REQUIRED] A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.

        • Parameters (dict) – The parameters or configuration that the connector uses.

          • (string) –

            • (string) –

  • Name (string) – The name of the connector 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