CreateMultiRegionEndpoint
Creates a multi-region endpoint (global-endpoint).
The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.
Request Syntax
POST /v2/email/multi-region-endpoints HTTP/1.1
Content-type: application/json
{
"Details": {
"RoutesDetails": [
{
"Region": "string"
}
]
},
"EndpointName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Details
-
Contains details of a multi-region endpoint (global-endpoint) being created.
Type: Details object
Required: Yes
- EndpointName
-
The name of the multi-region endpoint (global-endpoint).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w\-_]+$Required: Yes
- Tags
-
An array of objects that define the tags (keys and values) to associate with the multi-region endpoint (global-endpoint).
Type: Array of Tag objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EndpointId": "string",
"Status": "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.
- EndpointId
-
The ID of the multi-region endpoint (global-endpoint).
Type: String
- Status
-
A status of the multi-region endpoint (global-endpoint) right after the create request.
-
CREATING– The resource is being provisioned. -
READY– The resource is ready to use. -
FAILED– The resource failed to be provisioned. -
DELETING– The resource is being deleted as requested.
Type: String
Valid Values:
CREATING | READY | FAILED | DELETING -
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
The resource specified in your request already exists.
HTTP Status Code: 400
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- LimitExceededException
-
There are too many instances of the specified resource type.
HTTP Status Code: 400
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
