Amazon S3 on Outposts

S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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).

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

Related actions include:

• DeleteEndpoint

• ListEndpoints

See also: AWS API Documentation

Request Syntax

client.create_endpoint(
    OutpostId='string',
    SubnetId='string',
    SecurityGroupId='string'
)

type OutpostId

string

param OutpostId

[REQUIRED]

The ID of the AWS Outpost.

type SubnetId

string

param SubnetId

[REQUIRED]

The ID of the subnet in the selected VPC.

type SecurityGroupId

string

param SecurityGroupId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'EndpointArn': 'string'
}

Response Structure

• (dict) --

  • EndpointArn (string) --

    The Amazon Resource Name (ARN) of the endpoint.

S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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).

This action deletes an endpoint.

Related actions include:

• CreateEndpoint

• ListEndpoints

See also: AWS API Documentation

Request Syntax

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

type EndpointId

string

param EndpointId

[REQUIRED]

The ID of the end point.

type OutpostId

string

param OutpostId

[REQUIRED]

The ID of the AWS Outpost.

returns

None

S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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).

This action lists endpoints associated with the Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

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',
            'CreationTime': datetime(2015, 1, 1),
            'NetworkInterfaces': [
                {
                    'NetworkInterfaceId': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Endpoints (list) --

    Returns an array of endpoints associated with AWS Outpost.

    • (dict) --

      S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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).

      • EndpointArn (string) --

        The Amazon Resource Name (ARN) of the endpoint.

      • OutpostsId (string) --

        The ID of the AWS Outpost.

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

  • NextToken (string) --

    The next endpoint returned in the list.