IoTRoboRunner / Client / create_destination

create_destination

IoTRoboRunner.Client.create_destination(**kwargs)

Grants permission to create a destination

See also: AWS API Documentation

Request Syntax

response = client.create_destination(
    clientToken='string',
    name='string',
    site='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED',
    additionalFixedProperties='string'
)

Parameters:

• clientToken (string) –

  Token used for detecting replayed requests. Replayed requests will not be performed multiple times.

  This field is autopopulated if not provided.

• name (string) –

  [REQUIRED]

  Human friendly name of the resource.

• site (string) –

  [REQUIRED]

  Site ARN.

• state (string) – The state of the destination. Default used if not specified.

• additionalFixedProperties (string) – JSON document containing additional fixed properties regarding the destination

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'state': 'ENABLED'|'DISABLED'|'DECOMMISSIONED'
}

Response Structure

• (dict) –

  • arn (string) –

    Destination ARN.

  • id (string) –

    Filters access by the destination’s identifier

  • createdAt (datetime) –

    Timestamp at which the resource was created.

  • updatedAt (datetime) –

    Timestamp at which the resource was last updated.

  • state (string) –

    State of the destination.

Exceptions

• IoTRoboRunner.Client.exceptions.ConflictException

• IoTRoboRunner.Client.exceptions.AccessDeniedException

• IoTRoboRunner.Client.exceptions.ValidationException

• IoTRoboRunner.Client.exceptions.ResourceNotFoundException

• IoTRoboRunner.Client.exceptions.ThrottlingException

• IoTRoboRunner.Client.exceptions.InternalServerException

• IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException