Table of Contents
A low-level client representing AWS Outposts:
import boto3
client = boto3.client('outposts')
These are the available methods:
Check if an operation can be paginated.
Creates an Outpost.
See also: AWS API Documentation
Request Syntax
response = client.create_outpost(
Name='string',
Description='string',
SiteId='string',
AvailabilityZone='string',
AvailabilityZoneId='string'
)
[REQUIRED]
The ID of the site.
dict
Response Syntax
{
'Outpost': {
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': '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 Outpost description.
LifeCycleStatus (string) --
The life cycle status.
AvailabilityZone (string) --
The Availability Zone.
AvailabilityZoneId (string) --
The ID of the Availability Zone.
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets information about the specified Outpost.
See also: AWS API Documentation
Request Syntax
response = client.get_outpost(
OutpostId='string'
)
[REQUIRED]
The ID of the Outpost.
{
'Outpost': {
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string'
}
}
Response Structure
Information about an Outpost.
The ID of the Outpost.
The AWS account ID of the Outpost owner.
The Amazon Resource Name (ARN) of the Outpost.
The ID of the site.
The name of the Outpost.
The Outpost description.
The life cycle status.
The Availability Zone.
The ID of the Availability Zone.
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
)
[REQUIRED]
The ID of the Outpost.
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.
Create a paginator for an operation.
Returns an object that can wait for some condition.
List the Outposts for your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_outposts(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Outposts': [
{
'OutpostId': 'string',
'OwnerId': 'string',
'OutpostArn': 'string',
'SiteId': 'string',
'Name': 'string',
'Description': 'string',
'LifeCycleStatus': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': '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 Outpost description.
LifeCycleStatus (string) --
The life cycle status.
AvailabilityZone (string) --
The Availability Zone.
AvailabilityZoneId (string) --
The ID of the Availability Zone.
NextToken (string) --
The pagination token.
Lists the sites for the specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_sites(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Sites': [
{
'SiteId': 'string',
'AccountId': 'string',
'Name': 'string',
'Description': '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.
NextToken (string) --
The pagination token.
The available paginators are: