AWS Config
  1. Root
AWS Config
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your account.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ConformancePackName": "string",
    "TemplateS3Uri": "string",
    "TemplateBody": "string",
    "DeliveryS3Bucket": "string",
    "DeliveryS3KeyPrefix": "string",
    "ConformancePackInputParameters": [],
    "TemplateSSMDocumentDetails": {}
}'
Response Response Example
200 - Example 1
{
  "ConformancePackArn": "string"
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
ConformancePackName
string 
required
The unique name of the conformance pack you want to deploy.
>= 1 characters<= 256 characters
Match pattern:
[a-zA-Z][-a-zA-Z0-9]*
TemplateS3Uri
string 
optional
The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.
>= 1 characters<= 1024 characters
Match pattern:
s3://.*
TemplateBody
string 
optional
A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.
>= 1 characters<= 51200 characters
DeliveryS3Bucket
string 
optional
The name of the Amazon S3 bucket where Config stores conformance pack templates.
>= 0 characters<= 63 characters
DeliveryS3KeyPrefix
string 
optional
The prefix for the Amazon S3 bucket.
>= 0 characters<= 1024 characters
ConformancePackInputParameters
array[object (ConformancePackInputParameter) {2}] 
optional
A list of ConformancePackInputParameter objects.
>= 0 items<= 60 items
ParameterName
string 
required
One part of a key-value pair.
>= 0 characters<= 255 characters
ParameterValue
string 
required
Another part of the key-value pair.
>= 0 characters<= 4096 characters
TemplateSSMDocumentDetails
object 
optional
An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
Examples

Responses

🟢200Success
application/json
Body
ConformancePackArn
string 
optional
ARN of the conformance pack.
>= 1 characters<= 2048 characters
🟠480InsufficientPermissionsException
🟠481ConformancePackTemplateValidationException
🟠482ResourceInUseException
🟠483InvalidParameterValueException
🟠484MaxNumberOfConformancePacksExceededException
Modified at 2023-08-15 05:59:06
Previous
/
Next
/
Built with