Amazon S3 on Outposts

2021/07/23 - Amazon S3 on Outposts - 2 updated api methods

Changes  Add on-premise access type support for endpoints

CreateEndpoint (updated) Link ¶
Changes (request) 
{'AccessType': 'Private | CustomerOwnedIp', 'CustomerOwnedIpv4Pool': 'string'}

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.

Related actions include:

See also: AWS API Documentation

Request Syntax

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

string

param OutpostId:

[REQUIRED]

The ID of the AWS Outposts.

type SubnetId:

string

param SubnetId:

[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.

type SecurityGroupId:

string

param SecurityGroupId:

[REQUIRED]

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

type AccessType:

string

param AccessType:

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.

type CustomerOwnedIpv4Pool:

string

param CustomerOwnedIpv4Pool:

The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.

rtype:

dict

returns:

Response Syntax

{
    'EndpointArn': 'string'
}

Response Structure

  • (dict) --

    • EndpointArn (string) --

      The Amazon Resource Name (ARN) of the endpoint.

ListEndpoints (updated) Link ¶
Changes (response) 
{'Endpoints': {'AccessType': 'Private | CustomerOwnedIp',
               'CustomerOwnedIpv4Pool': 'string',
               'SecurityGroupId': 'string',
               'Status': {'Pending', 'Deleting', 'Available'},
               'SubnetId': 'string',
               'VpcId': 'string'}}

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:

See also: AWS API Documentation

Request Syntax

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

string

param NextToken:

The next endpoint requested in the list.

type MaxResults:

integer

param MaxResults:

The max number of endpoints that can be returned on the request.

rtype:

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.