ebook img

AWS Config - API Reference PDF

120 Pages·2017·0.96 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview AWS Config - API Reference

AWS Config API Reference API Version 2014-11-12 AWS Config API Reference AWS Config: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Config API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 6 BatchGetAggregateResourceConfig ............................................................................................... 9 Request Syntax.................................................................................................................. 9 Request Parameters............................................................................................................ 9 Response Syntax................................................................................................................ 9 Response Elements........................................................................................................... 10 Errors.............................................................................................................................. 10 See Also.......................................................................................................................... 11 BatchGetResourceConfig............................................................................................................ 12 Request Syntax................................................................................................................ 12 Request Parameters.......................................................................................................... 12 Response Syntax.............................................................................................................. 12 Response Elements........................................................................................................... 13 Errors.............................................................................................................................. 13 See Also.......................................................................................................................... 14 DeleteAggregationAuthorization................................................................................................. 15 Request Syntax................................................................................................................ 15 Request Parameters.......................................................................................................... 15 Response Elements........................................................................................................... 15 Errors.............................................................................................................................. 15 See Also.......................................................................................................................... 15 DeleteConfigRule...................................................................................................................... 17 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 17 Response Elements........................................................................................................... 17 Errors.............................................................................................................................. 17 See Also.......................................................................................................................... 18 DeleteConfigurationAggregator.................................................................................................. 19 Request Syntax................................................................................................................ 19 Request Parameters.......................................................................................................... 19 Response Elements........................................................................................................... 19 Errors.............................................................................................................................. 19 See Also.......................................................................................................................... 19 DeleteConfigurationRecorder..................................................................................................... 21 Request Syntax................................................................................................................ 21 Request Parameters.......................................................................................................... 21 Response Elements........................................................................................................... 21 Errors.............................................................................................................................. 21 See Also.......................................................................................................................... 21 DeleteConformancePack............................................................................................................ 23 Request Syntax................................................................................................................ 23 Request Parameters.......................................................................................................... 23 Response Elements........................................................................................................... 23 Errors.............................................................................................................................. 23 See Also.......................................................................................................................... 24 DeleteDeliveryChannel.............................................................................................................. 25 Request Syntax................................................................................................................ 25 Request Parameters.......................................................................................................... 25 Response Elements........................................................................................................... 25 Errors.............................................................................................................................. 25 See Also.......................................................................................................................... 25 DeleteEvaluationResults............................................................................................................ 27 Request Syntax................................................................................................................ 27 API Version 2014-11-12 iii AWS Config API Reference Request Parameters.......................................................................................................... 27 Response Elements........................................................................................................... 27 Errors.............................................................................................................................. 27 See Also.......................................................................................................................... 28 DeleteOrganizationConfigRule.................................................................................................... 29 Request Syntax................................................................................................................ 29 Request Parameters.......................................................................................................... 29 Response Elements........................................................................................................... 29 Errors.............................................................................................................................. 29 See Also.......................................................................................................................... 30 DeleteOrganizationConformancePack.......................................................................................... 31 Request Syntax................................................................................................................ 31 Request Parameters.......................................................................................................... 31 Response Elements........................................................................................................... 31 Errors.............................................................................................................................. 31 See Also.......................................................................................................................... 32 DeletePendingAggregationRequest............................................................................................. 34 Request Syntax................................................................................................................ 34 Request Parameters.......................................................................................................... 34 Response Elements........................................................................................................... 34 Errors.............................................................................................................................. 34 See Also.......................................................................................................................... 34 DeleteRemediationConfiguration................................................................................................ 36 Request Syntax................................................................................................................ 36 Request Parameters.......................................................................................................... 36 Response Elements........................................................................................................... 36 Errors.............................................................................................................................. 36 See Also.......................................................................................................................... 37 DeleteRemediationExceptions.................................................................................................... 38 Request Syntax................................................................................................................ 38 Request Parameters.......................................................................................................... 38 Response Syntax.............................................................................................................. 38 Response Elements........................................................................................................... 39 Errors.............................................................................................................................. 39 See Also.......................................................................................................................... 39 DeleteResourceConfig............................................................................................................... 40 Request Syntax................................................................................................................ 40 Request Parameters.......................................................................................................... 40 Response Elements........................................................................................................... 40 Errors.............................................................................................................................. 40 See Also.......................................................................................................................... 41 DeleteRetentionConfiguration.................................................................................................... 42 Request Syntax................................................................................................................ 42 Request Parameters.......................................................................................................... 42 Response Elements........................................................................................................... 42 Errors.............................................................................................................................. 42 See Also.......................................................................................................................... 42 DeleteStoredQuery................................................................................................................... 44 Request Syntax................................................................................................................ 44 Request Parameters.......................................................................................................... 44 Response Elements........................................................................................................... 44 Errors.............................................................................................................................. 44 See Also.......................................................................................................................... 45 DeliverConfigSnapshot.............................................................................................................. 46 Request Syntax................................................................................................................ 46 Request Parameters.......................................................................................................... 46 Response Syntax.............................................................................................................. 46 API Version 2014-11-12 iv AWS Config API Reference Response Elements........................................................................................................... 46 Errors.............................................................................................................................. 47 See Also.......................................................................................................................... 47 DescribeAggregateComplianceByConfigRules............................................................................... 48 Request Syntax................................................................................................................ 48 Request Parameters.......................................................................................................... 48 Response Syntax.............................................................................................................. 49 Response Elements........................................................................................................... 49 Errors.............................................................................................................................. 49 See Also.......................................................................................................................... 50 DescribeAggregateComplianceByConformancePacks...................................................................... 51 Request Syntax................................................................................................................ 51 Request Parameters.......................................................................................................... 51 Response Syntax.............................................................................................................. 52 Response Elements........................................................................................................... 52 Errors.............................................................................................................................. 52 See Also.......................................................................................................................... 53 DescribeAggregationAuthorizations............................................................................................. 54 Request Syntax................................................................................................................ 54 Request Parameters.......................................................................................................... 54 Response Syntax.............................................................................................................. 54 Response Elements........................................................................................................... 54 Errors.............................................................................................................................. 55 See Also.......................................................................................................................... 55 DescribeComplianceByConfigRule............................................................................................... 56 Request Syntax................................................................................................................ 56 Request Parameters.......................................................................................................... 56 Response Syntax.............................................................................................................. 57 Response Elements........................................................................................................... 57 Errors.............................................................................................................................. 57 See Also.......................................................................................................................... 58 DescribeComplianceByResource.................................................................................................. 59 Request Syntax................................................................................................................ 59 Request Parameters.......................................................................................................... 59 Response Syntax.............................................................................................................. 60 Response Elements........................................................................................................... 60 Errors.............................................................................................................................. 61 See Also.......................................................................................................................... 61 DescribeConfigRuleEvaluationStatus........................................................................................... 62 Request Syntax................................................................................................................ 62 Request Parameters.......................................................................................................... 62 Response Syntax.............................................................................................................. 63 Response Elements........................................................................................................... 63 Errors.............................................................................................................................. 63 See Also.......................................................................................................................... 64 DescribeConfigRules................................................................................................................. 65 Request Syntax................................................................................................................ 65 Request Parameters.......................................................................................................... 65 Response Syntax.............................................................................................................. 65 Response Elements........................................................................................................... 66 Errors.............................................................................................................................. 66 See Also.......................................................................................................................... 67 DescribeConfigurationAggregators.............................................................................................. 68 Request Syntax................................................................................................................ 68 Request Parameters.......................................................................................................... 68 Response Syntax.............................................................................................................. 68 Response Elements........................................................................................................... 69 API Version 2014-11-12 v AWS Config API Reference Errors.............................................................................................................................. 69 See Also.......................................................................................................................... 70 DescribeConfigurationAggregatorSourcesStatus............................................................................ 71 Request Syntax................................................................................................................ 71 Request Parameters.......................................................................................................... 71 Response Syntax.............................................................................................................. 72 Response Elements........................................................................................................... 72 Errors.............................................................................................................................. 72 See Also.......................................................................................................................... 73 DescribeConfigurationRecorders................................................................................................. 74 Request Syntax................................................................................................................ 74 Request Parameters.......................................................................................................... 74 Response Syntax.............................................................................................................. 74 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 75 See Also.......................................................................................................................... 75 DescribeConfigurationRecorderStatus.......................................................................................... 76 Request Syntax................................................................................................................ 76 Request Parameters.......................................................................................................... 76 Response Syntax.............................................................................................................. 76 Response Elements........................................................................................................... 76 Errors.............................................................................................................................. 77 See Also.......................................................................................................................... 77 DescribeConformancePackCompliance......................................................................................... 78 Request Syntax................................................................................................................ 78 Request Parameters.......................................................................................................... 78 Response Syntax.............................................................................................................. 79 Response Elements........................................................................................................... 79 Errors.............................................................................................................................. 79 See Also.......................................................................................................................... 80 DescribeConformancePacks........................................................................................................ 81 Request Syntax................................................................................................................ 81 Request Parameters.......................................................................................................... 81 Response Syntax.............................................................................................................. 81 Response Elements........................................................................................................... 82 Errors.............................................................................................................................. 82 See Also.......................................................................................................................... 83 DescribeConformancePackStatus................................................................................................ 84 Request Syntax................................................................................................................ 84 Request Parameters.......................................................................................................... 84 Response Syntax.............................................................................................................. 84 Response Elements........................................................................................................... 85 Errors.............................................................................................................................. 85 See Also.......................................................................................................................... 86 DescribeDeliveryChannels.......................................................................................................... 87 Request Syntax................................................................................................................ 87 Request Parameters.......................................................................................................... 87 Response Syntax.............................................................................................................. 87 Response Elements........................................................................................................... 87 Errors.............................................................................................................................. 88 See Also.......................................................................................................................... 88 DescribeDeliveryChannelStatus................................................................................................... 89 Request Syntax................................................................................................................ 89 Request Parameters.......................................................................................................... 89 Response Syntax.............................................................................................................. 89 Response Elements........................................................................................................... 90 Errors.............................................................................................................................. 90 API Version 2014-11-12 vi AWS Config API Reference See Also.......................................................................................................................... 90 DescribeOrganizationConfigRules............................................................................................... 91 Request Syntax................................................................................................................ 91 Request Parameters.......................................................................................................... 91 Response Syntax.............................................................................................................. 92 Response Elements........................................................................................................... 92 Errors.............................................................................................................................. 93 See Also.......................................................................................................................... 94 DescribeOrganizationConfigRuleStatuses..................................................................................... 95 Request Syntax................................................................................................................ 95 Request Parameters.......................................................................................................... 95 Response Syntax.............................................................................................................. 96 Response Elements........................................................................................................... 96 Errors.............................................................................................................................. 96 See Also.......................................................................................................................... 97 DescribeOrganizationConformancePacks...................................................................................... 98 Request Syntax................................................................................................................ 98 Request Parameters.......................................................................................................... 98 Response Syntax.............................................................................................................. 99 Response Elements........................................................................................................... 99 Errors.............................................................................................................................. 99 See Also........................................................................................................................ 100 DescribeOrganizationConformancePackStatuses......................................................................... 101 Request Syntax.............................................................................................................. 101 Request Parameters........................................................................................................ 101 Response Syntax............................................................................................................ 102 Response Elements......................................................................................................... 102 Errors............................................................................................................................ 102 See Also........................................................................................................................ 103 DescribePendingAggregationRequests....................................................................................... 104 Request Syntax.............................................................................................................. 104 Request Parameters........................................................................................................ 104 Response Syntax............................................................................................................ 104 Response Elements......................................................................................................... 104 Errors............................................................................................................................ 105 See Also........................................................................................................................ 105 DescribeRemediationConfigurations.......................................................................................... 106 Request Syntax.............................................................................................................. 106 Request Parameters........................................................................................................ 106 Response Syntax............................................................................................................ 106 Response Elements......................................................................................................... 107 Errors............................................................................................................................ 107 See Also........................................................................................................................ 107 DescribeRemediationExceptions................................................................................................ 108 Request Syntax.............................................................................................................. 108 Request Parameters........................................................................................................ 108 Response Syntax............................................................................................................ 109 Response Elements......................................................................................................... 109 Errors............................................................................................................................ 109 See Also........................................................................................................................ 110 DescribeRemediationExecutionStatus........................................................................................ 111 Request Syntax.............................................................................................................. 111 Request Parameters........................................................................................................ 111 Response Syntax............................................................................................................ 112 Response Elements......................................................................................................... 112 Errors............................................................................................................................ 112 See Also........................................................................................................................ 113 API Version 2014-11-12 vii AWS Config API Reference DescribeRetentionConfigurations.............................................................................................. 114 Request Syntax.............................................................................................................. 114 Request Parameters........................................................................................................ 114 Response Syntax............................................................................................................ 114 Response Elements......................................................................................................... 115 Errors............................................................................................................................ 115 See Also........................................................................................................................ 115 GetAggregateComplianceDetailsByConfigRule............................................................................ 117 Request Syntax.............................................................................................................. 117 Request Parameters........................................................................................................ 117 Response Syntax............................................................................................................ 118 Response Elements......................................................................................................... 119 Errors............................................................................................................................ 119 See Also........................................................................................................................ 120 GetAggregateConfigRuleComplianceSummary............................................................................ 121 Request Syntax.............................................................................................................. 121 Request Parameters........................................................................................................ 121 Response Syntax............................................................................................................ 122 Response Elements......................................................................................................... 122 Errors............................................................................................................................ 123 See Also........................................................................................................................ 123 GetAggregateConformancePackComplianceSummary.................................................................. 125 Request Syntax.............................................................................................................. 125 Request Parameters........................................................................................................ 125 Response Syntax............................................................................................................ 126 Response Elements......................................................................................................... 126 Errors............................................................................................................................ 127 See Also........................................................................................................................ 127 GetAggregateDiscoveredResourceCounts.................................................................................... 128 Request Syntax.............................................................................................................. 128 Request Parameters........................................................................................................ 128 Response Syntax............................................................................................................ 129 Response Elements......................................................................................................... 129 Errors............................................................................................................................ 130 See Also........................................................................................................................ 130 GetAggregateResourceConfig ................................................................................................... 131 Request Syntax.............................................................................................................. 131 Request Parameters........................................................................................................ 131 Response Syntax............................................................................................................ 131 Response Elements......................................................................................................... 132 Errors............................................................................................................................ 132 See Also........................................................................................................................ 133 GetComplianceDetailsByConfigRule........................................................................................... 134 Request Syntax.............................................................................................................. 134 Request Parameters........................................................................................................ 134 Response Syntax............................................................................................................ 135 Response Elements......................................................................................................... 135 Errors............................................................................................................................ 135 See Also........................................................................................................................ 136 GetComplianceDetailsByResource.............................................................................................. 137 Request Syntax.............................................................................................................. 137 Request Parameters........................................................................................................ 137 Response Syntax............................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 139 See Also........................................................................................................................ 139 GetComplianceSummaryByConfigRule....................................................................................... 140 API Version 2014-11-12 viii AWS Config API Reference Response Syntax............................................................................................................ 140 Response Elements......................................................................................................... 140 Errors............................................................................................................................ 140 See Also........................................................................................................................ 140 GetComplianceSummaryByResourceType................................................................................... 141 Request Syntax.............................................................................................................. 141 Request Parameters........................................................................................................ 141 Response Syntax............................................................................................................ 141 Response Elements......................................................................................................... 142 Errors............................................................................................................................ 142 See Also........................................................................................................................ 142 GetConformancePackComplianceDetails.................................................................................... 143 Request Syntax.............................................................................................................. 143 Request Parameters........................................................................................................ 143 Response Syntax............................................................................................................ 144 Response Elements......................................................................................................... 144 Errors............................................................................................................................ 145 See Also........................................................................................................................ 145 GetConformancePackComplianceSummary................................................................................ 146 Request Syntax.............................................................................................................. 146 Request Parameters........................................................................................................ 146 Response Syntax............................................................................................................ 146 Response Elements......................................................................................................... 147 Errors............................................................................................................................ 147 See Also........................................................................................................................ 147 GetCustomRulePolicy.............................................................................................................. 149 Request Syntax.............................................................................................................. 149 Request Parameters........................................................................................................ 149 Response Syntax............................................................................................................ 149 Response Elements......................................................................................................... 149 Errors............................................................................................................................ 149 See Also........................................................................................................................ 150 GetDiscoveredResourceCounts.................................................................................................. 151 Request Syntax.............................................................................................................. 151 Request Parameters........................................................................................................ 151 Response Syntax............................................................................................................ 152 Response Elements......................................................................................................... 152 Errors............................................................................................................................ 153 See Also........................................................................................................................ 153 GetOrganizationConfigRuleDetailedStatus................................................................................. 155 Request Syntax.............................................................................................................. 155 Request Parameters........................................................................................................ 155 Response Syntax............................................................................................................ 156 Response Elements......................................................................................................... 156 Errors............................................................................................................................ 156 See Also........................................................................................................................ 157 GetOrganizationConformancePackDetailedStatus........................................................................ 158 Request Syntax.............................................................................................................. 158 Request Parameters........................................................................................................ 158 Response Syntax............................................................................................................ 159 Response Elements......................................................................................................... 159 Errors............................................................................................................................ 159 See Also........................................................................................................................ 160 GetOrganizationCustomRulePolicy............................................................................................ 161 Request Syntax.............................................................................................................. 161 Request Parameters........................................................................................................ 161 Response Syntax............................................................................................................ 161 API Version 2014-11-12 ix AWS Config API Reference Response Elements......................................................................................................... 161 Errors............................................................................................................................ 161 See Also........................................................................................................................ 162 GetResourceConfigHistory........................................................................................................ 163 Request Syntax.............................................................................................................. 163 Request Parameters........................................................................................................ 163 Response Syntax............................................................................................................ 165 Response Elements......................................................................................................... 166 Errors............................................................................................................................ 166 See Also........................................................................................................................ 167 GetResourceEvaluationSummary............................................................................................... 168 Request Syntax.............................................................................................................. 168 Request Parameters........................................................................................................ 168 Response Syntax............................................................................................................ 168 Response Elements......................................................................................................... 168 Errors............................................................................................................................ 169 See Also........................................................................................................................ 170 GetStoredQuery..................................................................................................................... 171 Request Syntax.............................................................................................................. 171 Request Parameters........................................................................................................ 171 Response Syntax............................................................................................................ 171 Response Elements......................................................................................................... 171 Errors............................................................................................................................ 172 See Also........................................................................................................................ 172 ListAggregateDiscoveredResources............................................................................................ 173 Request Syntax.............................................................................................................. 173 Request Parameters........................................................................................................ 173 Response Syntax............................................................................................................ 175 Response Elements......................................................................................................... 175 Errors............................................................................................................................ 176 See Also........................................................................................................................ 176 ListConformancePackComplianceScores..................................................................................... 178 Request Syntax.............................................................................................................. 178 Request Parameters........................................................................................................ 178 Response Syntax............................................................................................................ 179 Response Elements......................................................................................................... 179 Errors............................................................................................................................ 180 See Also........................................................................................................................ 180 ListDiscoveredResources.......................................................................................................... 181 Request Syntax.............................................................................................................. 181 Request Parameters........................................................................................................ 181 Response Syntax............................................................................................................ 183 Response Elements......................................................................................................... 184 Errors............................................................................................................................ 184 See Also........................................................................................................................ 184 ListResourceEvaluations........................................................................................................... 186 Request Syntax.............................................................................................................. 186 Request Parameters........................................................................................................ 186 Response Syntax............................................................................................................ 186 Response Elements......................................................................................................... 187 Errors............................................................................................................................ 187 See Also........................................................................................................................ 187 ListStoredQueries................................................................................................................... 189 Request Syntax.............................................................................................................. 189 Request Parameters........................................................................................................ 189 Response Syntax............................................................................................................ 189 Response Elements......................................................................................................... 189 API Version 2014-11-12 x

Description:
AWS Config: API Reference. Copyright © 2017 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.