CreateEndpoint
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 Using Amazon S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
This action creates an endpoint and associates it with the specified Outposts.
It can take up to 20 minutes for this action to complete.
Related actions include:
Request Syntax
POST /S3Outposts/CreateEndpoint HTTP/1.1
Content-type: application/json
{
"OutpostId": "string
",
"SecurityGroupId": "string
",
"SubnetId": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- OutpostId
-
The ID of the AWS Outposts.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(op-[a-f0-9]{17}|\d{12}|ec2)$
Required: Yes
- SecurityGroupId
-
The ID of the security group to use with the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^sg-([0-9a-f]{8}|[0-9a-f]{17})$
Required: Yes
- SubnetId
-
The ID of the subnet in the selected VPC.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^subnet-([0-9a-f]{8}|[0-9a-f]{17})$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EndpointArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EndpointArn
-
The Amazon Resource Name (ARN) of the endpoint.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 500.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]*:[0-9]{12}:outpost/(op-[a-f0-9]{17}|ec2)/endpoint/[a-zA-Z0-9]{19}$
Errors
- AccessDeniedException
-
Access was denied for this action.
HTTP Status Code: 403
- ConflictException
-
There was a conflict with this action, and it could not be completed.
HTTP Status Code: 409
- InternalServerException
-
There was an exception with the internal server.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource was not found.
HTTP Status Code: 404
- ValidationException
-
There was an exception validating this data.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: