A low-level client representing AWS Outposts
AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
client = session.create_client('outposts')
These are the available methods:
Check if an operation can be paginated.
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").
True if the operation can be paginated,
False otherwise.
Creates an Outpost.
You can specify AvailabilityZone or AvailabilityZoneId .
See also: AWS API Documentation
Request Syntax
response = client.create_outpost(
Name='string',
Description='string',
SiteId='string',
AvailabilityZone='string',
AvailabilityZoneId='string',
Tags={
'string': 'string'
}
)
Name (string) –
[REQUIRED]
The name of the Outpost.
Description (string) – The description of the Outpost.
SiteId (string) –
[REQUIRED]
The ID of the site.
AvailabilityZone (string) – The Availability Zone.
AvailabilityZoneId (string) – The ID of the Availability Zone.
Tags (dict) –
The tags to apply to the Outpost.
(string) –
(string) –
dict
Response Syntax
{
'Outpost': {
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'Tags': {
'string': 'string'
},
'SiteArn': 'string'
}
}
Response Structure
(dict) –
Outpost (dict) –
Information about an Outpost.
OutpostId (string) –
The ID of the Outpost.
OwnerId (string) –
The AWS account ID of the Outpost owner.
OutpostArn (string) –
The Amazon Resource Name (ARN) of the Outpost.
SiteId (string) –
The ID of the site.
Name (string) –
The name of the Outpost.
Description (string) –
The description of the Outpost.
LifeCycleStatus (string) –
The life cycle status.
AvailabilityZone (string) –
The Availability Zone.
AvailabilityZoneId (string) –
The ID of the Availability Zone.
Tags (dict) –
The Outpost tags.
(string) –
(string) –
SiteArn (string) –
The Amazon Resource Name (ARN) of the site.
Exceptions
Deletes the Outpost.
See also: AWS API Documentation
Request Syntax
response = client.delete_outpost(
OutpostId='string'
)
OutpostId (string) –
[REQUIRED]
The ID of the Outpost.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Deletes the site.
See also: AWS API Documentation
Request Syntax
response = client.delete_site(
SiteId='string'
)
SiteId (string) –
[REQUIRED]
The ID of the site.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
Gets information about the specified Outpost.
See also: AWS API Documentation
Request Syntax
response = client.get_outpost(
OutpostId='string'
)
OutpostId (string) –
[REQUIRED]
The ID of the Outpost.
dict
Response Syntax
{
'Outpost': {
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'Tags': {
'string': 'string'
},
'SiteArn': 'string'
}
}
Response Structure
(dict) –
Outpost (dict) –
Information about an Outpost.
OutpostId (string) –
The ID of the Outpost.
OwnerId (string) –
The AWS account ID of the Outpost owner.
OutpostArn (string) –
The Amazon Resource Name (ARN) of the Outpost.
SiteId (string) –
The ID of the site.
Name (string) –
The name of the Outpost.
Description (string) –
The description of the Outpost.
LifeCycleStatus (string) –
The life cycle status.
AvailabilityZone (string) –
The Availability Zone.
AvailabilityZoneId (string) –
The ID of the Availability Zone.
Tags (dict) –
The Outpost tags.
(string) –
(string) –
SiteArn (string) –
The Amazon Resource Name (ARN) of the site.
Exceptions
Lists the instance types for the specified Outpost.
See also: AWS API Documentation
Request Syntax
response = client.get_outpost_instance_types(
OutpostId='string',
NextToken='string',
MaxResults=123
)
OutpostId (string) –
[REQUIRED]
The ID of the Outpost.
NextToken (string) – The pagination token.
MaxResults (integer) – The maximum page size.
dict
Response Syntax
{
'InstanceTypes': [
{
'InstanceType': 'string'
},
],
'NextToken': 'string',
'OutpostId': 'string',
'OutpostArn': 'string'
}
Response Structure
(dict) –
InstanceTypes (list) –
Information about the instance types.
(dict) –
Information about an instance type.
InstanceType (string) –
The instance type.
NextToken (string) –
The pagination token.
OutpostId (string) –
The ID of the Outpost.
OutpostArn (string) –
The Amazon Resource Name (ARN) of the Outpost.
Exceptions
Create a paginator for an operation.
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").
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a ), and AZ ID (use1-az1 ).
If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
See also: AWS API Documentation
Request Syntax
response = client.list_outposts(
NextToken='string',
MaxResults=123,
LifeCycleStatusFilter=[
'string',
],
AvailabilityZoneFilter=[
'string',
],
AvailabilityZoneIdFilter=[
'string',
]
)
NextToken (string) – The pagination token.
MaxResults (integer) – The maximum page size.
LifeCycleStatusFilter (list) –
A filter for the lifecycle status of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) –
The life cycle status.
AvailabilityZoneFilter (list) –
A filter for the Availibility Zone (us-east-1a ) of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) –
The Availability Zone.
AvailabilityZoneIdFilter (list) –
A filter for the AZ IDs (use1-az1 ) of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) –
The ID of the Availability Zone.
dict
Response Syntax
{
'Outposts': [
{
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'Tags': {
'string': 'string'
},
'SiteArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Outposts (list) –
Information about the Outposts.
(dict) –
Information about an Outpost.
OutpostId (string) –
The ID of the Outpost.
OwnerId (string) –
The AWS account ID of the Outpost owner.
OutpostArn (string) –
The Amazon Resource Name (ARN) of the Outpost.
SiteId (string) –
The ID of the site.
Name (string) –
The name of the Outpost.
Description (string) –
The description of the Outpost.
LifeCycleStatus (string) –
The life cycle status.
AvailabilityZone (string) –
The Availability Zone.
AvailabilityZoneId (string) –
The ID of the Availability Zone.
Tags (dict) –
The Outpost tags.
(string) –
(string) –
SiteArn (string) –
The Amazon Resource Name (ARN) of the site.
NextToken (string) –
The pagination token.
Exceptions
Lists the sites for the specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_sites(
NextToken='string',
MaxResults=123
)
NextToken (string) – The pagination token.
MaxResults (integer) – The maximum page size.
dict
Response Syntax
{
'Sites': [
{
'SiteId': 'string',
'AccountId': 'string',
'Name': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'SiteArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Sites (list) –
Information about the sites.
(dict) –
Information about a site.
SiteId (string) –
The ID of the site.
AccountId (string) –
The ID of the AWS account.
Name (string) –
The name of the site.
Description (string) –
The description of the site.
Tags (dict) –
The site tags.
(string) –
(string) –
SiteArn (string) –
The Amazon Resource Name (ARN) of the site.
NextToken (string) –
The pagination token.
Exceptions
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
Tags (dict) –
The resource tags.
(string) –
(string) –
Exceptions
Adds tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
Tags (dict) –
[REQUIRED]
The tags to add to the resource.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Removes tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
TagKeys (list) –
[REQUIRED]
The tag keys.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
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:
You do not have permission to perform this operation.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.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) –
You do not have permission to perform this operation.
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.
Updating or deleting this resource can cause an inconsistent state.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.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',
'ResourceId': 'string',
'ResourceType': 'OUTPOST',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Updating or deleting this resource can cause an inconsistent state.
Message (string) –
ResourceId (string) –
The ID of the resource causing the conflict.
ResourceType (string) –
The type of the resource causing the conflict.
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.
An internal error has occurred.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.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) –
An internal error has occurred.
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.
The specified request is not valid.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.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) –
The specified request is not valid.
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.
You have exceeded a service quota.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.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) –
You have exceeded a service quota.
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.
A parameter is not valid.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.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) –
A parameter is not valid.
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.
The available paginators are: