get_site

IoTRoboRunner.Client.get_site(**kwargs)

Grants permission to get a site

See also: AWS API Documentation

Request Syntax

response = client.get_site(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Site ARN.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'countryCode': 'string',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • arn (string) --

    Site ARN.

  • id (string) --

    Filters access by the site's identifier

  • name (string) --

    Human friendly name of the resource.

  • countryCode (string) --

    A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.

  • description (string) --

    A high-level description of the site.

  • createdAt (datetime) --

    Timestamp at which the resource was created.

  • updatedAt (datetime) --

    Timestamp at which the resource was last updated.

Exceptions

• IoTRoboRunner.Client.exceptions.AccessDeniedException
• IoTRoboRunner.Client.exceptions.ValidationException
• IoTRoboRunner.Client.exceptions.ResourceNotFoundException
• IoTRoboRunner.Client.exceptions.ThrottlingException
• IoTRoboRunner.Client.exceptions.InternalServerException