Outposts ¶

Table of Contents

Outposts
- Client
- Paginators

Client ¶

class Outposts.Client¶

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.

import boto3

client = boto3.client('outposts')

These are the available methods:

can_paginate()
create_order()
create_outpost()
delete_outpost()
delete_site()
get_outpost()
get_outpost_instance_types()
get_paginator()
get_waiter()
list_outposts()
list_sites()
list_tags_for_resource()
tag_resource()
untag_resource()

can_paginate(operation_name)¶

Check if an operation can be paginated.

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

create_order(**kwargs)¶

Creates an order for an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.create_order(
    OutpostIdentifier='string',
    LineItems=[
        {
            'CatalogItemId': 'string',
            'Quantity': 123
        },
    ],
    PaymentOption='ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
    PaymentTerm='THREE_YEARS'
)

Parameters

OutpostIdentifier (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.
LineItems (list) --
[REQUIRED]

The line items that make up the order.
- (dict) --
  Information about a line item request.
  - CatalogItemId (string) --
    The ID of the catalog item.
  - Quantity (integer) --
    The quantity of a line item request.
PaymentOption (string) --
[REQUIRED]

The payment option for the order.
PaymentTerm (string) -- The payment terms for the order.

Return type

dict

Returns

Response Syntax

{
    'Order': {
        'OutpostId': 'string',
        'OrderId': 'string',
        'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED',
        'LineItems': [
            {
                'CatalogItemId': 'string',
                'LineItemId': 'string',
                'Quantity': 123,
                'Status': 'string'
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Order (dict) --
  
  Information about this order.
  - OutpostId (string) --
    
    The ID of the Outpost.
  - OrderId (string) --
    
    The ID of the order.
  - Status (string) --
    
    The status of the order
  - LineItems (list) --
    
    The line items for the order
    - (dict) --
      
      Information about a line item.
      - CatalogItemId (string) --
        
        The ID of the catalog item.
      - LineItemId (string) --
        
        The ID of the line item.
      - Quantity (integer) --
        
        The quantity of the line item.
      - Status (string) --
        
        The status of the line item.
  - PaymentOption (string) --
    
    The payment option for the order.
  - OrderSubmissionDate (datetime) --
    
    The submission date for the order.
  - OrderFulfilledDate (datetime) --
    
    The fulfillment date of the order.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ServiceQuotaExceededException

create_outpost(**kwargs)¶

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

Parameters

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

Return type

dict

Returns

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

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ServiceQuotaExceededException

delete_outpost(**kwargs)¶

Deletes the Outpost.

See also: AWS API Documentation

Request Syntax

response = client.delete_outpost(
    OutpostId='string'
)

Parameters

OutpostId (string) --

[REQUIRED]

The ID of the Outpost.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

delete_site(**kwargs)¶

Deletes the site.

See also: AWS API Documentation

Request Syntax

response = client.delete_site(
    SiteId='string'
)

Parameters

SiteId (string) --

[REQUIRED]

The ID of the site.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_outpost(**kwargs)¶

Gets information about the specified Outpost.

See also: AWS API Documentation

Request Syntax

response = client.get_outpost(
    OutpostId='string'
)

Parameters

OutpostId (string) --

[REQUIRED]

The ID of the Outpost.

Return type

dict

Returns

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

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_outpost_instance_types(**kwargs)¶

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
)

Parameters

OutpostId (string) --
[REQUIRED]

The ID of the Outpost.
NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.

Return type

dict

Returns

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

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_paginator(operation_name)¶

Create a paginator for an operation.

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

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

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

list_outposts(**kwargs)¶

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',
    ]
)

Parameters

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.

Return type

dict

Returns

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

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

list_sites(**kwargs)¶

Lists the sites for the specified AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_sites(
    NextToken='string',
    MaxResults=123
)

Parameters

NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.

Return type

dict

Returns

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

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

list_tags_for_resource(**kwargs)¶

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Tags (dict) --
  The resource tags.
  - (string) --
    - (string) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

tag_resource(**kwargs)¶

Adds tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
Tags (dict) --
[REQUIRED]

The tags to add to the resource.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

untag_resource(**kwargs)¶

Removes tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
TagKeys (list) --
[REQUIRED]

The tag keys.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

Paginators ¶

The available paginators are:

Navigation

Table Of Contents

Outposts¶

Client¶

Paginators¶

Navigation

Outposts ¶

Client ¶

Paginators ¶