create_endpoint
async
¶
create_endpoint(
outpost_id: OutpostId,
subnet_id: SubnetId,
security_group_id: SecurityGroupId,
*,
config_overrides: Optional[AsyncS3OutpostsClientConfig] = None,
access_type: Optional[EndpointAccessType] = None,
customer_owned_ipv4_pool: Optional[CustomerOwnedIpv4Pool] = None,
) -> CreateEndpointResult
Creates an endpoint and associates it with the specified Outpost.
It can take up to 5 minutes for this action to finish.
Related actions include:
Parameters:
-
outpost_id(OutpostId) –The ID of the Outposts.
-
subnet_id(SubnetId) –The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.
-
security_group_id(SecurityGroupId) –The ID of the security group to use with the endpoint.
-
access_type(Optional[EndpointAccessType], default:None) –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, chooseCustomerOwnedIp. If you chooseCustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).Privateis the default access type value. -
customer_owned_ipv4_pool(Optional[CustomerOwnedIpv4Pool], default:None) –The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.
Raises:
-
AccessDeniedException–Access was denied for this action.
-
ConflictException–There was a conflict with this action, and it could not be completed.
-
InternalServerException–There was an exception with the internal server.
-
OutpostOfflineException–The service link connection to your Outposts home Region is down. Check your connection and try again.
-
ResourceNotFoundException–The requested resource was not found.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–There was an exception validating this data.
-
UnknownServiceError–The service returned an error code this client does not model.