DescribeConformancePacks
Returns a list of one or more conformance packs.
Request Syntax
{
"ConformancePackNames": [ "string
" ],
"Limit": 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.
- ConformancePackNames
-
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, AWS Config returns details for all your conformance packs.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z][-a-zA-Z0-9]*
Required: No
- Limit
-
The maximum number of conformance packs returned on each page.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 20.
Required: No
- NextToken
-
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.Type: String
Required: No
Response Syntax
{
"ConformancePackDetails": [
{
"ConformancePackArn": "string",
"ConformancePackId": "string",
"ConformancePackInputParameters": [
{
"ParameterName": "string",
"ParameterValue": "string"
}
],
"ConformancePackName": "string",
"CreatedBy": "string",
"DeliveryS3Bucket": "string",
"DeliveryS3KeyPrefix": "string",
"LastUpdateRequestedTime": number,
"TemplateSSMDocumentDetails": {
"DocumentName": "string",
"DocumentVersion": "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.
- ConformancePackDetails
-
Returns a list of
ConformancePackDetail
objects.Type: Array of ConformancePackDetail objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
- NextToken
-
The
nextToken
string returned in a previous request that you use to request the next page of results in a paginated response.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidLimitException
-
The specified limit is outside the allowable range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results.HTTP Status Code: 400
- InvalidParameterValueException
-
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- NoSuchConformancePackException
-
You specified one or more conformance packs that do not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: