AWS API Changes

2022/11/18 - AWS IoT RoboRunner - 20 new api methods

Changes AWS IoT RoboRunner is a new service that makes it easy to build applications that help multi-vendor robots work together seamlessly. See the IoT RoboRunner developer guide for more details on getting started. https://docs.aws.amazon.com/iotroborunner/latest/dev/iotroborunner-welcome.html

DeleteSite (new)

Link ¶

Grants permission to delete a site

See also: AWS API Documentation

Request Syntax

client.delete_site(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Site ARN.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateSite (new)

Link ¶

Grants permission to create a site

See also: AWS API Documentation

Request Syntax

client.create_site(
    clientToken='string',
    name='string',
    countryCode='string',
    description='string'
)

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

Human friendly name of the resource.

type countryCode:

string

param countryCode:

[REQUIRED]

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

type description:

string

param description:

A high-level description of the site.

rtype:

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.

UpdateDestination (new)

Link ¶

Grants permission to update a destination

See also: AWS API Documentation

Request Syntax

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

type id:

string

param id:

[REQUIRED]

Destination ARN.

type name:

string

param name:

Human friendly name of the resource.

type state:

string

param state:

State of the destination.

type additionalFixedProperties:

string

param additionalFixedProperties:

JSON document containing additional fixed properties regarding the destination

rtype:

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

GetDestination (new)

Link ¶

Grants permission to get a destination

See also: AWS API Documentation

Request Syntax

client.get_destination(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Destination ARN.

rtype:

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

GetSite (new)

Link ¶

Grants permission to get a site

See also: AWS API Documentation

Request Syntax

client.get_site(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Site ARN.

rtype:

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.

DeleteDestination (new)

Link ¶

Grants permission to delete a destination

See also: AWS API Documentation

Request Syntax

client.delete_destination(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Destination ARN.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteWorker (new)

Link ¶

Grants permission to delete a worker

See also: AWS API Documentation

Request Syntax

client.delete_worker(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListWorkerFleets (new)

Link ¶

Grants permission to list worker fleets

See also: AWS API Documentation

Request Syntax

client.list_worker_fleets(
    site='string',
    maxResults=123,
    nextToken='string'
)

type site:

string

param site:

[REQUIRED]

Site ARN.

type maxResults:

integer

param maxResults:

Maximum number of results to retrieve in a single ListWorkerFleets call.

type nextToken:

string

param nextToken:

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

rtype:

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

UpdateWorkerFleet (new)

Link ¶

Grants permission to update a worker fleet

See also: AWS API Documentation

Request Syntax

client.update_worker_fleet(
    id='string',
    name='string',
    additionalFixedProperties='string'
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker fleet.

type name:

string

param name:

Human friendly name of the resource.

type additionalFixedProperties:

string

param additionalFixedProperties:

JSON blob containing additional fixed properties regarding the worker fleet

rtype:

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

CreateWorker (new)

Link ¶

Grants permission to create a worker

See also: AWS API Documentation

Request Syntax

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
    }
)

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

Human friendly name of the resource.

type fleet:

string

param fleet:

[REQUIRED]

Full ARN of the worker fleet.

type additionalTransientProperties:

string

param additionalTransientProperties:

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

type additionalFixedProperties:

string

param additionalFixedProperties:

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

type vendorProperties:

dict

param vendorProperties:

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.

type position:

dict

param position:

Supported coordinates for worker position.

cartesianCoordinates (dict) --

Cartesian coordinates.
- x (float) -- [REQUIRED]
  
  X coordinate.
- y (float) -- [REQUIRED]
  
  Y coordinate.
- z (float) --
  
  Z coordinate.

type orientation:

dict

param orientation:

Worker orientation measured in units clockwise from north.

degrees (float) --

Degrees, limited on [0, 360)

rtype:

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.

DeleteWorkerFleet (new)

Link ¶

Grants permission to delete a worker fleet

See also: AWS API Documentation

Request Syntax

client.delete_worker_fleet(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker fleet.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateDestination (new)

Link ¶

Grants permission to create a destination

See also: AWS API Documentation

Request Syntax

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

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

Human friendly name of the resource.

type site:

string

param site:

[REQUIRED]

Site ARN.

type state:

string

param state:

The state of the destination. Default used if not specified.

type additionalFixedProperties:

string

param additionalFixedProperties:

JSON document containing additional fixed properties regarding the destination

rtype:

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.

ListSites (new)

Link ¶

Grants permission to list sites

See also: AWS API Documentation

Request Syntax

client.list_sites(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

Maximum number of results to retrieve in a single ListSites call.

type nextToken:

string

param nextToken:

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

rtype:

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.

CreateWorkerFleet (new)

Link ¶

Grants permission to create a worker fleet

See also: AWS API Documentation

Request Syntax

client.create_worker_fleet(
    clientToken='string',
    name='string',
    site='string',
    additionalFixedProperties='string'
)

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type name:

string

param name:

[REQUIRED]

Human friendly name of the resource.

type site:

string

param site:

[REQUIRED]

Site ARN.

type additionalFixedProperties:

string

param additionalFixedProperties:

JSON blob containing additional fixed properties regarding the worker fleet

rtype:

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.

GetWorker (new)

Link ¶

Grants permission to get a worker

See also: AWS API Documentation

Request Syntax

client.get_worker(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker.

rtype:

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)

ListWorkers (new)

Link ¶

Grants permission to list workers

See also: AWS API Documentation

Request Syntax

client.list_workers(
    site='string',
    maxResults=123,
    nextToken='string',
    fleet='string'
)

type site:

string

param site:

[REQUIRED]

Site ARN.

type maxResults:

integer

param maxResults:

Maximum number of results to retrieve in a single ListWorkers call.

type nextToken:

string

param nextToken:

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

type fleet:

string

param fleet:

Full ARN of the worker fleet.

rtype:

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)

ListDestinations (new)

Link ¶

Grants permission to list destinations

See also: AWS API Documentation

Request Syntax

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

type site:

string

param site:

[REQUIRED]

Site ARN.

type maxResults:

integer

param maxResults:

Maximum number of results to retrieve in a single call.

type nextToken:

string

param nextToken:

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

type state:

string

param state:

State of the destination.

rtype:

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

UpdateSite (new)

Link ¶

Grants permission to update a site

See also: AWS API Documentation

Request Syntax

client.update_site(
    id='string',
    name='string',
    countryCode='string',
    description='string'
)

type id:

string

param id:

[REQUIRED]

Site ARN.

type name:

string

param name:

Human friendly name of the resource.

type countryCode:

string

param countryCode:

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

type description:

string

param description:

A high-level description of the site.

rtype:

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.

GetWorkerFleet (new)

Link ¶

Grants permission to get a worker fleet

See also: AWS API Documentation

Request Syntax

client.get_worker_fleet(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker fleet.

rtype:

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

UpdateWorker (new)

Link ¶

Grants permission to update a worker

See also: AWS API Documentation

Request Syntax

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
    }
)

type id:

string

param id:

[REQUIRED]

Full ARN of the worker.

type name:

string

param name:

Human friendly name of the resource.

type additionalTransientProperties:

string

param additionalTransientProperties:

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

type additionalFixedProperties:

string

param additionalFixedProperties:

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

type vendorProperties:

dict

param vendorProperties:

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.

type position:

dict

param position:

Supported coordinates for worker position.

cartesianCoordinates (dict) --

Cartesian coordinates.
- x (float) -- [REQUIRED]
  
  X coordinate.
- y (float) -- [REQUIRED]
  
  Y coordinate.
- z (float) --
  
  Z coordinate.

type orientation:

dict

param orientation:

Worker orientation measured in units clockwise from north.

degrees (float) --

Degrees, limited on [0, 360)

rtype:

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.