GetTrafficPolicy
Fetch attributes of a traffic policy resource.
Request Syntax
{
"TrafficPolicyId": "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.
- TrafficPolicyId
-
The identifier of the traffic policy resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
{
"CreatedTimestamp": number,
"DefaultAction": "string",
"LastUpdatedTimestamp": number,
"MaxMessageSizeBytes": number,
"PolicyStatements": [
{
"Action": "string",
"Conditions": [
{ ... }
]
}
],
"TrafficPolicyArn": "string",
"TrafficPolicyId": "string",
"TrafficPolicyName": "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.
- CreatedTimestamp
-
The timestamp of when the traffic policy was created.
Type: Timestamp
- DefaultAction
-
The default action of the traffic policy.
Type: String
Valid Values:
ALLOW | DENY - LastUpdatedTimestamp
-
The timestamp of when the traffic policy was last updated.
Type: Timestamp
- MaxMessageSizeBytes
-
The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.
Type: Integer
Valid Range: Minimum value of 1.
- PolicyStatements
-
The list of conditions which are in the traffic policy resource.
Type: Array of PolicyStatement objects
- TrafficPolicyArn
-
The Amazon Resource Name (ARN) of the traffic policy resource.
Type: String
- TrafficPolicyId
-
The identifier of the traffic policy resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- TrafficPolicyName
-
A user-friendly name for the traffic policy resource.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[A-Za-z0-9_\-]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
Occurs when a requested resource is not found.
HTTP Status Code: 400
- ValidationException
-
The request validation has failed. For details, see the accompanying error message.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
