ConfigService
Service object for interacting with AWS ConfigService service.
public struct ConfigService: AWSService
Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources.
You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the ConfigService client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: ConfigService, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
batchGetAggregateResourceConfig(_:logger:on:)
public func batchGetAggregateResourceConfig(_ input: BatchGetAggregateResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchGetAggregateResourceConfigResponse>
Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request.
If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers
list.
<note>
<ul>
<li>
<p>The API does not return results for deleted resources.</p>
</li>
<li>
<p> The API does not return tags and relationships.</p>
</li>
</ul>
</note>
batchGetResourceConfig(_:logger:on:)
public func batchGetResourceConfig(_ input: BatchGetResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchGetResourceConfigResponse>
Returns the BaseConfigurationItem
for one or more requested resources.
The operation also returns a list of resources that are
not processed in the current request. If there are no unprocessed
resources, the operation returns an empty unprocessedResourceKeys
list.
-
The API does not return results for deleted resources.
-
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
deleteAggregationAuthorization(_:logger:on:)
@discardableResult public func deleteAggregationAuthorization(_ input: DeleteAggregationAuthorizationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
deleteConfigRule(_:logger:on:)
@discardableResult public func deleteConfigRule(_ input: DeleteConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the specified Config rule and all of its evaluation results.
Config sets the state of a rule to DELETING
until the deletion is complete. You cannot update a rule while it is
in this state. If you make a PutConfigRule
or
DeleteConfigRule
request for the rule, you will
receive a ResourceInUseException
.
You can check the state of a rule by using the
DescribeConfigRules
request.
deleteConfigurationAggregator(_:logger:on:)
@discardableResult public func deleteConfigurationAggregator(_ input: DeleteConfigurationAggregatorRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
deleteConfigurationRecorder(_:logger:on:)
@discardableResult public func deleteConfigurationRecorder(_ input: DeleteConfigurationRecorderRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that
was previously recorded. You will be able to access the previously
recorded information by using the
GetResourceConfigHistory
action, but you will not
be able to access this information in the Config console until
you create a new configuration recorder.
deleteConformancePack(_:logger:on:)
@discardableResult public func deleteConformancePack(_ input: DeleteConformancePackRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to DELETE_IN_PROGRESS
until the deletion is complete.
You cannot update a conformance pack while it is in this state.
deleteDeliveryChannel(_:logger:on:)
@discardableResult public func deleteDeliveryChannel(_ input: DeleteDeliveryChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
deleteEvaluationResults(_:logger:on:)
public func deleteEvaluationResults(_ input: DeleteEvaluationResultsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteEvaluationResultsResponse>
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
deleteOrganizationConfigRule(_:logger:on:)
@discardableResult public func deleteOrganizationConfigRule(_ input: DeleteOrganizationConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a master account and a delegated administrator account can delete an organization Config rule.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.
Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
deleteOrganizationConformancePack(_:logger:on:)
@discardableResult public func deleteOrganizationConformancePack(_ input: DeleteOrganizationConformancePackRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a master account or a delegated administrator account can delete an organization conformance pack.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.
Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
deletePendingAggregationRequest(_:logger:on:)
@discardableResult public func deletePendingAggregationRequest(_ input: DeletePendingAggregationRequestRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes pending authorization requests for a specified aggregator account in a specified region.
deleteRemediationConfiguration(_:logger:on:)
public func deleteRemediationConfiguration(_ input: DeleteRemediationConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteRemediationConfigurationResponse>
Deletes the remediation configuration.
deleteRemediationExceptions(_:logger:on:)
public func deleteRemediationExceptions(_ input: DeleteRemediationExceptionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteRemediationExceptionsResponse>
Deletes one or more remediation exceptions mentioned in the resource keys.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
deleteResourceConfig(_:logger:on:)
@discardableResult public func deleteResourceConfig(_ input: DeleteResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
deleteRetentionConfiguration(_:logger:on:)
@discardableResult public func deleteRetentionConfiguration(_ input: DeleteRetentionConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes the retention configuration.
deleteStoredQuery(_:logger:on:)
public func deleteStoredQuery(_ input: DeleteStoredQueryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteStoredQueryResponse>
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
deliverConfigSnapshot(_:logger:on:)
public func deliverConfigSnapshot(_ input: DeliverConfigSnapshotRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeliverConfigSnapshotResponse>
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
-
Notification of the start of the delivery.
-
Notification of the completion of the delivery, if the delivery was successfully completed.
-
Notification of delivery failure, if the delivery failed.
describeAggregateComplianceByConfigRules(_:logger:on:)
public func describeAggregateComplianceByConfigRules(_ input: DescribeAggregateComplianceByConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeAggregateComplianceByConfigRulesResponse>
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you
have a nextToken
, the results are displayed on the next
page.
describeAggregateComplianceByConformancePacks(_:logger:on:)
public func describeAggregateComplianceByConformancePacks(_ input: DescribeAggregateComplianceByConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeAggregateComplianceByConformancePacksResponse>
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a nextToken
, the results are displayed on the next page.
describeAggregationAuthorizations(_:logger:on:)
public func describeAggregationAuthorizations(_ input: DescribeAggregationAuthorizationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeAggregationAuthorizationsResponse>
Returns a list of authorizations granted to various aggregator accounts and regions.
describeComplianceByConfigRule(_:logger:on:)
public func describeComplianceByConfigRule(_ input: DescribeComplianceByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeComplianceByConfigRuleResponse>
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule,
it returns INSUFFICIENT_DATA
. This result might
indicate one of the following conditions:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
describeComplianceByResource(_:logger:on:)
public func describeComplianceByResource(_ input: DescribeComplianceByResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeComplianceByResourceResponse>
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the
resource, it returns INSUFFICIENT_DATA
. This result
might indicate one of the following conditions about the rules that
evaluate the resource:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
describeConfigRuleEvaluationStatus(_:logger:on:)
public func describeConfigRuleEvaluationStatus(_ input: DescribeConfigRuleEvaluationStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigRuleEvaluationStatusResponse>
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
describeConfigRules(_:logger:on:)
public func describeConfigRules(_ input: DescribeConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigRulesResponse>
Returns details about your Config rules.
describeConfigurationAggregatorSourcesStatus(_:logger:on:)
public func describeConfigurationAggregatorSourcesStatus(_ input: DescribeConfigurationAggregatorSourcesStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigurationAggregatorSourcesStatusResponse>
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
describeConfigurationAggregators(_:logger:on:)
public func describeConfigurationAggregators(_ input: DescribeConfigurationAggregatorsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigurationAggregatorsResponse>
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
describeConfigurationRecorderStatus(_:logger:on:)
public func describeConfigurationRecorderStatus(_ input: DescribeConfigurationRecorderStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigurationRecorderStatusResponse>
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecorders(_:logger:on:)
public func describeConfigurationRecorders(_ input: DescribeConfigurationRecordersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConfigurationRecordersResponse>
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
describeConformancePackCompliance(_:logger:on:)
public func describeConformancePackCompliance(_ input: DescribeConformancePackComplianceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConformancePackComplianceResponse>
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
describeConformancePackStatus(_:logger:on:)
public func describeConformancePackStatus(_ input: DescribeConformancePackStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConformancePackStatusResponse>
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
describeConformancePacks(_:logger:on:)
public func describeConformancePacks(_ input: DescribeConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeConformancePacksResponse>
Returns a list of one or more conformance packs.
describeDeliveryChannelStatus(_:logger:on:)
public func describeDeliveryChannelStatus(_ input: DescribeDeliveryChannelStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDeliveryChannelStatusResponse>
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
describeDeliveryChannels(_:logger:on:)
public func describeDeliveryChannels(_ input: DescribeDeliveryChannelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeDeliveryChannelsResponse>
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
describeOrganizationConfigRuleStatuses(_:logger:on:)
public func describeOrganizationConfigRuleStatuses(_ input: DescribeOrganizationConfigRuleStatusesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeOrganizationConfigRuleStatusesResponse>
Provides organization Config rule deployment status for an organization.
<note>
<p>The status is not considered successful until organization Config rule is successfully deployed in all the member
accounts with an exception of excluded accounts.</p>
<p>When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names.
It is only applicable, when you request all the organization Config rules.</p>
</note>
describeOrganizationConfigRules(_:logger:on:)
public func describeOrganizationConfigRules(_ input: DescribeOrganizationConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeOrganizationConfigRulesResponse>
Returns a list of organization Config rules.
<note>
<p>When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names.
It is only applicable, when you request all the organization Config rules.</p>
</note>
describeOrganizationConformancePackStatuses(_:logger:on:)
public func describeOrganizationConformancePackStatuses(_ input: DescribeOrganizationConformancePackStatusesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeOrganizationConformancePackStatusesResponse>
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
describeOrganizationConformancePacks(_:logger:on:)
public func describeOrganizationConformancePacks(_ input: DescribeOrganizationConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeOrganizationConformancePacksResponse>
Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
describePendingAggregationRequests(_:logger:on:)
public func describePendingAggregationRequests(_ input: DescribePendingAggregationRequestsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribePendingAggregationRequestsResponse>
Returns a list of all pending aggregation requests.
describeRemediationConfigurations(_:logger:on:)
public func describeRemediationConfigurations(_ input: DescribeRemediationConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRemediationConfigurationsResponse>
Returns the details of one or more remediation configurations.
describeRemediationExceptions(_:logger:on:)
public func describeRemediationExceptions(_ input: DescribeRemediationExceptionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRemediationExceptionsResponse>
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
describeRemediationExecutionStatus(_:logger:on:)
public func describeRemediationExecutionStatus(_ input: DescribeRemediationExecutionStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRemediationExecutionStatusResponse>
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
describeRetentionConfigurations(_:logger:on:)
public func describeRetentionConfigurations(_ input: DescribeRetentionConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRetentionConfigurationsResponse>
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
getAggregateComplianceDetailsByConfigRule(_:logger:on:)
public func getAggregateComplianceDetailsByConfigRule(_ input: GetAggregateComplianceDetailsByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAggregateComplianceDetailsByConfigRuleResponse>
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you
have a nextToken
, the results are displayed on the next
page.
getAggregateConfigRuleComplianceSummary(_:logger:on:)
public func getAggregateConfigRuleComplianceSummary(_ input: GetAggregateConfigRuleComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAggregateConfigRuleComplianceSummaryResponse>
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConformancePackComplianceSummary(_:logger:on:)
public func getAggregateConformancePackComplianceSummary(_ input: GetAggregateConformancePackComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAggregateConformancePackComplianceSummaryResponse>
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateDiscoveredResourceCounts(_:logger:on:)
public func getAggregateDiscoveredResourceCounts(_ input: GetAggregateDiscoveredResourceCountsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAggregateDiscoveredResourceCountsResponse>
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
getAggregateResourceConfig(_:logger:on:)
public func getAggregateResourceConfig(_ input: GetAggregateResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetAggregateResourceConfigResponse>
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
getComplianceDetailsByConfigRule(_:logger:on:)
public func getComplianceDetailsByConfigRule(_ input: GetComplianceDetailsByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetComplianceDetailsByConfigRuleResponse>
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
getComplianceDetailsByResource(_:logger:on:)
public func getComplianceDetailsByResource(_ input: GetComplianceDetailsByResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetComplianceDetailsByResourceResponse>
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
getComplianceSummaryByConfigRule(logger:on:)
public func getComplianceSummaryByConfigRule(logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetComplianceSummaryByConfigRuleResponse>
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByResourceType(_:logger:on:)
public func getComplianceSummaryByResourceType(_ input: GetComplianceSummaryByResourceTypeRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetComplianceSummaryByResourceTypeResponse>
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
getConformancePackComplianceDetails(_:logger:on:)
public func getConformancePackComplianceDetails(_ input: GetConformancePackComplianceDetailsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetConformancePackComplianceDetailsResponse>
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
getConformancePackComplianceSummary(_:logger:on:)
public func getConformancePackComplianceSummary(_ input: GetConformancePackComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetConformancePackComplianceSummaryResponse>
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
getCustomRulePolicy(_:logger:on:)
public func getCustomRulePolicy(_ input: GetCustomRulePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCustomRulePolicyResponse>
Returns the policy definition containing the logic for your Config Custom Policy rule.
getDiscoveredResourceCounts(_:logger:on:)
public func getDiscoveredResourceCounts(_ input: GetDiscoveredResourceCountsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDiscoveredResourceCountsResponse>
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify that you want all resource types. -
Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, Config lists 100
ResourceCount objects on each page. You can
customize this number with the limit
parameter. The
response includes a nextToken
string. To get the next
page of results, run the request again and specify the string for
the nextToken
parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
-
You are a new Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
getOrganizationConfigRuleDetailedStatus(_:logger:on:)
public func getOrganizationConfigRuleDetailedStatus(_ input: GetOrganizationConfigRuleDetailedStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetOrganizationConfigRuleDetailedStatusResponse>
Returns detailed status for each member account within an organization for a given organization Config rule.
getOrganizationConformancePackDetailedStatus(_:logger:on:)
public func getOrganizationConformancePackDetailedStatus(_ input: GetOrganizationConformancePackDetailedStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetOrganizationConformancePackDetailedStatusResponse>
Returns detailed status for each member account within an organization for a given organization conformance pack.
getOrganizationCustomRulePolicy(_:logger:on:)
public func getOrganizationCustomRulePolicy(_ input: GetOrganizationCustomRulePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetOrganizationCustomRulePolicyResponse>
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
getResourceConfigHistory(_:logger:on:)
public func getResourceConfigHistory(_ input: GetResourceConfigHistoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetResourceConfigHistoryResponse>
Returns a list of ConfigurationItems
for the specified resource.
The list contains details about each state of the resource
during the specified time interval. If you specified a retention
period to retain your ConfigurationItems
between a
minimum of 30 days and a maximum of 7 years (2557 days), Config
returns the ConfigurationItems
for the specified
retention period.
The response is paginated. By default, Config returns a
limit of 10 configuration items per page. You can customize this
number with the limit
parameter. The response includes
a nextToken
string. To get the next page of results,
run the request again and specify the string for the
nextToken
parameter.
Each call to the API is limited to span a duration of seven
days. It is likely that the number of records returned is
smaller than the specified limit
. In such cases,
you can make another call, using the
nextToken
.
getStoredQuery(_:logger:on:)
public func getStoredQuery(_ input: GetStoredQueryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetStoredQueryResponse>
Returns the details of a specific stored query.
listAggregateDiscoveredResources(_:logger:on:)
public func listAggregateDiscoveredResources(_ input: ListAggregateDiscoveredResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListAggregateDiscoveredResourcesResponse>
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.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
listDiscoveredResources(_:logger:on:)
public func listDiscoveredResources(_ input: ListDiscoveredResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDiscoveredResourcesResponse>
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, Config lists 100
resource identifiers on each page. You can customize this number
with the limit
parameter. The response includes a
nextToken
string. To get the next page of results,
run the request again and specify the string for the
nextToken
parameter.
listStoredQueries(_:logger:on:)
public func listStoredQueries(_ input: ListStoredQueriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListStoredQueriesResponse>
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
List the tags for Config resource.
putAggregationAuthorization(_:logger:on:)
public func putAggregationAuthorization(_ input: PutAggregationAuthorizationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutAggregationAuthorizationResponse>
Authorizes the aggregator account and region to collect data from the source account and region.
putConfigRule(_:logger:on:)
@discardableResult public func putConfigRule(_ input: PutConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.
You can use this action for Config custom rules and Config managed rules. A Config custom rule is a rule that you develop and maintain. An Config managed rule is a customizable, predefined rule that Config provides.
If you are adding a new Config custom rule, you must first
create the Lambda function that the rule invokes to evaluate
your resources. When you use the PutConfigRule
action
to add the rule to Config, you must specify the Amazon Resource
Name (ARN) that Lambda assigns to the function. Specify the ARN
for the SourceIdentifier
key. This key is part of the
Source
object, which is part of the
ConfigRule
object.
If you are adding an Config managed rule, specify the
rule's identifier for the SourceIdentifier
key. To
reference Config managed rule identifiers, see About Config managed rules.
For any new rule that you add, specify the
ConfigRuleName
in the ConfigRule
object. Do not specify the ConfigRuleArn
or the
ConfigRuleId
. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can
specify the rule by ConfigRuleName
,
ConfigRuleId
, or ConfigRuleArn
in the
ConfigRule
data type that you use in this
request.
The maximum number of rules that Config supports is 150.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide.
putConfigurationAggregator(_:logger:on:)
public func putConfigurationAggregator(_ input: PutConfigurationAggregatorRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutConfigurationAggregatorResponse>
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
<p>
<code>accountIds</code> that are passed will be replaced with existing accounts.
If you want to add additional accounts into the aggregator, call <code>DescribeConfigurationAggregators</code> to get the previous accounts and then append new ones.</p>
<note>
<p>Config should be enabled in source accounts and regions
you want to aggregate.</p>
<p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization.
If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations.
If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p>
<p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the Config developer guide. </p>
</note>
putConfigurationRecorder(_:logger:on:)
@discardableResult public func putConfigurationRecorder(_ input: PutConfigurationRecorderRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
or the recordingGroup
of an existing recorder. To
change the role, call the action on the existing configuration
recorder and specify a role.
Currently, you can specify only one configuration recorder per region in your account.
If ConfigurationRecorder
does not have the
recordingGroup parameter
specified, the default is to record all supported resource
types.
putConformancePack(_:logger:on:)
public func putConformancePack(_ input: PutConformancePackRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutConformancePackResponse>
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 Amazon Web Services Organization.
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.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both.
If you provide both Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
putDeliveryChannel(_:logger:on:)
@discardableResult public func putDeliveryChannel(_ input: PutDeliveryChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
</note>
putEvaluations(_:logger:on:)
public func putEvaluations(_ input: PutEvaluationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutEvaluationsResponse>
Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
putExternalEvaluation(_:logger:on:)
public func putExternalEvaluation(_ input: PutExternalEvaluationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutExternalEvaluationResponse>
Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
putOrganizationConfigRule(_:logger:on:)
public func putOrganizationConfigRule(_ input: PutOrganizationConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutOrganizationConfigRuleResponse>
Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.
Only a master account and a delegated administrator can create or update an organization Config rule.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.
This API enables organization service access through the EnableAWSServiceAccess
action and creates a service linked
role AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated administrator account of your organization.
The service linked role is created only when the role does not exist in the caller account.
Config verifies the existence of role with GetRole
action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
register-delegated-administrator
for config-multiaccountsetup.amazonaws.com
.
You can use this action to create both Config custom rules and Config managed rules.
If you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated
administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function.
When you use the PutOrganizationConfigRule
action to add the rule to Config, you must
specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
If you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier
key.
The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
Specify either OrganizationCustomRuleMetadata
or OrganizationManagedRuleMetadata
.
putOrganizationConformancePack(_:logger:on:)
public func putOrganizationConformancePack(_ input: PutOrganizationConformancePackRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutOrganizationConformancePackResponse>
Deploys conformance packs across member accounts in an Amazon Web Services Organization.
Only a master account and a delegated administrator can call this API.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a
service linked role AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated administrator account of your organization.
The service linked role is created only when the role does not exist in the caller account.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
<note>
<p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
<p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
<p>Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated.
You cannot update a conformance pack while it is in this state.</p>
<p>You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization. </p>
</note>
putRemediationConfigurations(_:logger:on:)
public func putRemediationConfigurations(_ input: PutRemediationConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutRemediationConfigurationsResponse>
Adds or updates the remediation configuration with a specific Config rule with the
selected target or action.
The API creates the RemediationConfiguration
object for the Config rule.
The Config rule must already exist for you to add a remediation configuration.
The target (SSM document) must exist and have permissions to use the target.
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
putRemediationExceptions(_:logger:on:)
public func putRemediationExceptions(_ input: PutRemediationExceptionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutRemediationExceptionsResponse>
A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
putResourceConfig(_:logger:on:)
@discardableResult public func putResourceConfig(_ input: PutResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Records the configuration state for the resource provided in the request.
The configuration state of a resource is represented in Config as Configuration Items.
Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs. </p>
<note>
<p>The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.</p>
<p>When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
</p>
<p>Write-only schema properites are not recorded as part of the published configuration item.</p>
</note>
putRetentionConfiguration(_:logger:on:)
public func putRetentionConfiguration(_ input: PutRetentionConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutRetentionConfigurationResponse>
Creates and updates the retention configuration with details
about retention period (number of days) that Config stores your
historical information. The API creates the
RetentionConfiguration
object and names the object
as default. When you have a
RetentionConfiguration
object named default, calling the API modifies the
default object.
Currently, Config supports only one retention configuration per region in your account.
putStoredQuery(_:logger:on:)
public func putStoredQuery(_ input: PutStoredQueryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutStoredQueryResponse>
Saves a new query or updates an existing saved query. The QueryName
must be unique for a single Amazon Web Services account and a single Amazon Web Services Region.
You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
selectAggregateResourceConfig(_:logger:on:)
public func selectAggregateResourceConfig(_ input: SelectAggregateResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SelectAggregateResourceConfigResponse>
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
<note>
<p>If you run an aggregation query (i.e., using <code>GROUP BY</code> or using aggregate functions such as <code>COUNT</code>; e.g., <code>SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId</code>)
and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p>
<p>If you run a non-aggregation query (i.e., not using <code>GROUP BY</code> or aggregate function; e.g., <code>SELECT * WHERE resourceType = 'AWS::IAM::Role'</code>)
and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p>
</note>
selectResourceConfig(_:logger:on:)
public func selectResourceConfig(_ input: SelectResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SelectResourceConfigResponse>
Accepts a structured query language (SQL) SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
startConfigRulesEvaluation(_:logger:on:)
public func startConfigRulesEvaluation(_ input: StartConfigRulesEvaluationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartConfigRulesEvaluationResponse>
Runs an on-demand evaluation for the specified Config rules
against the last known configuration state of the resources. Use
StartConfigRulesEvaluation
when you want to test
that a rule you updated is working as expected.
StartConfigRulesEvaluation
does not re-record the
latest configuration state for your resources. It re-runs an
evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
<p>An existing <code>StartConfigRulesEvaluation</code> call for
the specified rules must complete before you can call the API again.
If you chose to have Config stream to an Amazon SNS topic, you
will receive a <code>ConfigRuleEvaluationStarted</code> notification
when the evaluation starts.</p>
<note>
<p>You don't need to call the
<code>StartConfigRulesEvaluation</code> API to run an
evaluation for a new rule. When you create a rule, Config
evaluates your resources against the rule automatically.
</p>
</note>
<p>The <code>StartConfigRulesEvaluation</code> API is useful if
you want to run on-demand evaluations, such as the following
example:</p>
<ol>
<li>
<p>You have a custom rule that evaluates your IAM
resources every 24 hours.</p>
</li>
<li>
<p>You update your Lambda function to add additional
conditions to your rule.</p>
</li>
<li>
<p>Instead of waiting for the next periodic evaluation,
you call the <code>StartConfigRulesEvaluation</code>
API.</p>
</li>
<li>
<p>Config invokes your Lambda function and evaluates
your IAM resources.</p>
</li>
<li>
<p>Your custom rule will still run periodic evaluations
every 24 hours.</p>
</li>
</ol>
startConfigurationRecorder(_:logger:on:)
@discardableResult public func startConfigurationRecorder(_ input: StartConfigurationRecorderRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
startRemediationExecution(_:logger:on:)
public func startRemediationExecution(_ input: StartRemediationExecutionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartRemediationExecutionResponse>
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
stopConfigurationRecorder(_:logger:on:)
@discardableResult public func stopConfigurationRecorder(_ input: StopConfigurationRecorderRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
tagResource(_:logger:on:)
@discardableResult public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
untagResource(_:logger:on:)
@discardableResult public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes specified tags from a resource.
describeAggregateComplianceByConfigRulesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeAggregateComplianceByConfigRulesPaginator( _ input: DescribeAggregateComplianceByConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeAggregateComplianceByConfigRulesRequest, DescribeAggregateComplianceByConfigRulesResponse>
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.
describeAggregateComplianceByConformancePacksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeAggregateComplianceByConformancePacksPaginator( _ input: DescribeAggregateComplianceByConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeAggregateComplianceByConformancePacksRequest, DescribeAggregateComplianceByConformancePacksResponse>
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.
describeAggregationAuthorizationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeAggregationAuthorizationsPaginator( _ input: DescribeAggregationAuthorizationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeAggregationAuthorizationsRequest, DescribeAggregationAuthorizationsResponse>
Returns a list of authorizations granted to various aggregator accounts and regions.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeComplianceByConfigRulePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeComplianceByConfigRulePaginator( _ input: DescribeComplianceByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeComplianceByConfigRuleRequest, DescribeComplianceByConfigRuleResponse>
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule, it returns
INSUFFICIENT_DATA
. This result might indicate one of the following conditions:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
-
describeComplianceByResourcePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeComplianceByResourcePaginator( _ input: DescribeComplianceByResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeComplianceByResourceRequest, DescribeComplianceByResourceResponse>
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the resource, it returns
INSUFFICIENT_DATA
. This result might indicate one of the following conditions about the rules that evaluate the resource:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
-
describeConfigRuleEvaluationStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConfigRuleEvaluationStatusPaginator( _ input: DescribeConfigRuleEvaluationStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConfigRuleEvaluationStatusRequest, DescribeConfigRuleEvaluationStatusResponse>
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeConfigRulesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConfigRulesPaginator( _ input: DescribeConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConfigRulesRequest, DescribeConfigRulesResponse>
Returns details about your Config rules.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeConfigurationAggregatorSourcesStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConfigurationAggregatorSourcesStatusPaginator( _ input: DescribeConfigurationAggregatorSourcesStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConfigurationAggregatorSourcesStatusRequest, DescribeConfigurationAggregatorSourcesStatusResponse>
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeConfigurationAggregatorsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConfigurationAggregatorsPaginator( _ input: DescribeConfigurationAggregatorsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConfigurationAggregatorsRequest, DescribeConfigurationAggregatorsResponse>
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeConformancePackCompliancePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConformancePackCompliancePaginator( _ input: DescribeConformancePackComplianceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConformancePackComplianceRequest, DescribeConformancePackComplianceResponse>
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
describeConformancePackStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConformancePackStatusPaginator( _ input: DescribeConformancePackStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConformancePackStatusRequest, DescribeConformancePackStatusResponse>
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
describeConformancePacksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeConformancePacksPaginator( _ input: DescribeConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeConformancePacksRequest, DescribeConformancePacksResponse>
Returns a list of one or more conformance packs.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeOrganizationConfigRuleStatusesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Return PaginatorSequence for operation.
public func describeOrganizationConfigRuleStatusesPaginator( _ input: DescribeOrganizationConfigRuleStatusesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOrganizationConfigRuleStatusesRequest, DescribeOrganizationConfigRuleStatusesResponse>
Provides organization Config rule deployment status for an organization.
<note> <p>The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.</p> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.</p> </note>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeOrganizationConfigRulesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Return PaginatorSequence for operation.
public func describeOrganizationConfigRulesPaginator( _ input: DescribeOrganizationConfigRulesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOrganizationConfigRulesRequest, DescribeOrganizationConfigRulesResponse>
Returns a list of organization Config rules.
<note> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.</p> </note>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeOrganizationConformancePackStatusesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeOrganizationConformancePackStatusesPaginator( _ input: DescribeOrganizationConformancePackStatusesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOrganizationConformancePackStatusesRequest, DescribeOrganizationConformancePackStatusesResponse>
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
describeOrganizationConformancePacksPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeOrganizationConformancePacksPaginator( _ input: DescribeOrganizationConformancePacksRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeOrganizationConformancePacksRequest, DescribeOrganizationConformancePacksResponse>
Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
describePendingAggregationRequestsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describePendingAggregationRequestsPaginator( _ input: DescribePendingAggregationRequestsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribePendingAggregationRequestsRequest, DescribePendingAggregationRequestsResponse>
Returns a list of all pending aggregation requests.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeRemediationExceptionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeRemediationExceptionsPaginator( _ input: DescribeRemediationExceptionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeRemediationExceptionsRequest, DescribeRemediationExceptionsResponse>
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
describeRemediationExecutionStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeRemediationExecutionStatusPaginator( _ input: DescribeRemediationExecutionStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeRemediationExecutionStatusRequest, DescribeRemediationExecutionStatusResponse>
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeRetentionConfigurationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func describeRetentionConfigurationsPaginator( _ input: DescribeRetentionConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeRetentionConfigurationsRequest, DescribeRetentionConfigurationsResponse>
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
getAggregateComplianceDetailsByConfigRulePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getAggregateComplianceDetailsByConfigRulePaginator( _ input: GetAggregateComplianceDetailsByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetAggregateComplianceDetailsByConfigRuleRequest, GetAggregateComplianceDetailsByConfigRuleResponse>
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you have a
nextToken
, the results are displayed on the next page.
getAggregateConfigRuleComplianceSummaryPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getAggregateConfigRuleComplianceSummaryPaginator( _ input: GetAggregateConfigRuleComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetAggregateConfigRuleComplianceSummaryRequest, GetAggregateConfigRuleComplianceSummaryResponse>
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConformancePackComplianceSummaryPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getAggregateConformancePackComplianceSummaryPaginator( _ input: GetAggregateConformancePackComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetAggregateConformancePackComplianceSummaryRequest, GetAggregateConformancePackComplianceSummaryResponse>
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateDiscoveredResourceCountsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getAggregateDiscoveredResourceCountsPaginator( _ input: GetAggregateDiscoveredResourceCountsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetAggregateDiscoveredResourceCountsRequest, GetAggregateDiscoveredResourceCountsResponse>
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getComplianceDetailsByConfigRulePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getComplianceDetailsByConfigRulePaginator( _ input: GetComplianceDetailsByConfigRuleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetComplianceDetailsByConfigRuleRequest, GetComplianceDetailsByConfigRuleResponse>
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getComplianceDetailsByResourcePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getComplianceDetailsByResourcePaginator( _ input: GetComplianceDetailsByResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetComplianceDetailsByResourceRequest, GetComplianceDetailsByResourceResponse>
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getConformancePackComplianceDetailsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getConformancePackComplianceDetailsPaginator( _ input: GetConformancePackComplianceDetailsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetConformancePackComplianceDetailsRequest, GetConformancePackComplianceDetailsResponse>
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getConformancePackComplianceSummaryPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getConformancePackComplianceSummaryPaginator( _ input: GetConformancePackComplianceSummaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetConformancePackComplianceSummaryRequest, GetConformancePackComplianceSummaryResponse>
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getDiscoveredResourceCountsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getDiscoveredResourceCountsPaginator( _ input: GetDiscoveredResourceCountsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetDiscoveredResourceCountsRequest, GetDiscoveredResourceCountsResponse>
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify that you want all resource types. -
Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
parameter.If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
-
You are a new Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
-
getOrganizationConfigRuleDetailedStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getOrganizationConfigRuleDetailedStatusPaginator( _ input: GetOrganizationConfigRuleDetailedStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetOrganizationConfigRuleDetailedStatusRequest, GetOrganizationConfigRuleDetailedStatusResponse>
Returns detailed status for each member account within an organization for a given organization Config rule.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getOrganizationConformancePackDetailedStatusPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getOrganizationConformancePackDetailedStatusPaginator( _ input: GetOrganizationConformancePackDetailedStatusRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetOrganizationConformancePackDetailedStatusRequest, GetOrganizationConformancePackDetailedStatusResponse>
Returns detailed status for each member account within an organization for a given organization conformance pack.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getResourceConfigHistoryPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getResourceConfigHistoryPaginator( _ input: GetResourceConfigHistoryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetResourceConfigHistoryRequest, GetResourceConfigHistoryResponse>
Returns a list of
ConfigurationItems
for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain yourConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns theConfigurationItems
for the specified retention period.The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
parameter.Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified
limit
. In such cases, you can make another call, using thenextToken
.
listAggregateDiscoveredResourcesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listAggregateDiscoveredResourcesPaginator( _ input: ListAggregateDiscoveredResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListAggregateDiscoveredResourcesRequest, ListAggregateDiscoveredResourcesResponse>
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.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onAWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
listDiscoveredResourcesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listDiscoveredResourcesPaginator( _ input: ListDiscoveredResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListDiscoveredResourcesRequest, ListDiscoveredResourcesResponse>
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onlimit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
parameter.
listStoredQueriesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listStoredQueriesPaginator( _ input: ListStoredQueriesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListStoredQueriesRequest, ListStoredQueriesResponse>
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listTagsForResourcePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listTagsForResourcePaginator( _ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListTagsForResourceRequest, ListTagsForResourceResponse>
List the tags for Config resource.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
selectAggregateResourceConfigPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Return PaginatorSequence for operation.
public func selectAggregateResourceConfigPaginator( _ input: SelectAggregateResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<SelectAggregateResourceConfigRequest, SelectAggregateResourceConfigResponse>
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
<note> <p>If you run an aggregation query (i.e., using <code>GROUP BY</code> or using aggregate functions such as <code>COUNT</code>; e.g., <code>SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId</code>) and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p> <p>If you run a non-aggregation query (i.e., not using <code>GROUP BY</code> or aggregate function; e.g., <code>SELECT * WHERE resourceType = 'AWS::IAM::Role'</code>) and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p> </note>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
selectResourceConfigPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func selectResourceConfigPaginator( _ input: SelectResourceConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<SelectResourceConfigRequest, SelectResourceConfigResponse>
Accepts a structured query language (SQL)
SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.For more information about query components, see the Query Components section in the Config Developer Guide.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeAggregateComplianceByConfigRulesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeAggregateComplianceByConfigRulesPaginator<Result>(
_ input: DescribeAggregateComplianceByConfigRulesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeAggregateComplianceByConfigRulesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you
have a nextToken
, the results are displayed on the next
page.
describeAggregateComplianceByConfigRulesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeAggregateComplianceByConfigRulesPaginator(
_ input: DescribeAggregateComplianceByConfigRulesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeAggregateComplianceByConfigRulesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeAggregateComplianceByConformancePacksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeAggregateComplianceByConformancePacksPaginator<Result>(
_ input: DescribeAggregateComplianceByConformancePacksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeAggregateComplianceByConformancePacksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a nextToken
, the results are displayed on the next page.
describeAggregateComplianceByConformancePacksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeAggregateComplianceByConformancePacksPaginator(
_ input: DescribeAggregateComplianceByConformancePacksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeAggregateComplianceByConformancePacksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeAggregationAuthorizationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeAggregationAuthorizationsPaginator<Result>(
_ input: DescribeAggregationAuthorizationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeAggregationAuthorizationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of authorizations granted to various aggregator accounts and regions.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeAggregationAuthorizationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeAggregationAuthorizationsPaginator(
_ input: DescribeAggregationAuthorizationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeAggregationAuthorizationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeComplianceByConfigRulePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeComplianceByConfigRulePaginator<Result>(
_ input: DescribeComplianceByConfigRuleRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeComplianceByConfigRuleResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule,
it returns INSUFFICIENT_DATA
. This result might
indicate one of the following conditions:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
describeComplianceByConfigRulePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeComplianceByConfigRulePaginator(
_ input: DescribeComplianceByConfigRuleRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeComplianceByConfigRuleResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeComplianceByResourcePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeComplianceByResourcePaginator<Result>(
_ input: DescribeComplianceByResourceRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeComplianceByResourceResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the
resource, it returns INSUFFICIENT_DATA
. This result
might indicate one of the following conditions about the rules that
evaluate the resource:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the
config:PutEvaluations
permission. If the rule is a custom rule, verify that the Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
describeComplianceByResourcePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeComplianceByResourcePaginator(
_ input: DescribeComplianceByResourceRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeComplianceByResourceResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConfigRuleEvaluationStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConfigRuleEvaluationStatusPaginator<Result>(
_ input: DescribeConfigRuleEvaluationStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConfigRuleEvaluationStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeConfigRuleEvaluationStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConfigRuleEvaluationStatusPaginator(
_ input: DescribeConfigRuleEvaluationStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConfigRuleEvaluationStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConfigRulesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConfigRulesPaginator<Result>(
_ input: DescribeConfigRulesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConfigRulesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns details about your Config rules.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeConfigRulesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConfigRulesPaginator(
_ input: DescribeConfigRulesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConfigRulesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConfigurationAggregatorSourcesStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConfigurationAggregatorSourcesStatusPaginator<Result>(
_ input: DescribeConfigurationAggregatorSourcesStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConfigurationAggregatorSourcesStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeConfigurationAggregatorSourcesStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConfigurationAggregatorSourcesStatusPaginator(
_ input: DescribeConfigurationAggregatorSourcesStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConfigurationAggregatorSourcesStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConfigurationAggregatorsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConfigurationAggregatorsPaginator<Result>(
_ input: DescribeConfigurationAggregatorsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConfigurationAggregatorsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeConfigurationAggregatorsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConfigurationAggregatorsPaginator(
_ input: DescribeConfigurationAggregatorsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConfigurationAggregatorsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConformancePackCompliancePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConformancePackCompliancePaginator<Result>(
_ input: DescribeConformancePackComplianceRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConformancePackComplianceResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
describeConformancePackCompliancePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConformancePackCompliancePaginator(
_ input: DescribeConformancePackComplianceRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConformancePackComplianceResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConformancePackStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConformancePackStatusPaginator<Result>(
_ input: DescribeConformancePackStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConformancePackStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
describeConformancePackStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConformancePackStatusPaginator(
_ input: DescribeConformancePackStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConformancePackStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeConformancePacksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeConformancePacksPaginator<Result>(
_ input: DescribeConformancePacksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeConformancePacksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of one or more conformance packs.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeConformancePacksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeConformancePacksPaginator(
_ input: DescribeConformancePacksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeConformancePacksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOrganizationConfigRuleStatusesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOrganizationConfigRuleStatusesPaginator<Result>(
_ input: DescribeOrganizationConfigRuleStatusesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeOrganizationConfigRuleStatusesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provides organization Config rule deployment status for an organization.
<note>
<p>The status is not considered successful until organization Config rule is successfully deployed in all the member
accounts with an exception of excluded accounts.</p>
<p>When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names.
It is only applicable, when you request all the organization Config rules.</p>
</note>
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned
along with a boolean indicating if the paginate operation should continue.describeOrganizationConfigRuleStatusesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOrganizationConfigRuleStatusesPaginator(
_ input: DescribeOrganizationConfigRuleStatusesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeOrganizationConfigRuleStatusesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOrganizationConfigRulesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOrganizationConfigRulesPaginator<Result>(
_ input: DescribeOrganizationConfigRulesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeOrganizationConfigRulesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of organization Config rules.
<note>
<p>When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names.
It is only applicable, when you request all the organization Config rules.</p>
</note>
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned
along with a boolean indicating if the paginate operation should continue.describeOrganizationConfigRulesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOrganizationConfigRulesPaginator(
_ input: DescribeOrganizationConfigRulesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeOrganizationConfigRulesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOrganizationConformancePackStatusesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOrganizationConformancePackStatusesPaginator<Result>(
_ input: DescribeOrganizationConformancePackStatusesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeOrganizationConformancePackStatusesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
describeOrganizationConformancePackStatusesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOrganizationConformancePackStatusesPaginator(
_ input: DescribeOrganizationConformancePackStatusesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeOrganizationConformancePackStatusesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeOrganizationConformancePacksPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeOrganizationConformancePacksPaginator<Result>(
_ input: DescribeOrganizationConformancePacksRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeOrganizationConformancePacksResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
describeOrganizationConformancePacksPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeOrganizationConformancePacksPaginator(
_ input: DescribeOrganizationConformancePacksRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeOrganizationConformancePacksResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describePendingAggregationRequestsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describePendingAggregationRequestsPaginator<Result>(
_ input: DescribePendingAggregationRequestsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribePendingAggregationRequestsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of all pending aggregation requests.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describePendingAggregationRequestsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describePendingAggregationRequestsPaginator(
_ input: DescribePendingAggregationRequestsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribePendingAggregationRequestsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeRemediationExceptionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeRemediationExceptionsPaginator<Result>(
_ input: DescribeRemediationExceptionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeRemediationExceptionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
describeRemediationExceptionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeRemediationExceptionsPaginator(
_ input: DescribeRemediationExceptionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeRemediationExceptionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeRemediationExecutionStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeRemediationExecutionStatusPaginator<Result>(
_ input: DescribeRemediationExecutionStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeRemediationExecutionStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.describeRemediationExecutionStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeRemediationExecutionStatusPaginator(
_ input: DescribeRemediationExecutionStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeRemediationExecutionStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.describeRetentionConfigurationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func describeRetentionConfigurationsPaginator<Result>(
_ input: DescribeRetentionConfigurationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeRetentionConfigurationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
describeRetentionConfigurationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func describeRetentionConfigurationsPaginator(
_ input: DescribeRetentionConfigurationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeRetentionConfigurationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getAggregateComplianceDetailsByConfigRulePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getAggregateComplianceDetailsByConfigRulePaginator<Result>(
_ input: GetAggregateComplianceDetailsByConfigRuleRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetAggregateComplianceDetailsByConfigRuleResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you
have a nextToken
, the results are displayed on the next
page.
getAggregateComplianceDetailsByConfigRulePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getAggregateComplianceDetailsByConfigRulePaginator(
_ input: GetAggregateComplianceDetailsByConfigRuleRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetAggregateComplianceDetailsByConfigRuleResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getAggregateConfigRuleComplianceSummaryPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getAggregateConfigRuleComplianceSummaryPaginator<Result>(
_ input: GetAggregateConfigRuleComplianceSummaryRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetAggregateConfigRuleComplianceSummaryResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConfigRuleComplianceSummaryPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getAggregateConfigRuleComplianceSummaryPaginator(
_ input: GetAggregateConfigRuleComplianceSummaryRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetAggregateConfigRuleComplianceSummaryResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getAggregateConformancePackComplianceSummaryPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getAggregateConformancePackComplianceSummaryPaginator<Result>(
_ input: GetAggregateConformancePackComplianceSummaryRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetAggregateConformancePackComplianceSummaryResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConformancePackComplianceSummaryPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getAggregateConformancePackComplianceSummaryPaginator(
_ input: GetAggregateConformancePackComplianceSummaryRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetAggregateConformancePackComplianceSummaryResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getAggregateDiscoveredResourceCountsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getAggregateDiscoveredResourceCountsPaginator<Result>(
_ input: GetAggregateDiscoveredResourceCountsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetAggregateDiscoveredResourceCountsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getAggregateDiscoveredResourceCountsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getAggregateDiscoveredResourceCountsPaginator(
_ input: GetAggregateDiscoveredResourceCountsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetAggregateDiscoveredResourceCountsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getComplianceDetailsByConfigRulePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getComplianceDetailsByConfigRulePaginator<Result>(
_ input: GetComplianceDetailsByConfigRuleRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetComplianceDetailsByConfigRuleResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getComplianceDetailsByConfigRulePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getComplianceDetailsByConfigRulePaginator(
_ input: GetComplianceDetailsByConfigRuleRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetComplianceDetailsByConfigRuleResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getComplianceDetailsByResourcePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getComplianceDetailsByResourcePaginator<Result>(
_ input: GetComplianceDetailsByResourceRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetComplianceDetailsByResourceResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getComplianceDetailsByResourcePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getComplianceDetailsByResourcePaginator(
_ input: GetComplianceDetailsByResourceRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetComplianceDetailsByResourceResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getConformancePackComplianceDetailsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getConformancePackComplianceDetailsPaginator<Result>(
_ input: GetConformancePackComplianceDetailsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetConformancePackComplianceDetailsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getConformancePackComplianceDetailsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getConformancePackComplianceDetailsPaginator(
_ input: GetConformancePackComplianceDetailsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetConformancePackComplianceDetailsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getConformancePackComplianceSummaryPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getConformancePackComplianceSummaryPaginator<Result>(
_ input: GetConformancePackComplianceSummaryRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetConformancePackComplianceSummaryResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getConformancePackComplianceSummaryPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getConformancePackComplianceSummaryPaginator(
_ input: GetConformancePackComplianceSummaryRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetConformancePackComplianceSummaryResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getDiscoveredResourceCountsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getDiscoveredResourceCountsPaginator<Result>(
_ input: GetDiscoveredResourceCountsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetDiscoveredResourceCountsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify that you want all resource types. -
Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, Config lists 100
ResourceCount objects on each page. You can
customize this number with the limit
parameter. The
response includes a nextToken
string. To get the next
page of results, run the request again and specify the string for
the nextToken
parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
-
You are a new Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
getDiscoveredResourceCountsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getDiscoveredResourceCountsPaginator(
_ input: GetDiscoveredResourceCountsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetDiscoveredResourceCountsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getOrganizationConfigRuleDetailedStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getOrganizationConfigRuleDetailedStatusPaginator<Result>(
_ input: GetOrganizationConfigRuleDetailedStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetOrganizationConfigRuleDetailedStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns detailed status for each member account within an organization for a given organization Config rule.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getOrganizationConfigRuleDetailedStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getOrganizationConfigRuleDetailedStatusPaginator(
_ input: GetOrganizationConfigRuleDetailedStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetOrganizationConfigRuleDetailedStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getOrganizationConformancePackDetailedStatusPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getOrganizationConformancePackDetailedStatusPaginator<Result>(
_ input: GetOrganizationConformancePackDetailedStatusRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetOrganizationConformancePackDetailedStatusResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns detailed status for each member account within an organization for a given organization conformance pack.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getOrganizationConformancePackDetailedStatusPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getOrganizationConformancePackDetailedStatusPaginator(
_ input: GetOrganizationConformancePackDetailedStatusRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetOrganizationConformancePackDetailedStatusResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getResourceConfigHistoryPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getResourceConfigHistoryPaginator<Result>(
_ input: GetResourceConfigHistoryRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetResourceConfigHistoryResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns a list of ConfigurationItems
for the specified resource.
The list contains details about each state of the resource
during the specified time interval. If you specified a retention
period to retain your ConfigurationItems
between a
minimum of 30 days and a maximum of 7 years (2557 days), Config
returns the ConfigurationItems
for the specified
retention period.
The response is paginated. By default, Config returns a
limit of 10 configuration items per page. You can customize this
number with the limit
parameter. The response includes
a nextToken
string. To get the next page of results,
run the request again and specify the string for the
nextToken
parameter.
Each call to the API is limited to span a duration of seven
days. It is likely that the number of records returned is
smaller than the specified limit
. In such cases,
you can make another call, using the
nextToken
.
getResourceConfigHistoryPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getResourceConfigHistoryPaginator(
_ input: GetResourceConfigHistoryRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetResourceConfigHistoryResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listAggregateDiscoveredResourcesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listAggregateDiscoveredResourcesPaginator<Result>(
_ input: ListAggregateDiscoveredResourcesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListAggregateDiscoveredResourcesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
listAggregateDiscoveredResourcesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listAggregateDiscoveredResourcesPaginator(
_ input: ListAggregateDiscoveredResourcesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListAggregateDiscoveredResourcesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listDiscoveredResourcesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listDiscoveredResourcesPaginator<Result>(
_ input: ListDiscoveredResourcesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListDiscoveredResourcesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, Config lists 100
resource identifiers on each page. You can customize this number
with the limit
parameter. The response includes a
nextToken
string. To get the next page of results,
run the request again and specify the string for the
nextToken
parameter.
listDiscoveredResourcesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listDiscoveredResourcesPaginator(
_ input: ListDiscoveredResourcesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListDiscoveredResourcesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listStoredQueriesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listStoredQueriesPaginator<Result>(
_ input: ListStoredQueriesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListStoredQueriesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listStoredQueriesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listStoredQueriesPaginator(
_ input: ListStoredQueriesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListStoredQueriesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listTagsForResourcePaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listTagsForResourcePaginator<Result>(
_ input: ListTagsForResourceRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListTagsForResourceResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
List the tags for Config resource.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listTagsForResourcePaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listTagsForResourcePaginator(
_ input: ListTagsForResourceRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListTagsForResourceResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.selectAggregateResourceConfigPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func selectAggregateResourceConfigPaginator<Result>(
_ input: SelectAggregateResourceConfigRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, SelectAggregateResourceConfigResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
<note>
<p>If you run an aggregation query (i.e., using <code>GROUP BY</code> or using aggregate functions such as <code>COUNT</code>; e.g., <code>SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId</code>)
and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p>
<p>If you run a non-aggregation query (i.e., not using <code>GROUP BY</code> or aggregate function; e.g., <code>SELECT * WHERE resourceType = 'AWS::IAM::Role'</code>)
and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p>
</note>
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned
along with a boolean indicating if the paginate operation should continue.selectAggregateResourceConfigPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func selectAggregateResourceConfigPaginator(
_ input: SelectAggregateResourceConfigRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (SelectAggregateResourceConfigResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.selectResourceConfigPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func selectResourceConfigPaginator<Result>(
_ input: SelectResourceConfigRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, SelectResourceConfigResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Accepts a structured query language (SQL) SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.selectResourceConfigPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func selectResourceConfigPaginator(
_ input: SelectResourceConfigRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (SelectResourceConfigResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>