CreateAggregatorV2
Enables aggregation across AWS Regions. This API is in private preview and subject to change.
Request Syntax
POST /aggregatorv2/create HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique identifier used to ensure idempotency.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[\x21-\x7E]{1,64}$Required: No
- LinkedRegions
-
The list of Regions that are linked to the aggregation Region.
Type: Array of strings
Pattern:
.*\S.*Required: No
- RegionLinkingMode
-
Determines how Regions are linked to an Aggregator V2.
Type: String
Pattern:
.*\S.*Required: Yes
- Tags
-
A list of key-value pairs to be applied to the AggregatorV2.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AggregationRegion": "string",
"AggregatorV2Arn": "string",
"LinkedRegions": [ "string" ],
"RegionLinkingMode": "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.
- AggregationRegion
-
The AWS Region where data is aggregated.
Type: String
Pattern:
.*\S.* - AggregatorV2Arn
-
The ARN of the AggregatorV2.
Type: String
Pattern:
.*\S.* - LinkedRegions
-
The list of Regions that are linked to the aggregation Region.
Type: Array of strings
Pattern:
.*\S.* - RegionLinkingMode
-
Determines how Regions are linked to an Aggregator V2.
Type: String
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action specified in the request.
HTTP Status Code: 403
- ConflictException
-
The request causes conflict with the current state of the service resource.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal failure of the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request has failed validation because it's missing required fields or has invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
