S3Outposts / Client / create_endpoint

create_endpoint#

S3Outposts.Client.create_endpoint(**kwargs)#

Creates an endpoint and associates it with the specified Outpost.

Note

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

Related actions include:

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

  • SubnetId (string) –

    [REQUIRED]

    The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has 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 network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private . To use the endpoint with an on-premises network, choose CustomerOwnedIp . If you choose CustomerOwnedIp , you must also provide the customer-owned IP address pool (CoIP pool).

    Note

    Private is the default access type value.

  • CustomerOwnedIpv4Pool (string) – The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are 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

  • S3Outposts.Client.exceptions.ThrottlingException

  • S3Outposts.Client.exceptions.OutpostOfflineException