DescribeConfigurationSets
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
Request Syntax
{
"ConfigurationSetNames": [ "string" ],
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"MaxResults": number,
"NextToken": "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.
- ConfigurationSetNames
-
An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: No
- Filters
-
An array of filters to apply to the results that are returned.
Type: Array of ConfigurationSetFilter objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
- MaxResults
-
The maximum number of results to return per each request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+Required: No
Response Syntax
{
"ConfigurationSets": [
{
"ConfigurationSetArn": "string",
"ConfigurationSetName": "string",
"CreatedTimestamp": number,
"DefaultMessageType": "string",
"DefaultSenderId": "string",
"EventDestinations": [
{
"CloudWatchLogsDestination": {
"IamRoleArn": "string",
"LogGroupArn": "string"
},
"Enabled": boolean,
"EventDestinationName": "string",
"KinesisFirehoseDestination": {
"DeliveryStreamArn": "string",
"IamRoleArn": "string"
},
"MatchingEventTypes": [ "string" ],
"SnsDestination": {
"TopicArn": "string"
}
}
],
"ProtectConfigurationId": "string"
}
],
"NextToken": "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.
- ConfigurationSets
-
An array of ConfigurationSets objects.
Type: Array of ConfigurationSetInformation objects
- NextToken
-
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
