Outposts

Table of Contents

Client

class Outposts.Client

A low-level client representing AWS Outposts:

import boto3

client = boto3.client('outposts')

These are the available methods:

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_outpost(**kwargs)

Creates an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string'
)
Parameters
  • Name (string) -- The name of the Outpost.
  • Description (string) -- The Outpost description.
  • SiteId (string) --

    [REQUIRED]

    The ID of the site.

  • AvailabilityZone (string) --

    The Availability Zone.

    You must specify AvailabilityZone or AvailabilityZoneId .

  • AvailabilityZoneId (string) --

    The ID of the Availability Zone.

    You must specify AvailabilityZone or AvailabilityZoneId .

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

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.

        You must specify AvailabilityZone or AvailabilityZoneId .

      • AvailabilityZoneId (string) --

        The ID of the Availability Zone.

        You must specify AvailabilityZone or AvailabilityZoneId .

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) --
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) --
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • 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.
Returns

The presigned url

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

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.

        You must specify AvailabilityZone or AvailabilityZoneId .

      • AvailabilityZoneId (string) --

        The ID of the Availability Zone.

        You must specify AvailabilityZone or AvailabilityZoneId .

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.

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)

List the Outposts for your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_outposts(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum page size.
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'
        },
    ],
    '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.

          You must specify AvailabilityZone or AvailabilityZoneId .

        • AvailabilityZoneId (string) --

          The ID of the Availability Zone.

          You must specify AvailabilityZone or AvailabilityZoneId .

    • NextToken (string) --

      The pagination token.

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'
        },
    ],
    '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.

Paginators

The available paginators are: