IoT1ClickProjects / Client / describe_placement

describe_placement#

IoT1ClickProjects.Client.describe_placement(**kwargs)#

Describes a placement in a project.

See also: AWS API Documentation

Request Syntax

response = client.describe_placement(
    placementName='string',
    projectName='string'
)
Parameters:

  • placementName (string) –

    [REQUIRED]

    The name of the placement within a project.

  • projectName (string) –

    [REQUIRED]

    The project containing the placement to be described.

Return type:

dict

Returns:

Response Syntax

{
    'placement': {
        'projectName': 'string',
        'placementName': 'string',
        'attributes': {
            'string': 'string'
        },
        'createdDate': datetime(2015, 1, 1),
        'updatedDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • placement (dict) –

      An object describing the placement.

      • projectName (string) –

        The name of the project containing the placement.

      • placementName (string) –

        The name of the placement.

      • attributes (dict) –

        The user-defined attributes associated with the placement.

        • (string) –

          • (string) –

      • createdDate (datetime) –

        The date when the placement was initially created, in UNIX epoch time format.

      • updatedDate (datetime) –

        The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

Exceptions

  • IoT1ClickProjects.Client.exceptions.InternalFailureException

  • IoT1ClickProjects.Client.exceptions.InvalidRequestException

  • IoT1ClickProjects.Client.exceptions.ResourceNotFoundException