create_site

IoTRoboRunner.Client.create_site(**kwargs)

Grants permission to create a site

See also: AWS API Documentation

Request Syntax

response = client.create_site(
    clientToken='string',
    name='string',
    countryCode='string',
    description='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.

  • countryCode (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': '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

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

Exceptions

  • IoTRoboRunner.Client.exceptions.ConflictException
  • IoTRoboRunner.Client.exceptions.AccessDeniedException
  • IoTRoboRunner.Client.exceptions.ValidationException
  • IoTRoboRunner.Client.exceptions.ThrottlingException
  • IoTRoboRunner.Client.exceptions.InternalServerException
  • IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException