IoTRoboRunner

Client

class IoTRoboRunner.Client

A low-level client representing AWS IoT RoboRunner

An example service, deployed with the Octane Service creator, which will echo the string

client = session.create_client('iot-roborunner')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

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

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

create_worker(**kwargs)

Grants permission to create a worker

See also: AWS API Documentation

Request Syntax

response = client.create_worker(
    clientToken='string',
    name='string',
    fleet='string',
    additionalTransientProperties='string',
    additionalFixedProperties='string',
    vendorProperties={
        'vendorWorkerId': 'string',
        'vendorWorkerIpAddress': 'string',
        'vendorAdditionalTransientProperties': 'string',
        'vendorAdditionalFixedProperties': 'string'
    },
    position={
        'cartesianCoordinates': {
            'x': 123.0,
            'y': 123.0,
            'z': 123.0
        }
    },
    orientation={
        'degrees': 123.0
    }
)
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.

  • fleet (string) --

    [REQUIRED]

    Full ARN of the worker fleet.

  • additionalTransientProperties (string) -- JSON blob containing unstructured worker properties that are transient and may change during regular operation.
  • additionalFixedProperties (string) -- JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
  • vendorProperties (dict) --

    Properties of the worker that are provided by the vendor FMS.

    • vendorWorkerId (string) -- [REQUIRED]

      The worker ID defined by the vendor FMS.

    • vendorWorkerIpAddress (string) --

      The worker IP address defined by the vendor FMS.

    • vendorAdditionalTransientProperties (string) --

      JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

    • vendorAdditionalFixedProperties (string) --

      JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

  • position (dict) --

    Supported coordinates for worker position.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: cartesianCoordinates.

    • cartesianCoordinates (dict) --

      Cartesian coordinates.

      • x (float) -- [REQUIRED]

        X coordinate.

      • y (float) -- [REQUIRED]

        Y coordinate.

      • z (float) --

        Z coordinate.

  • orientation (dict) --

    Worker orientation measured in units clockwise from north.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: degrees.

    • degrees (float) --

      Degrees, limited on [0, 360)

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'site': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      Full ARN of the worker.

    • id (string) --

      Filters access by the workers identifier

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • site (string) --

      Site ARN.

Exceptions

create_worker_fleet(**kwargs)

Grants permission to create a worker fleet

See also: AWS API Documentation

Request Syntax

response = client.create_worker_fleet(
    clientToken='string',
    name='string',
    site='string',
    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.

  • additionalFixedProperties (string) -- JSON blob containing additional fixed properties regarding the worker fleet
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) --

      Full ARN of the worker fleet.

    • id (string) --

      Filters access by the worker fleet's identifier

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

Exceptions

delete_destination(**kwargs)

Grants permission to delete a destination

See also: AWS API Documentation

Request Syntax

