S3Outposts

Table of Contents

• S3Outposts
  • Client
  • Paginators

Client

class S3Outposts.Client

A low-level client representing Amazon S3 on Outposts (S3 Outposts)

Amazon S3 on Outposts provides access to S3 on Outposts operations.

import boto3

client = boto3.client('s3outposts')

These are the available methods:

• can_paginate()
• create_endpoint()
• delete_endpoint()
• get_paginator()
• get_waiter()
• list_endpoints()

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

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

This action creates an endpoint and associates it with the specified Outposts.

Note

It can take up to 5 minutes for this action to complete.

Related actions include:

• DeleteEndpoint
• ListEndpoints

See also: AWS API Documentation

Request Syntax

response = client.create_endpoint(
    OutpostId='string',
    SubnetId='string',
    SecurityGroupId='string',
    AccessType='Private'|'CustomerOwnedIp',
    CustomerOwnedIpv4Pool='string'
)

Parameters

• OutpostId (string) --

  [REQUIRED]

  The ID of the AWS Outposts.

• SubnetId (string) --

  [REQUIRED]

  The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has the Amazon S3 on Outposts provisioned.

• SecurityGroupId (string) --

  [REQUIRED]

  The ID of the security group to use with the endpoint.

• AccessType (string) -- The type of access for the on-premise network connectivity for the Outpost endpoint. To access the endpoint from an on-premises network, you must specify the access type and provide the customer owned IPv4 pool.
• CustomerOwnedIpv4Pool (string) -- The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.

Return type

dict

Returns

Response Syntax

{
    'EndpointArn': 'string'
}

Response Structure

• (dict) --

  • EndpointArn (string) --

    The Amazon Resource Name (ARN) of the endpoint.

Exceptions

• S3Outposts.Client.exceptions.InternalServerException
• S3Outposts.Client.exceptions.ValidationException
• S3Outposts.Client.exceptions.AccessDeniedException
• S3Outposts.Client.exceptions.ResourceNotFoundException
• S3Outposts.Client.exceptions.ConflictException

delete_endpoint(**kwargs)

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

This action deletes an endpoint.

Note

It can take up to 5 minutes for this action to complete.

Related actions include:

• CreateEndpoint
• ListEndpoints

See also: AWS API Documentation

Request Syntax

response = client.delete_endpoint(
    EndpointId='string',
    OutpostId='string'
)

Parameters

• EndpointId (string) --

  [REQUIRED]

  The ID of the endpoint.

• OutpostId (string) --

  [REQUIRED]

  The ID of the AWS Outposts.

Returns

None

Exceptions

• S3Outposts.Client.exceptions.InternalServerException
• S3Outposts.Client.exceptions.AccessDeniedException
• S3Outposts.Client.exceptions.ResourceNotFoundException
• S3Outposts.Client.exceptions.ValidationException

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

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

This action lists endpoints associated with the Outposts.

Related actions include:

• CreateEndpoint
• DeleteEndpoint

See also: AWS API Documentation

Request Syntax

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

Parameters

• NextToken (string) -- The next endpoint requested in the list.
• MaxResults (integer) -- The max number of endpoints that can be returned on the request.

Return type

dict

Returns

Response Syntax

{
    'Endpoints': [
        {
            'EndpointArn': 'string',
            'OutpostsId': 'string',
            'CidrBlock': 'string',
            'Status': 'Pending'|'Available'|'Deleting',
            'CreationTime': datetime(2015, 1, 1),
            'NetworkInterfaces': [
                {
                    'NetworkInterfaceId': 'string'
                },
            ],
            'VpcId': 'string',
            'SubnetId': 'string',
            'SecurityGroupId': 'string',
            'AccessType': 'Private'|'CustomerOwnedIp',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Endpoints (list) --

    Returns an array of endpoints associated with AWS Outposts.

    • (dict) --

      Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) of the endpoint.

      • OutpostsId (string) --

        The ID of the AWS Outposts.

      • CidrBlock (string) --

        The VPC CIDR committed by this endpoint.

      • Status (string) --

        The status of the endpoint.

      • CreationTime (datetime) --

        The time the endpoint was created.

      • NetworkInterfaces (list) --

        The network interface of the endpoint.

        • (dict) --

          The container for the network interface.

          • NetworkInterfaceId (string) --

            The ID for the network interface.

      • VpcId (string) --

        The ID of the VPC used for the endpoint.

      • SubnetId (string) --

        The ID of the subnet used for the endpoint.

      • SecurityGroupId (string) --

        The ID of the security group used for the endpoint.

      • AccessType (string) --

      • CustomerOwnedIpv4Pool (string) --

        The ID of the customer-owned IPv4 pool used for the endpoint.

  • NextToken (string) --

    The next endpoint returned in the list.

Exceptions

• S3Outposts.Client.exceptions.InternalServerException
• S3Outposts.Client.exceptions.ResourceNotFoundException
• S3Outposts.Client.exceptions.AccessDeniedException
• S3Outposts.Client.exceptions.ValidationException

Paginators

The available paginators are:

• S3Outposts.Paginator.ListEndpoints

class S3Outposts.Paginator.ListEndpoints

paginator = client.get_paginator('list_endpoints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Outposts.Client.list_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

• MaxItems (integer) --

  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.

• PageSize (integer) --

  The size of each page.

• StartingToken (string) --

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Endpoints': [
        {
            'EndpointArn': 'string',
            'OutpostsId': 'string',
            'CidrBlock': 'string',
            'Status': 'Pending'|'Available'|'Deleting',
            'CreationTime': datetime(2015, 1, 1),
            'NetworkInterfaces': [
                {
                    'NetworkInterfaceId': 'string'
                },
            ],
            'VpcId': 'string',
            'SubnetId': 'string',
            'SecurityGroupId': 'string',
            'AccessType': 'Private'|'CustomerOwnedIp',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ],

}

Response Structure

• (dict) --
  • Endpoints (list) --

    Returns an array of endpoints associated with AWS Outposts.

    • (dict) --

      Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC only access points .

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) of the endpoint.

      • OutpostsId (string) --

        The ID of the AWS Outposts.

      • CidrBlock (string) --

        The VPC CIDR committed by this endpoint.

      • Status (string) --

        The status of the endpoint.

      • CreationTime (datetime) --

        The time the endpoint was created.

      • NetworkInterfaces (list) --

        The network interface of the endpoint.

        • (dict) --

          The container for the network interface.

          • NetworkInterfaceId (string) --

            The ID for the network interface.

      • VpcId (string) --

        The ID of the VPC used for the endpoint.

      • SubnetId (string) --

        The ID of the subnet used for the endpoint.

      • SecurityGroupId (string) --

        The ID of the security group used for the endpoint.

      • AccessType (string) --
      • CustomerOwnedIpv4Pool (string) --

        The ID of the customer-owned IPv4 pool used for the endpoint.