Skip to content

Commit 4520d5c

Browse files
author
AWS
committed
AWS Config Update: This release adds ListConformancePackComplianceScores API to support the new compliance score feature, which provides a percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.
1 parent c8de964 commit 4520d5c

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Config",
4+
"contributor": "",
5+
"description": "This release adds ListConformancePackComplianceScores API to support the new compliance score feature, which provides a percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack."
6+
}

services/config/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,11 @@
186186
"output_token": "NextToken",
187187
"result_key": "ResourceIdentifiers"
188188
},
189+
"ListConformancePackComplianceScores": {
190+
"input_token": "NextToken",
191+
"limit_key": "Limit",
192+
"output_token": "NextToken"
193+
},
189194
"ListDiscoveredResources": {
190195
"input_token": "nextToken",
191196
"limit_key": "limit",

services/config/src/main/resources/codegen-resources/service-2.json

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -908,6 +908,21 @@
908908
],
909909
"documentation":"<p>Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.</p> <p>For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type <code>AWS::EC2::Instance</code> then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.</p>"
910910
},
911+
"ListConformancePackComplianceScores":{
912+
"name":"ListConformancePackComplianceScores",
913+
"http":{
914+
"method":"POST",
915+
"requestUri":"/"
916+
},
917+
"input":{"shape":"ListConformancePackComplianceScoresRequest"},
918+
"output":{"shape":"ListConformancePackComplianceScoresResponse"},
919+
"errors":[
920+
{"shape":"InvalidParameterValueException"},
921+
{"shape":"InvalidLimitException"},
922+
{"shape":"InvalidNextTokenException"}
923+
],
924+
"documentation":"<p>Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand compliance deviations in your conformance packs.</p>"
925+
},
911926
"ListDiscoveredResources":{
912927
"name":"ListDiscoveredResources",
913928
"http":{
@@ -1910,6 +1925,7 @@
19101925
"max":100,
19111926
"min":0
19121927
},
1928+
"ComplianceScore":{"type":"string"},
19131929
"ComplianceSummariesByResourceType":{
19141930
"type":"list",
19151931
"member":{"shape":"ComplianceSummaryByResourceType"}
@@ -2451,6 +2467,39 @@
24512467
"max":5,
24522468
"min":0
24532469
},
2470+
"ConformancePackComplianceScore":{
2471+
"type":"structure",
2472+
"members":{
2473+
"Score":{
2474+
"shape":"ComplianceScore",
2475+
"documentation":"<p>Compliance score for the conformance pack.</p>"
2476+
},
2477+
"ConformancePackName":{
2478+
"shape":"ConformancePackName",
2479+
"documentation":"<p>The name of the conformance pack.</p>"
2480+
},
2481+
"LastUpdatedTime":{
2482+
"shape":"LastUpdatedTime",
2483+
"documentation":"<p>The time that the conformance pack compliance score was last updated.</p>"
2484+
}
2485+
},
2486+
"documentation":"<p>A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand compliance deviations in your conformance packs.</p>"
2487+
},
2488+
"ConformancePackComplianceScores":{
2489+
"type":"list",
2490+
"member":{"shape":"ConformancePackComplianceScore"}
2491+
},
2492+
"ConformancePackComplianceScoresFilters":{
2493+
"type":"structure",
2494+
"required":["ConformancePackNames"],
2495+
"members":{
2496+
"ConformancePackNames":{
2497+
"shape":"ConformancePackNameFilter",
2498+
"documentation":"<p>The name of a conformance pack whose score should be included in the compliance score result.</p>"
2499+
}
2500+
},
2501+
"documentation":"<p>A list of filters to apply to the conformance pack compliance score result set.</p>"
2502+
},
24542503
"ConformancePackComplianceSummary":{
24552504
"type":"structure",
24562505
"required":[
@@ -2624,6 +2673,12 @@
26242673
"min":1,
26252674
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
26262675
},
2676+
"ConformancePackNameFilter":{
2677+
"type":"list",
2678+
"member":{"shape":"ConformancePackName"},
2679+
"max":25,
2680+
"min":1
2681+
},
26272682
"ConformancePackNamesList":{
26282683
"type":"list",
26292684
"member":{"shape":"ConformancePackName"},
@@ -4830,6 +4885,7 @@
48304885
"documentation":"<p>You cannot delete the delivery channel you specified because the configuration recorder is running.</p>",
48314886
"exception":true
48324887
},
4888+
"LastUpdatedTime":{"type":"timestamp"},
48334889
"LaterTime":{"type":"timestamp"},
48344890
"Limit":{
48354891
"type":"integer",
@@ -4885,6 +4941,45 @@
48854941
}
48864942
}
48874943
},
4944+
"ListConformancePackComplianceScoresRequest":{
4945+
"type":"structure",
4946+
"members":{
4947+
"Filters":{
4948+
"shape":"ConformancePackComplianceScoresFilters",
4949+
"documentation":"<p>Filters the results based on the <code>ConformancePackComplianceScoresFilters</code>.</p>"
4950+
},
4951+
"SortOrder":{
4952+
"shape":"SortOrder",
4953+
"documentation":"<p>Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.</p>"
4954+
},
4955+
"SortBy":{
4956+
"shape":"SortBy",
4957+
"documentation":"<p>Sorts your conformance pack compliance scores in either ascending or descending order, depending on <code>SortOrder</code>.</p>"
4958+
},
4959+
"Limit":{
4960+
"shape":"PageSizeLimit",
4961+
"documentation":"<p>The maximum number of conformance pack compliance scores returned on each page.</p>"
4962+
},
4963+
"NextToken":{
4964+
"shape":"NextToken",
4965+
"documentation":"<p>The <code>nextToken</code> string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.</p>"
4966+
}
4967+
}
4968+
},
4969+
"ListConformancePackComplianceScoresResponse":{
4970+
"type":"structure",
4971+
"required":["ConformancePackComplianceScores"],
4972+
"members":{
4973+
"NextToken":{
4974+
"shape":"NextToken",
4975+
"documentation":"<p>The <code>nextToken</code> string that you can use to get the next page of results in a paginated response.</p>"
4976+
},
4977+
"ConformancePackComplianceScores":{
4978+
"shape":"ConformancePackComplianceScores",
4979+
"documentation":"<p>A list of <code>ConformancePackComplianceScore</code> objects</p>"
4980+
}
4981+
}
4982+
},
48884983
"ListDiscoveredResourcesRequest":{
48894984
"type":"structure",
48904985
"required":["resourceType"],
@@ -7043,6 +7138,17 @@
70437138
}
70447139
}
70457140
},
7141+
"SortBy":{
7142+
"type":"string",
7143+
"enum":["SCORE"]
7144+
},
7145+
"SortOrder":{
7146+
"type":"string",
7147+
"enum":[
7148+
"ASCENDING",
7149+
"DESCENDING"
7150+
]
7151+
},
70467152
"Source":{
70477153
"type":"structure",
70487154
"required":["Owner"],

0 commit comments

Comments
 (0)