response = client.delete_destination(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Destination ARN.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_site(**kwargs)

Grants permission to delete a site

See also: AWS API Documentation

Request Syntax

response = client.delete_site(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Site ARN.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_worker(**kwargs)

Grants permission to delete a worker

See also: AWS API Documentation

Request Syntax

response = client.delete_worker(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Full ARN of the worker.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_worker_fleet(**kwargs)

Grants permission to delete a worker fleet

See also: AWS API Documentation

Request Syntax

response = client.delete_worker_fleet(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Full ARN of the worker fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

get_destination(**kwargs)

Grants permission to get a destination

See also: AWS API Documentation

Request Syntax

response = client.get_destination(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Destination ARN.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'site': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'state': 'ENABLED'|'DISABLED'|'DECOMMISSIONED',
    'additionalFixedProperties': 'string'
}

Response Structure

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

      Destination ARN.

    • id (string) --

      Filters access by the destination's identifier

    • name (string) --

      Human friendly name of the resource.

    • site (string) --

      Site ARN.

    • 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.

    • additionalFixedProperties (string) --

      JSON document containing additional fixed properties regarding the destination

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
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

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_worker(**kwargs)

Grants permission to get a worker

See also: AWS API Documentation

Request Syntax

response = client.get_worker(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Full ARN of the worker.

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'id': 'string',
    'fleet': 'string',
    'site': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'additionalTransientProperties': 'string',
    'additionalFixedProperties': 'string',
    'vendorProperties': {
        'vendorWorkerId': 'string',
        'vendorWorkerIpAddress': 'string',
        'vendorAdditionalTransientProperties': 'string',
        'vendorAdditionalFixedProperties': 'string'
    },
    'position': {
        'cartesianCoordinates': {
            'x': 123.0,
            'y': 123.0,
            'z': 123.0
        }
    },
    'orientation': {
        'degrees': 123.0
    }
}

Response Structure

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

      Full ARN of the worker.

    • id (string) --

      Filters access by the workers identifier

    • fleet (string) --

      Full ARN of the worker fleet.

    • site (string) --

      Site ARN.

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • name (string) --

      Human friendly name of the resource.

    • additionalTransientProperties (string) --

      JSON blob containing unstructured worker properties that are transient and may change during regular operation.

    • additionalFixedProperties (string) --

      JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

    • vendorProperties (dict) --

      Properties of the worker that are provided by the vendor FMS.

      • vendorWorkerId (string) --

        The worker ID defined by the vendor FMS.

      • vendorWorkerIpAddress (string) --

        The worker IP address defined by the vendor FMS.

      • vendorAdditionalTransientProperties (string) --

        JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

      • vendorAdditionalFixedProperties (string) --

        JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

    • position (dict) --

      Supported coordinates for worker position.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: cartesianCoordinates. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • cartesianCoordinates (dict) --

        Cartesian coordinates.

        • x (float) --

          X coordinate.

        • y (float) --

          Y coordinate.

        • z (float) --

          Z coordinate.

    • orientation (dict) --

      Worker orientation measured in units clockwise from north.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: degrees. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • degrees (float) --

        Degrees, limited on [0, 360)

Exceptions

get_worker_fleet(**kwargs)

Grants permission to get a worker fleet

See also: AWS API Documentation

Request Syntax

response = client.get_worker_fleet(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

Full ARN of the worker fleet.

Return type
dict
Returns
Response Syntax
{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'site': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'additionalFixedProperties': 'string'
}

Response Structure

  • (dict) --
    • id (string) --

      Filters access by the worker fleet's identifier

    • arn (string) --

      Full ARN of the worker fleet.

    • name (string) --

      Human friendly name of the resource.

    • site (string) --

      Site ARN.

    • createdAt (datetime) --

      Timestamp at which the resource was created.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • additionalFixedProperties (string) --

      JSON blob containing additional fixed properties regarding the worker fleet

Exceptions

list_destinations(**kwargs)

Grants permission to list destinations

See also: AWS API Documentation

Request Syntax

response = client.list_destinations(
    site='string',
    maxResults=123,
    nextToken='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED'
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • maxResults (integer) -- Maximum number of results to retrieve in a single call.
  • nextToken (string) -- Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • state (string) -- State of the destination.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'destinations': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'site': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'state': 'ENABLED'|'DISABLED'|'DECOMMISSIONED',
            'additionalFixedProperties': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • destinations (list) --

      List of destinations.

      • (dict) --

        Area within a facility where work can be performed.

        • arn (string) --

          Destination ARN.

        • id (string) --

          Filters access by the destination's identifier

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • 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.

        • additionalFixedProperties (string) --

          JSON document containing additional fixed properties regarding the destination

Exceptions

list_sites(**kwargs)

Grants permission to list sites

See also: AWS API Documentation

Request Syntax

response = client.list_sites(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- Maximum number of results to retrieve in a single ListSites call.
  • nextToken (string) -- Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'sites': [
        {
            'arn': 'string',
            'name': 'string',
            'countryCode': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • sites (list) --

      List of facilities.

      • (dict) --

        Facility containing destinations, workers, activities, and tasks.

        • arn (string) --

          Site ARN.

        • name (string) --

          The name of the site. Mutable after creation and unique within a given account.

        • countryCode (string) --

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

        • createdAt (datetime) --

          Timestamp at which the resource was created.

Exceptions

list_worker_fleets(**kwargs)

Grants permission to list worker fleets

See also: AWS API Documentation

Request Syntax

response = client.list_worker_fleets(
    site='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • maxResults (integer) -- Maximum number of results to retrieve in a single ListWorkerFleets call.
  • nextToken (string) -- Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workerFleets': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'site': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'additionalFixedProperties': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • workerFleets (list) --

      List of worker fleets.

      • (dict) --

        A collection of workers organized within a facility.

        • arn (string) --

          Full ARN of the worker fleet.

        • id (string) --

          Filters access by the worker fleet's identifier

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • createdAt (datetime) --

          Timestamp at which the resource was created.

        • updatedAt (datetime) --

          Timestamp at which the resource was last updated.

        • additionalFixedProperties (string) --

          JSON blob containing additional fixed properties regarding the worker fleet

Exceptions

list_workers(**kwargs)

Grants permission to list workers

See also: AWS API Documentation

Request Syntax

response = client.list_workers(
    site='string',
    maxResults=123,
    nextToken='string',
    fleet='string'
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • maxResults (integer) -- Maximum number of results to retrieve in a single ListWorkers call.
  • nextToken (string) -- Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.
  • fleet (string) -- Full ARN of the worker fleet.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workers': [
        {
            'arn': 'string',
            'id': 'string',
            'fleet': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'site': 'string',
            'additionalTransientProperties': 'string',
            'additionalFixedProperties': 'string',
            'vendorProperties': {
                'vendorWorkerId': 'string',
                'vendorWorkerIpAddress': 'string',
                'vendorAdditionalTransientProperties': 'string',
                'vendorAdditionalFixedProperties': 'string'
            },
            'position': {
                'cartesianCoordinates': {
                    'x': 123.0,
                    'y': 123.0,
                    'z': 123.0
                }
            },
            'orientation': {
                'degrees': 123.0
            }
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      Pagination token returned when another page of data exists. Provide it in your next call to the API to receive the next page.

    • workers (list) --

      List of workers.

      • (dict) --

        A unit capable of performing tasks.

        • arn (string) --

          Full ARN of the worker.

        • id (string) --

          Filters access by the workers identifier

        • fleet (string) --

          Full ARN of the worker fleet.

        • createdAt (datetime) --

          Timestamp at which the resource was created.

        • updatedAt (datetime) --

          Timestamp at which the resource was last updated.

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • additionalTransientProperties (string) --

          JSON blob containing unstructured worker properties that are transient and may change during regular operation.

        • additionalFixedProperties (string) --

          JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

        • vendorProperties (dict) --

          Properties of the worker that are provided by the vendor FMS.

          • vendorWorkerId (string) --

            The worker ID defined by the vendor FMS.

          • vendorWorkerIpAddress (string) --

            The worker IP address defined by the vendor FMS.

          • vendorAdditionalTransientProperties (string) --

            JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

          • vendorAdditionalFixedProperties (string) --

            JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

        • position (dict) --

          Supported coordinates for worker position.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: cartesianCoordinates. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • cartesianCoordinates (dict) --

            Cartesian coordinates.

            • x (float) --

              X coordinate.

            • y (float) --

              Y coordinate.

            • z (float) --

              Z coordinate.

        • orientation (dict) --

          Worker orientation measured in units clockwise from north.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: degrees. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • degrees (float) --

            Degrees, limited on [0, 360)

Exceptions

update_destination(**kwargs)

Grants permission to update a destination

See also: AWS API Documentation

Request Syntax

response = client.update_destination(
    id='string',
    name='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED',
    additionalFixedProperties='string'
)
Parameters
  • id (string) --

    [REQUIRED]

    Destination ARN.

  • name (string) -- Human friendly name of the resource.
  • state (string) -- State of the destination.
  • additionalFixedProperties (string) -- JSON document containing additional fixed properties regarding the destination
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • arn (string) --

      Destination ARN.

    • id (string) --

      Filters access by the destination's identifier

    • name (string) --

      Human friendly name of the resource.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • state (string) --

      State of the destination.

    • additionalFixedProperties (string) --

      JSON document containing additional fixed properties regarding the destination

Exceptions

update_site(**kwargs)

Grants permission to update a site

See also: AWS API Documentation

Request Syntax

response = client.update_site(
    id='string',
    name='string',
    countryCode='string',
    description='string'
)
Parameters
  • id (string) --

    [REQUIRED]

    Site ARN.

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

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'countryCode': 'string',
    'description': 'string',
    '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.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

Exceptions

update_worker(**kwargs)

Grants permission to update a worker

See also: AWS API Documentation

Request Syntax

response = client.update_worker(
    id='string',
    name='string',
    additionalTransientProperties='string',
    additionalFixedProperties='string',
    vendorProperties={
        'vendorWorkerId': 'string',
        'vendorWorkerIpAddress': 'string',
        'vendorAdditionalTransientProperties': 'string',
        'vendorAdditionalFixedProperties': 'string'
    },
    position={
        'cartesianCoordinates': {
            'x': 123.0,
            'y': 123.0,
            'z': 123.0
        }
    },
    orientation={
        'degrees': 123.0
    }
)
Parameters
  • id (string) --

    [REQUIRED]

    Full ARN of the worker.

  • name (string) -- Human friendly name of the resource.
  • additionalTransientProperties (string) -- JSON blob containing unstructured worker properties that are transient and may change during regular operation.
  • additionalFixedProperties (string) -- JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
  • vendorProperties (dict) --

    Properties of the worker that are provided by the vendor FMS.

    • vendorWorkerId (string) -- [REQUIRED]

      The worker ID defined by the vendor FMS.

    • vendorWorkerIpAddress (string) --

      The worker IP address defined by the vendor FMS.

    • vendorAdditionalTransientProperties (string) --

      JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

    • vendorAdditionalFixedProperties (string) --

      JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

  • position (dict) --

    Supported coordinates for worker position.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: cartesianCoordinates.

    • cartesianCoordinates (dict) --

      Cartesian coordinates.

      • x (float) -- [REQUIRED]

        X coordinate.

      • y (float) -- [REQUIRED]

        Y coordinate.

      • z (float) --

        Z coordinate.

  • orientation (dict) --

    Worker orientation measured in units clockwise from north.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: degrees.

    • degrees (float) --

      Degrees, limited on [0, 360)

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'fleet': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'additionalTransientProperties': 'string',
    'additionalFixedProperties': 'string',
    'orientation': {
        'degrees': 123.0
    },
    'vendorProperties': {
        'vendorWorkerId': 'string',
        'vendorWorkerIpAddress': 'string',
        'vendorAdditionalTransientProperties': 'string',
        'vendorAdditionalFixedProperties': 'string'
    },
    'position': {
        'cartesianCoordinates': {
            'x': 123.0,
            'y': 123.0,
            'z': 123.0
        }
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      Full ARN of the worker.

    • id (string) --

      Filters access by the workers identifier

    • fleet (string) --

      Full ARN of the worker fleet.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • name (string) --

      Human friendly name of the resource.

    • additionalTransientProperties (string) --

      JSON blob containing unstructured worker properties that are transient and may change during regular operation.

    • additionalFixedProperties (string) --

      JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

    • orientation (dict) --

      Worker orientation measured in units clockwise from north.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: degrees. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • degrees (float) --

        Degrees, limited on [0, 360)

    • vendorProperties (dict) --

      Properties of the worker that are provided by the vendor FMS.

      • vendorWorkerId (string) --

        The worker ID defined by the vendor FMS.

      • vendorWorkerIpAddress (string) --

        The worker IP address defined by the vendor FMS.

      • vendorAdditionalTransientProperties (string) --

        JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

      • vendorAdditionalFixedProperties (string) --

        JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

    • position (dict) --

      Supported coordinates for worker position.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: cartesianCoordinates. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • cartesianCoordinates (dict) --

        Cartesian coordinates.

        • x (float) --

          X coordinate.

        • y (float) --

          Y coordinate.

        • z (float) --

          Z coordinate.

Exceptions

update_worker_fleet(**kwargs)

Grants permission to update a worker fleet

See also: AWS API Documentation

Request Syntax

response = client.update_worker_fleet(
    id='string',
    name='string',
    additionalFixedProperties='string'
)
Parameters
  • id (string) --

    [REQUIRED]

    Full ARN of the worker fleet.

  • name (string) -- Human friendly name of the resource.
  • additionalFixedProperties (string) -- JSON blob containing additional fixed properties regarding the worker fleet
Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'name': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'additionalFixedProperties': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      Full ARN of the worker fleet.

    • id (string) --

      Filters access by the worker fleet's identifier

    • name (string) --

      Human friendly name of the resource.

    • updatedAt (datetime) --

      Timestamp at which the resource was last updated.

    • additionalFixedProperties (string) --

      JSON blob containing additional fixed properties regarding the worker fleet

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class IoTRoboRunner.Client.exceptions.AccessDeniedException

User does not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    User does not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.ConflictException

Exception thrown if a resource in a create request already exists.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if a resource in a create request already exists.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.InternalServerException

Exception thrown if something goes wrong within the service.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if something goes wrong within the service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.ResourceNotFoundException

Exception thrown if a resource referenced in the request doesn't exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if a resource referenced in the request doesn't exist.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException

Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.ThrottlingException

Exception thrown if the api has been called too quickly be the client.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if the api has been called too quickly be the client.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTRoboRunner.Client.exceptions.ValidationException

Exception thrown if an invalid parameter is provided to an API.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Exception thrown if an invalid parameter is provided to an API.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class IoTRoboRunner.Paginator.ListDestinations
paginator = client.get_paginator('list_destinations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_destinations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    site='string',
    state='ENABLED'|'DISABLED'|'DECOMMISSIONED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • state (string) -- State of the destination.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'destinations': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'site': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'state': 'ENABLED'|'DISABLED'|'DECOMMISSIONED',
            'additionalFixedProperties': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • destinations (list) --

      List of destinations.

      • (dict) --

        Area within a facility where work can be performed.

        • arn (string) --

          Destination ARN.

        • id (string) --

          Filters access by the destination's identifier

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • 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.

        • additionalFixedProperties (string) --

          JSON document containing additional fixed properties regarding the destination

    • NextToken (string) --

      A token to resume pagination.

class IoTRoboRunner.Paginator.ListSites
paginator = client.get_paginator('list_sites')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_sites().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'sites': [
        {
            'arn': 'string',
            'name': 'string',
            'countryCode': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • sites (list) --

      List of facilities.

      • (dict) --

        Facility containing destinations, workers, activities, and tasks.

        • arn (string) --

          Site ARN.

        • name (string) --

          The name of the site. Mutable after creation and unique within a given account.

        • countryCode (string) --

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

        • createdAt (datetime) --

          Timestamp at which the resource was created.

    • NextToken (string) --

      A token to resume pagination.

class IoTRoboRunner.Paginator.ListWorkerFleets
paginator = client.get_paginator('list_worker_fleets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_worker_fleets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    site='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'workerFleets': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'site': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'additionalFixedProperties': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • workerFleets (list) --

      List of worker fleets.

      • (dict) --

        A collection of workers organized within a facility.

        • arn (string) --

          Full ARN of the worker fleet.

        • id (string) --

          Filters access by the worker fleet's identifier

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • createdAt (datetime) --

          Timestamp at which the resource was created.

        • updatedAt (datetime) --

          Timestamp at which the resource was last updated.

        • additionalFixedProperties (string) --

          JSON blob containing additional fixed properties regarding the worker fleet

    • NextToken (string) --

      A token to resume pagination.

class IoTRoboRunner.Paginator.ListWorkers
paginator = client.get_paginator('list_workers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTRoboRunner.Client.list_workers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    site='string',
    fleet='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • site (string) --

    [REQUIRED]

    Site ARN.

  • fleet (string) -- Full ARN of the worker fleet.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'workers': [
        {
            'arn': 'string',
            'id': 'string',
            'fleet': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'site': 'string',
            'additionalTransientProperties': 'string',
            'additionalFixedProperties': 'string',
            'vendorProperties': {
                'vendorWorkerId': 'string',
                'vendorWorkerIpAddress': 'string',
                'vendorAdditionalTransientProperties': 'string',
                'vendorAdditionalFixedProperties': 'string'
            },
            'position': {
                'cartesianCoordinates': {
                    'x': 123.0,
                    'y': 123.0,
                    'z': 123.0
                }
            },
            'orientation': {
                'degrees': 123.0
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • workers (list) --

      List of workers.

      • (dict) --

        A unit capable of performing tasks.

        • arn (string) --

          Full ARN of the worker.

        • id (string) --

          Filters access by the workers identifier

        • fleet (string) --

          Full ARN of the worker fleet.

        • createdAt (datetime) --

          Timestamp at which the resource was created.

        • updatedAt (datetime) --

          Timestamp at which the resource was last updated.

        • name (string) --

          Human friendly name of the resource.

        • site (string) --

          Site ARN.

        • additionalTransientProperties (string) --

          JSON blob containing unstructured worker properties that are transient and may change during regular operation.

        • additionalFixedProperties (string) --

          JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.

        • vendorProperties (dict) --

          Properties of the worker that are provided by the vendor FMS.

          • vendorWorkerId (string) --

            The worker ID defined by the vendor FMS.

          • vendorWorkerIpAddress (string) --

            The worker IP address defined by the vendor FMS.

          • vendorAdditionalTransientProperties (string) --

            JSON blob containing unstructured vendor properties that are transient and may change during regular operation.

          • vendorAdditionalFixedProperties (string) --

            JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.

        • position (dict) --

          Supported coordinates for worker position.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: cartesianCoordinates. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • cartesianCoordinates (dict) --

            Cartesian coordinates.

            • x (float) --

              X coordinate.

            • y (float) --

              Y coordinate.

            • z (float) --

              Z coordinate.

        • orientation (dict) --

          Worker orientation measured in units clockwise from north.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: degrees. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • degrees (float) --

            Degrees, limited on [0, 360)

    • NextToken (string) --

      A token to resume pagination.