2026/11/17 - AWS Config - 3 updated api methods
Changes Adds support for AWS Config managed conformance packs, with new Source and Scope parameters on PutConformancePack, a new Type field and type Filters on DescribeConformancePacks and DescribeConformancePackStatus, and an optional StackArn in DescribeConformancePackStatus.
{'Filters': {'Types': ['CUSTOM | MANAGED']}}
Response {'ConformancePackStatusDetails': {'ConformancePackState': {'UPDATE_COMPLETE',
'UPDATE_FAILED',
'UPDATE_IN_PROGRESS'},
'Type': 'CUSTOM | MANAGED'}}
Provides one or more conformance packs deployment status.
See also: AWS API Documentation
Request Syntax
client.describe_conformance_pack_status(
ConformancePackNames=[
'string',
],
Filters={
'Types': [
'CUSTOM'|'MANAGED',
]
},
Limit=123,
NextToken='string'
)
list
Comma-separated list of conformance pack names.
(string) --
dict
Returns a filtered list of custom or managed conformance pack statuses. By default, if the filter is not defined, Config returns details for all your conformance packs.
Types (list) --
Filters results by conformance pack type. Valid values:
CUSTOM – A custom conformance pack.
MANAGED – A managed conformance pack.
If you specify both values, Config returns conformance packs of either type.
(string) --
integer
The maximum number of conformance packs status returned on each page.
string
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
dict
Response Syntax
{
'ConformancePackStatusDetails': [
{
'ConformancePackName': 'string',
'ConformancePackId': 'string',
'ConformancePackArn': 'string',
'ConformancePackState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'StackArn': 'string',
'ConformancePackStatusReason': 'string',
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'LastUpdateCompletedTime': datetime(2015, 1, 1),
'Type': 'CUSTOM'|'MANAGED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackStatusDetails (list) --
A list of ConformancePackStatusDetail objects.
(dict) --
Status details of a conformance pack.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of comformance pack.
ConformancePackState (string) --
Indicates deployment status of conformance pack.
Config sets the state of the conformance pack to:
CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.
CREATE_COMPLETE when a conformance pack has been successfully created in your account.
CREATE_FAILED when a conformance pack creation failed in your account.
UPDATE_IN_PROGRESS when a conformance pack update is in progress for an account.
UPDATE_COMPLETE when a conformance pack has been successfully updated in your account.
UPDATE_FAILED when a conformance pack update failed in your account.
DELETE_IN_PROGRESS when a conformance pack deletion is in progress.
DELETE_FAILED when a conformance pack deletion failed in your account.
StackArn (string) --
Amazon Resource Name (ARN) of CloudFormation stack.
ConformancePackStatusReason (string) --
The reason of conformance pack creation failure.
LastUpdateRequestedTime (datetime) --
Last time when conformation pack creation and update was requested.
LastUpdateCompletedTime (datetime) --
Last time when conformation pack creation and update was successful.
Type (string) --
The type of the conformance pack. Valid values:
CUSTOM – A custom conformance pack.
MANAGED – A managed conformance pack.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
{'Filters': {'Types': ['CUSTOM | MANAGED']}}
Response {'ConformancePackDetails': {'Scope': {'TagKey': 'string', 'TagValue': 'string'},
'Source': {'SourceIdentifier': 'string'},
'Type': 'CUSTOM | MANAGED'}}
Returns a list of one or more conformance packs.
See also: AWS API Documentation
Request Syntax
client.describe_conformance_packs(
ConformancePackNames=[
'string',
],
Filters={
'Types': [
'CUSTOM'|'MANAGED',
]
},
Limit=123,
NextToken='string'
)
list
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.
(string) --
dict
Returns a filtered list of custom or managed conformance packs. By default, if the filter is not defined, Config returns details for all your conformance packs.
Types (list) --
Filters results by conformance pack type. Valid values:
CUSTOM – A custom conformance pack.
MANAGED – A managed conformance pack.
If you specify both values, Config returns conformance packs of either type.
(string) --
integer
The maximum number of conformance packs returned on each page.
string
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
dict
Response Syntax
{
'ConformancePackDetails': [
{
'ConformancePackName': 'string',
'ConformancePackArn': 'string',
'ConformancePackId': 'string',
'DeliveryS3Bucket': 'string',
'DeliveryS3KeyPrefix': 'string',
'ConformancePackInputParameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'TemplateSSMDocumentDetails': {
'DocumentName': 'string',
'DocumentVersion': 'string'
},
'Type': 'CUSTOM'|'MANAGED',
'Source': {
'SourceIdentifier': 'string'
},
'Scope': {
'TagKey': 'string',
'TagValue': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackDetails (list) --
Returns a list of ConformancePackDetail objects.
(dict) --
Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
DeliveryS3Bucket (string) --
The name of the Amazon S3 bucket where Config stores conformance pack templates.
DeliveryS3KeyPrefix (string) --
The prefix for the Amazon S3 bucket.
ConformancePackInputParameters (list) --
A list of ConformancePackInputParameter objects.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. For managed conformance packs, keys can have a maximum character length of 255 characters, and values can have a maximum length of 1024 characters. For custom conformance packs, keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) --
One part of a key-value pair.
ParameterValue (string) --
Another part of the key-value pair.
LastUpdateRequestedTime (datetime) --
The last time a conformation pack update was requested.
CreatedBy (string) --
The Amazon Web Services service that created the conformance pack.
TemplateSSMDocumentDetails (dict) --
An object that contains the name or 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.
DocumentName (string) --
The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document.
DocumentVersion (string) --
The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.
Type (string) --
The type of the conformance pack. Valid values:
CUSTOM – A custom conformance pack.
MANAGED – A managed conformance pack.
Source (dict) --
Contains the identifier of the managed conformance pack that Config deploys in your account.
SourceIdentifier (string) --
A predefined identifier for a managed conformance pack. The identifier specifies which managed conformance pack Config deploys in your account.
Scope (dict) --
An object of type ConformancePackScope, which contains the tag key and optional tag value that defines which resources trigger an evaluation for the Config rules in the managed conformance pack.
TagKey (string) --
The tag key that applies to only those Amazon Web Services resources that you want to trigger an evaluation for the rules in the conformance pack. Defines the Scope$TagKey of all Config rules in the conformance pack.
TagValue (string) --
The tag value that applies to only those Amazon Web Services resources that you want to trigger an evaluation for the rules in the conformance pack. If you do not specify a value for TagValue, resources that have the tag key TagKey trigger an evaluation, regardless of the tag value. Defines the Scope$TagValue of all Config rules in the conformance pack.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
{'Scope': {'TagKey': 'string', 'TagValue': 'string'},
'Source': {'SourceIdentifier': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.put_conformance_pack(
ConformancePackName='string',
TemplateS3Uri='string',
TemplateBody='string',
DeliveryS3Bucket='string',
DeliveryS3KeyPrefix='string',
ConformancePackInputParameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
TemplateSSMDocumentDetails={
'DocumentName': 'string',
'DocumentVersion': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Source={
'SourceIdentifier': 'string'
},
Scope={
'TagKey': 'string',
'TagValue': 'string'
}
)
string
[REQUIRED]
The unique name of the conformance pack you want to deploy.
string
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.
string
A string that contains 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.
string
The name of the Amazon S3 bucket where Config stores conformance pack templates.
string
The prefix for the Amazon S3 bucket.
list
A list of ConformancePackInputParameter objects. Custom conformance packs can have at most 60 input parameters. Managed conformance packs can have at most 330 input parameters.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. For managed conformance packs, keys can have a maximum character length of 255 characters, and values can have a maximum length of 1024 characters. For custom conformance packs, keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) -- [REQUIRED]
One part of a key-value pair.
ParameterValue (string) -- [REQUIRED]
Another part of the key-value pair.
dict
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.
DocumentName (string) -- [REQUIRED]
The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document.
DocumentVersion (string) --
The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.
list
The tags for the conformance pack. Each tag consists of a key and an optional value, both of which you define.
(dict) --
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
An object of type ConformancePackSource, which contains the identifier of the managed conformance pack that you want to deploy. If you specify a source, Config creates a managed conformance pack. Managed conformance packs are predefined collections of Config rules that are created and maintained by Amazon Web Services.
SourceIdentifier (string) -- [REQUIRED]
A predefined identifier for a managed conformance pack. The identifier specifies which managed conformance pack Config deploys in your account.
dict
An object of type ConformancePackScope that defines which resources can trigger an evaluation for Config rules in the conformance pack. The scope can include a tag key and optional tag value. Specify a scope to constrain the resources that can trigger an evaluation for rules in the conformance pack. If you do not specify a scope, all rules in the conformance pack are unscoped.
TagKey (string) -- [REQUIRED]
The tag key that applies to only those Amazon Web Services resources that you want to trigger an evaluation for the rules in the conformance pack. Defines the Scope$TagKey of all Config rules in the conformance pack.
TagValue (string) --
The tag value that applies to only those Amazon Web Services resources that you want to trigger an evaluation for the rules in the conformance pack. If you do not specify a value for TagValue, resources that have the tag key TagKey trigger an evaluation, regardless of the tag value. Defines the Scope$TagValue of all Config rules in the conformance pack.
dict
Response Syntax
{
'ConformancePackArn': 'string'
}
Response Structure
(dict) --
ConformancePackArn (string) --
ARN of the conformance pack.