Describes the exclusions that are specified by the exclusions' ARNs.
Request Syntax
{
"exclusionArns": [ "string" ],
"locale": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- exclusionArns
-
The list of ARNs that specify the exclusions that you want to describe.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- locale
-
The locale into which you want to translate the exclusion's title, description, and recommendation.
Type: String
Valid Values:
EN_USRequired: No
Response Syntax
{
"exclusions": {
"string" : {
"arn": "string",
"attributes": [
{
"key": "string",
"value": "string"
}
],
"description": "string",
"recommendation": "string",
"scopes": [
{
"key": "string",
"value": "string"
}
],
"title": "string"
}
},
"failedItems": {
"string" : {
"failureCode": "string",
"retryable": boolean
}
}
}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.
- exclusions
-
Information about the exclusions.
Type: String to Exclusion object map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 300.
- failedItems
-
Exclusion details that cannot be described. An error code is provided for each failed item.
Type: String to FailedItemDetails object map
Key Length Constraints: Minimum length of 1. Maximum length of 300.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidInputException
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
