Table of Contents
IoTRoboRunner.
Client
¶A low-level client representing AWS IoT RoboRunner
An example service, deployed with the Octane Service creator, which will echo the string
import boto3
client = boto3.client('iot-roborunner')
These are the available methods:
can_paginate()
close()
create_destination()
create_site()
create_worker()
create_worker_fleet()
delete_destination()
delete_site()
delete_worker()
delete_worker_fleet()
get_destination()
get_paginator()
get_site()
get_waiter()
get_worker()
get_worker_fleet()
list_destinations()
list_sites()
list_worker_fleets()
list_workers()
update_destination()
update_site()
update_worker()
update_worker_fleet()
can_paginate
(operation_name)¶Check if an operation can be paginated.
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")
.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'
)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
This field is autopopulated if not provided.
[REQUIRED]
Human friendly name of the resource.
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException
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'
)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
This field is autopopulated if not provided.
[REQUIRED]
Human friendly name of the resource.
[REQUIRED]
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
dict
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
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
}
)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
This field is autopopulated if not provided.
[REQUIRED]
Human friendly name of the resource.
[REQUIRED]
Full ARN of the worker fleet.
Properties of the worker that are provided by the vendor FMS.
The worker ID defined by the vendor FMS.
The worker IP address defined by the vendor FMS.
JSON blob containing unstructured vendor properties that are transient and may change during regular operation.
JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.
Supported coordinates for worker position.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cartesianCoordinates
.
Cartesian coordinates.
X coordinate.
Y coordinate.
Z coordinate.
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, limited on [0, 360)
dict
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
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException
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'
)
Token used for detecting replayed requests. Replayed requests will not be performed multiple times.
This field is autopopulated if not provided.
[REQUIRED]
Human friendly name of the resource.
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
IoTRoboRunner.Client.exceptions.ServiceQuotaExceededException
delete_destination
(**kwargs)¶Grants permission to delete a destination
See also: AWS API Documentation
Request Syntax
response = client.delete_destination(
id='string'
)
[REQUIRED]
Destination ARN.
{}
Response Structure
Exceptions
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
delete_site
(**kwargs)¶Grants permission to delete a site
See also: AWS API Documentation
Request Syntax
response = client.delete_site(
id='string'
)
[REQUIRED]
Site ARN.
{}
Response Structure
Exceptions
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
delete_worker
(**kwargs)¶Grants permission to delete a worker
See also: AWS API Documentation
Request Syntax
response = client.delete_worker(
id='string'
)
[REQUIRED]
Full ARN of the worker.
{}
Response Structure
Exceptions
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Full ARN of the worker fleet.
{}
Response Structure
Exceptions
IoTRoboRunner.Client.exceptions.ConflictException
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
get_destination
(**kwargs)¶Grants permission to get a destination
See also: AWS API Documentation
Request Syntax
response = client.get_destination(
id='string'
)
[REQUIRED]
Destination ARN.
{
'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
Destination ARN.
Filters access by the destination's identifier
Human friendly name of the resource.
Site ARN.
Timestamp at which the resource was created.
Timestamp at which the resource was last updated.
State of the destination.
JSON document containing additional fixed properties regarding the destination
Exceptions
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
get_paginator
(operation_name)¶Create a paginator for an operation.
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")
.client.can_paginate
method to
check if an operation is pageable.get_site
(**kwargs)¶Grants permission to get a site
See also: AWS API Documentation
Request Syntax
response = client.get_site(
id='string'
)
[REQUIRED]
Site ARN.
{
'arn': 'string',
'id': 'string',
'name': 'string',
'countryCode': 'string',
'description': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
Site ARN.
Filters access by the site's identifier
Human friendly name of the resource.
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
A high-level description of the site.
Timestamp at which the resource was created.
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
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
get_worker
(**kwargs)¶Grants permission to get a worker
See also: AWS API Documentation
Request Syntax
response = client.get_worker(
id='string'
)
[REQUIRED]
Full ARN of the worker.
{
'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
Full ARN of the worker.
Filters access by the workers identifier
Full ARN of the worker fleet.
Site ARN.
Timestamp at which the resource was created.
Timestamp at which the resource was last updated.
Human friendly name of the resource.
JSON blob containing unstructured worker properties that are transient and may change during regular operation.
JSON blob containing unstructured worker properties that are fixed and won't change during regular operation.
Properties of the worker that are provided by the vendor FMS.
The worker ID defined by the vendor FMS.
The worker IP address defined by the vendor FMS.
JSON blob containing unstructured vendor properties that are transient and may change during regular operation.
JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.
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'}
Cartesian coordinates.
X coordinate.
Y coordinate.
Z coordinate.
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, limited on [0, 360)
Exceptions
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Full ARN of the worker fleet.
{
'id': 'string',
'arn': 'string',
'name': 'string',
'site': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'additionalFixedProperties': 'string'
}
Response Structure
Filters access by the worker fleet's identifier
Full ARN of the worker fleet.
Human friendly name of the resource.
Site ARN.
Timestamp at which the resource was created.
Timestamp at which the resource was last updated.
JSON blob containing additional fixed properties regarding the worker fleet
Exceptions
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
list_sites
(**kwargs)¶Grants permission to list sites
See also: AWS API Documentation
Request Syntax
response = client.list_sites(
maxResults=123,
nextToken='string'
)
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Destination ARN.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Site ARN.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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
}
)
[REQUIRED]
Full ARN of the worker.
Properties of the worker that are provided by the vendor FMS.
The worker ID defined by the vendor FMS.
The worker IP address defined by the vendor FMS.
JSON blob containing unstructured vendor properties that are transient and may change during regular operation.
JSON blob containing unstructured vendor properties that are fixed and won't change during regular operation.
Supported coordinates for worker position.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: cartesianCoordinates
.
Cartesian coordinates.
X coordinate.
Y coordinate.
Z coordinate.
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, limited on [0, 360)
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
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'
)
[REQUIRED]
Full ARN of the worker fleet.
dict
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
IoTRoboRunner.Client.exceptions.AccessDeniedException
IoTRoboRunner.Client.exceptions.ValidationException
IoTRoboRunner.Client.exceptions.ResourceNotFoundException
IoTRoboRunner.Client.exceptions.ThrottlingException
IoTRoboRunner.Client.exceptions.InternalServerException
The available paginators are:
IoTRoboRunner.Paginator.ListDestinations
IoTRoboRunner.Paginator.ListSites
IoTRoboRunner.Paginator.ListWorkerFleets
IoTRoboRunner.Paginator.ListWorkers
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'
}
)
[REQUIRED]
Site ARN.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
{
'sites': [
{
'arn': 'string',
'name': 'string',
'countryCode': 'string',
'createdAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
List of facilities.
Facility containing destinations, workers, activities, and tasks.
Site ARN.
The name of the site. Mutable after creation and unique within a given account.
A valid ISO 3166-1 alpha-2 code for the country in which the site resides. e.g., US.
Timestamp at which the resource was created.
A token to resume pagination.
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'
}
)
[REQUIRED]
Site ARN.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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.
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'
}
)
[REQUIRED]
Site ARN.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
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.