GetRuleSet
Fetch attributes of a rule set.
Request Syntax
{
"RuleSetId": "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.
- RuleSetId
-
The identifier of an existing rule set to be retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
{
"CreatedDate": number,
"LastModificationDate": number,
"Rules": [
{
"Actions": [
{ ... }
],
"Conditions": [
{ ... }
],
"Name": "string",
"Unless": [
{ ... }
]
}
],
"RuleSetArn": "string",
"RuleSetId": "string",
"RuleSetName": "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.
- CreatedDate
-
The date of when then rule set was created.
Type: Timestamp
- LastModificationDate
-
The date of when the rule set was last modified.
Type: Timestamp
- Rules
-
The rules contained in the rule set.
Type: Array of Rule objects
Array Members: Minimum number of 0 items. Maximum number of 40 items.
- RuleSetArn
-
The Amazon Resource Name (ARN) of the rule set resource.
Type: String
- RuleSetId
-
The identifier of the rule set resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- RuleSetName
-
A user-friendly name for the rule set resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
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:
