Class: Aws::ConfigService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb

Overview

An API client for ConfigService. To construct a client, you need to configure a :region and :credentials.

client = Aws::ConfigService::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#batch_get_aggregate_resource_config(params = {}) ⇒ Types::BatchGetAggregateResourceConfigResponse

Returns the current configuration items for resources that are present in your AWS 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.

* The API does not return results for deleted resources.

  • The API does not return tags and relationships.

Examples:

Request syntax with placeholder values


resp = client.batch_get_aggregate_resource_config({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  resource_identifiers: [ # required
    {
      source_account_id: "AccountId", # required
      source_region: "AwsRegion", # required
      resource_id: "ResourceId", # required
      resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
      resource_name: "ResourceName",
    },
  ],
})

Response structure


resp.base_configuration_items #=> Array
resp.base_configuration_items[0].version #=> String
resp.base_configuration_items[0]. #=> String
resp.base_configuration_items[0].configuration_item_capture_time #=> Time
resp.base_configuration_items[0].configuration_item_status #=> String, one of "OK", "ResourceDiscovered", "ResourceNotRecorded", "ResourceDeleted", "ResourceDeletedNotRecorded"
resp.base_configuration_items[0].configuration_state_id #=> String
resp.base_configuration_items[0].arn #=> String
resp.base_configuration_items[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.base_configuration_items[0].resource_id #=> String
resp.base_configuration_items[0].resource_name #=> String
resp.base_configuration_items[0].aws_region #=> String
resp.base_configuration_items[0].availability_zone #=> String
resp.base_configuration_items[0].resource_creation_time #=> Time
resp.base_configuration_items[0].configuration #=> String
resp.base_configuration_items[0].supplementary_configuration #=> Hash
resp.base_configuration_items[0].supplementary_configuration["SupplementaryConfigurationName"] #=> String
resp.unprocessed_resource_identifiers #=> Array
resp.unprocessed_resource_identifiers[0]. #=> String
resp.unprocessed_resource_identifiers[0].source_region #=> String
resp.unprocessed_resource_identifiers[0].resource_id #=> String
resp.unprocessed_resource_identifiers[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.unprocessed_resource_identifiers[0].resource_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :resource_identifiers (required, Array<Types::AggregateResourceIdentifier>) —

    A list of aggregate ResourceIdentifiers objects.

Returns:

See Also:



407
408
409
410
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 407

def batch_get_aggregate_resource_config(params = {}, options = {})
  req = build_request(:batch_get_aggregate_resource_config, params)
  req.send_request(options)
end

#batch_get_resource_config(params = {}) ⇒ Types::BatchGetResourceConfigResponse

Returns the current configuration 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.

Examples:

Request syntax with placeholder values


resp = client.batch_get_resource_config({
  resource_keys: [ # required
    {
      resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
      resource_id: "ResourceId", # required
    },
  ],
})

Response structure


resp.base_configuration_items #=> Array
resp.base_configuration_items[0].version #=> String
resp.base_configuration_items[0]. #=> String
resp.base_configuration_items[0].configuration_item_capture_time #=> Time
resp.base_configuration_items[0].configuration_item_status #=> String, one of "OK", "ResourceDiscovered", "ResourceNotRecorded", "ResourceDeleted", "ResourceDeletedNotRecorded"
resp.base_configuration_items[0].configuration_state_id #=> String
resp.base_configuration_items[0].arn #=> String
resp.base_configuration_items[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.base_configuration_items[0].resource_id #=> String
resp.base_configuration_items[0].resource_name #=> String
resp.base_configuration_items[0].aws_region #=> String
resp.base_configuration_items[0].availability_zone #=> String
resp.base_configuration_items[0].resource_creation_time #=> Time
resp.base_configuration_items[0].configuration #=> String
resp.base_configuration_items[0].supplementary_configuration #=> Hash
resp.base_configuration_items[0].supplementary_configuration["SupplementaryConfigurationName"] #=> String
resp.unprocessed_resource_keys #=> Array
resp.unprocessed_resource_keys[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.unprocessed_resource_keys[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_keys (required, Array<Types::ResourceKey>) —

    A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Returns:

See Also:



471
472
473
474
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 471

def batch_get_resource_config(params = {}, options = {})
  req = build_request(:batch_get_resource_config, params)
  req.send_request(options)
end

#delete_aggregation_authorization(params = {}) ⇒ Struct

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

Examples:

Request syntax with placeholder values


resp = client.delete_aggregation_authorization({
  authorized_account_id: "AccountId", # required
  authorized_aws_region: "AwsRegion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authorized_account_id (required, String) —

    The 12-digit account ID of the account authorized to aggregate data.

  • :authorized_aws_region (required, String) —

    The region authorized to collect aggregated data.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



498
499
500
501
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 498

def delete_aggregation_authorization(params = {}, options = {})
  req = build_request(:delete_aggregation_authorization, params)
  req.send_request(options)
end

#delete_config_rule(params = {}) ⇒ Struct

Deletes the specified AWS Config rule and all of its evaluation results.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.delete_config_rule({
  config_rule_name: "ConfigRuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



529
530
531
532
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 529

def delete_config_rule(params = {}, options = {})
  req = build_request(:delete_config_rule, params)
  req.send_request(options)
end

#delete_configuration_aggregator(params = {}) ⇒ Struct

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_aggregator({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



552
553
554
555
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 552

def delete_configuration_aggregator(params = {}, options = {})
  req = build_request(:delete_configuration_aggregator, params)
  req.send_request(options)
end

#delete_configuration_recorder(params = {}) ⇒ Struct

Deletes the configuration recorder.

After the configuration recorder is deleted, AWS 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 AWS Config console until you create a new configuration recorder.

Examples:

Request syntax with placeholder values


resp = client.delete_configuration_recorder({
  configuration_recorder_name: "RecorderName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder_name (required, String) —

    The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



586
587
588
589
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 586

def delete_configuration_recorder(params = {}, options = {})
  req = build_request(:delete_configuration_recorder, params)
  req.send_request(options)
end

#delete_conformance_pack(params = {}) ⇒ Struct

Deletes the specified conformance pack and all the AWS Config rules, remediation actions, and all evaluation results within that conformance pack.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.delete_conformance_pack({
  conformance_pack_name: "ConformancePackName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_name (required, String) —

    Name of the conformance pack you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



614
615
616
617
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 614

def delete_conformance_pack(params = {}, options = {})
  req = build_request(:delete_conformance_pack, params)
  req.send_request(options)
end

#delete_delivery_channel(params = {}) ⇒ Struct

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Examples:

Request syntax with placeholder values


resp = client.delete_delivery_channel({
  delivery_channel_name: "ChannelName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_channel_name (required, String) —

    The name of the delivery channel to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



639
640
641
642
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 639

def delete_delivery_channel(params = {}, options = {})
  req = build_request(:delete_delivery_channel, params)
  req.send_request(options)
end

#delete_evaluation_results(params = {}) ⇒ Struct

Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.

Examples:

Request syntax with placeholder values


resp = client.delete_evaluation_results({
  config_rule_name: "StringWithCharLimit64", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want to delete the evaluation results.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



665
666
667
668
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 665

def delete_evaluation_results(params = {}, options = {})
  req = build_request(:delete_evaluation_results, params)
  req.send_request(options)
end

#delete_organization_config_rule(params = {}) ⇒ Struct

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 AWS Organizations ListDelegatedAdministrator permissions are added.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.delete_organization_config_rule({
  organization_config_rule_name: "OrganizationConfigRuleName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_config_rule_name (required, String) —

    The name of organization config rule that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



697
698
699
700
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 697

def delete_organization_config_rule(params = {}, options = {})
  req = build_request(:delete_organization_config_rule, params)
  req.send_request(options)
end

#delete_organization_conformance_pack(params = {}) ⇒ Struct

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 AWS Organizations ListDelegatedAdministrator permissions are added.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.delete_organization_conformance_pack({
  organization_conformance_pack_name: "OrganizationConformancePackName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_conformance_pack_name (required, String) —

    The name of organization conformance pack that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



730
731
732
733
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 730

def delete_organization_conformance_pack(params = {}, options = {})
  req = build_request(:delete_organization_conformance_pack, params)
  req.send_request(options)
end

#delete_pending_aggregation_request(params = {}) ⇒ Struct

Deletes pending authorization requests for a specified aggregator account in a specified region.

Examples:

Request syntax with placeholder values


resp = client.delete_pending_aggregation_request({
  requester_account_id: "AccountId", # required
  requester_aws_region: "AwsRegion", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :requester_account_id (required, String) —

    The 12-digit account ID of the account requesting to aggregate data.

  • :requester_aws_region (required, String) —

    The region requesting to aggregate data.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



757
758
759
760
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 757

def delete_pending_aggregation_request(params = {}, options = {})
  req = build_request(:delete_pending_aggregation_request, params)
  req.send_request(options)
end

#delete_remediation_configuration(params = {}) ⇒ Struct

Deletes the remediation configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_remediation_configuration({
  config_rule_name: "ConfigRuleName", # required
  resource_type: "String",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want to delete remediation configuration.

  • :resource_type (String) —

    The type of a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



784
785
786
787
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 784

def delete_remediation_configuration(params = {}, options = {})
  req = build_request(:delete_remediation_configuration, params)
  req.send_request(options)
end

#delete_remediation_exceptions(params = {}) ⇒ Types::DeleteRemediationExceptionsResponse

Deletes one or more remediation exceptions mentioned in the resource keys.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.delete_remediation_exceptions({
  config_rule_name: "ConfigRuleName", # required
  resource_keys: [ # required
    {
      resource_type: "StringWithCharLimit256",
      resource_id: "StringWithCharLimit1024",
    },
  ],
})

Response structure


resp.failed_batches #=> Array
resp.failed_batches[0].failure_message #=> String
resp.failed_batches[0].failed_items #=> Array
resp.failed_batches[0].failed_items[0].resource_type #=> String
resp.failed_batches[0].failed_items[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want to delete remediation exception configuration.

  • :resource_keys (required, Array<Types::RemediationExceptionResourceKey>) —

    An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

Returns:

See Also:



835
836
837
838
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 835

def delete_remediation_exceptions(params = {}, options = {})
  req = build_request(:delete_remediation_exceptions, params)
  req.send_request(options)
end

#delete_resource_config(params = {}) ⇒ Struct

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 AWS Config History.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_config({
  resource_type: "ResourceTypeString", # required
  resource_id: "ResourceId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The type of the resource.

  • :resource_id (required, String) —

    Unique identifier of the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



864
865
866
867
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 864

def delete_resource_config(params = {}, options = {})
  req = build_request(:delete_resource_config, params)
  req.send_request(options)
end

#delete_retention_configuration(params = {}) ⇒ Struct

Deletes the retention configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_retention_configuration({
  retention_configuration_name: "RetentionConfigurationName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :retention_configuration_name (required, String) —

    The name of the retention configuration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 886

def delete_retention_configuration(params = {}, options = {})
  req = build_request(:delete_retention_configuration, params)
  req.send_request(options)
end

#delete_stored_query(params = {}) ⇒ Struct

Deletes the stored query for a single AWS account and a single AWS Region.

Examples:

Request syntax with placeholder values


resp = client.delete_stored_query({
  query_name: "QueryName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_name (required, String) —

    The name of the query that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



909
910
911
912
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 909

def delete_stored_query(params = {}, options = {})
  req = build_request(:delete_stored_query, params)
  req.send_request(options)
end

#deliver_config_snapshot(params = {}) ⇒ Types::DeliverConfigSnapshotResponse

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS 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.

Examples:

Request syntax with placeholder values


resp = client.deliver_config_snapshot({
  delivery_channel_name: "ChannelName", # required
})

Response structure


resp.config_snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_channel_name (required, String) —

    The name of the delivery channel through which the snapshot is delivered.

Returns:

See Also:



948
949
950
951
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 948

def deliver_config_snapshot(params = {}, options = {})
  req = build_request(:deliver_config_snapshot, params)
  req.send_request(options)
end

#describe_aggregate_compliance_by_config_rules(params = {}) ⇒ Types::DescribeAggregateComplianceByConfigRulesResponse

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Examples:

Request syntax with placeholder values


resp = client.describe_aggregate_compliance_by_config_rules({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  filters: {
    config_rule_name: "ConfigRuleName",
    compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
    account_id: "AccountId",
    aws_region: "AwsRegion",
  },
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.aggregate_compliance_by_config_rules #=> Array
resp.aggregate_compliance_by_config_rules[0].config_rule_name #=> String
resp.aggregate_compliance_by_config_rules[0].compliance.compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.aggregate_compliance_by_config_rules[0].compliance.compliance_contributor_count.capped_count #=> Integer
resp.aggregate_compliance_by_config_rules[0].compliance.compliance_contributor_count.cap_exceeded #=> Boolean
resp.aggregate_compliance_by_config_rules[0]. #=> String
resp.aggregate_compliance_by_config_rules[0].aws_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :filters (Types::ConfigRuleComplianceFilters) —

    Filters the results by ConfigRuleComplianceFilters object.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1009
1010
1011
1012
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1009

def describe_aggregate_compliance_by_config_rules(params = {}, options = {})
  req = build_request(:describe_aggregate_compliance_by_config_rules, params)
  req.send_request(options)
end

#describe_aggregate_compliance_by_conformance_packs(params = {}) ⇒ Types::DescribeAggregateComplianceByConformancePacksResponse

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant AWS Config rules within each conformance pack.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Examples:

Request syntax with placeholder values


resp = client.describe_aggregate_compliance_by_conformance_packs({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  filters: {
    conformance_pack_name: "ConformancePackName",
    compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, INSUFFICIENT_DATA
    account_id: "AccountId",
    aws_region: "AwsRegion",
  },
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.aggregate_compliance_by_conformance_packs #=> Array
resp.aggregate_compliance_by_conformance_packs[0].conformance_pack_name #=> String
resp.aggregate_compliance_by_conformance_packs[0].compliance.compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "INSUFFICIENT_DATA"
resp.aggregate_compliance_by_conformance_packs[0].compliance.compliant_rule_count #=> Integer
resp.aggregate_compliance_by_conformance_packs[0].compliance.non_compliant_rule_count #=> Integer
resp.aggregate_compliance_by_conformance_packs[0].compliance.total_rule_count #=> Integer
resp.aggregate_compliance_by_conformance_packs[0]. #=> String
resp.aggregate_compliance_by_conformance_packs[0].aws_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :filters (Types::AggregateConformancePackComplianceFilters) —

    Filters the result by AggregateConformancePackComplianceFilters object.

  • :limit (Integer) —

    The maximum number of conformance packs details returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1073

def describe_aggregate_compliance_by_conformance_packs(params = {}, options = {})
  req = build_request(:describe_aggregate_compliance_by_conformance_packs, params)
  req.send_request(options)
end

#describe_aggregation_authorizations(params = {}) ⇒ Types::DescribeAggregationAuthorizationsResponse

Returns a list of authorizations granted to various aggregator accounts and regions.

Examples:

Request syntax with placeholder values


resp = client.describe_aggregation_authorizations({
  limit: 1,
  next_token: "String",
})

Response structure


resp.aggregation_authorizations #=> Array
resp.aggregation_authorizations[0].aggregation_authorization_arn #=> String
resp.aggregation_authorizations[0]. #=> String
resp.aggregation_authorizations[0].authorized_aws_region #=> String
resp.aggregation_authorizations[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :limit (Integer) —

    The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1114
1115
1116
1117
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1114

def describe_aggregation_authorizations(params = {}, options = {})
  req = build_request(:describe_aggregation_authorizations, params)
  req.send_request(options)
end

#describe_compliance_by_config_rule(params = {}) ⇒ Types::DescribeComplianceByConfigRuleResponse

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS 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 AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS 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.

Examples:

Request syntax with placeholder values


resp = client.describe_compliance_by_config_rule({
  config_rule_names: ["ConfigRuleName"],
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  next_token: "String",
})

Response structure


resp.compliance_by_config_rules #=> Array
resp.compliance_by_config_rules[0].config_rule_name #=> String
resp.compliance_by_config_rules[0].compliance.compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.compliance_by_config_rules[0].compliance.compliance_contributor_count.capped_count #=> Integer
resp.compliance_by_config_rules[0].compliance.compliance_contributor_count.cap_exceeded #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_names (Array<String>) —

    Specify one or more AWS Config rule names to filter the results by rule.

  • :compliance_types (Array<String>) —

    Filters the results by compliance.

    The allowed values are COMPLIANT and NON_COMPLIANT.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1184
1185
1186
1187
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1184

def describe_compliance_by_config_rule(params = {}, options = {})
  req = build_request(:describe_compliance_by_config_rule, params)
  req.send_request(options)
end

#describe_compliance_by_resource(params = {}) ⇒ Types::DescribeComplianceByResourceResponse

Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.

A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If AWS 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:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS 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.

Examples:

Request syntax with placeholder values


resp = client.describe_compliance_by_resource({
  resource_type: "StringWithCharLimit256",
  resource_id: "BaseResourceId",
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.compliance_by_resources #=> Array
resp.compliance_by_resources[0].resource_type #=> String
resp.compliance_by_resources[0].resource_id #=> String
resp.compliance_by_resources[0].compliance.compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.compliance_by_resources[0].compliance.compliance_contributor_count.capped_count #=> Integer
resp.compliance_by_resources[0].compliance.compliance_contributor_count.cap_exceeded #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (String) —

    The types of AWS resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.

  • :resource_id (String) —

    The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

  • :compliance_types (Array<String>) —

    Filters the results by compliance.

    The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1271
1272
1273
1274
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1271

def describe_compliance_by_resource(params = {}, options = {})
  req = build_request(:describe_compliance_by_resource, params)
  req.send_request(options)
end

#describe_config_rule_evaluation_status(params = {}) ⇒ Types::DescribeConfigRuleEvaluationStatusResponse

Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.

Examples:

Request syntax with placeholder values


resp = client.describe_config_rule_evaluation_status({
  config_rule_names: ["ConfigRuleName"],
  next_token: "String",
  limit: 1,
})

Response structure


resp.config_rules_evaluation_status #=> Array
resp.config_rules_evaluation_status[0].config_rule_name #=> String
resp.config_rules_evaluation_status[0].config_rule_arn #=> String
resp.config_rules_evaluation_status[0].config_rule_id #=> String
resp.config_rules_evaluation_status[0].last_successful_invocation_time #=> Time
resp.config_rules_evaluation_status[0].last_failed_invocation_time #=> Time
resp.config_rules_evaluation_status[0].last_successful_evaluation_time #=> Time
resp.config_rules_evaluation_status[0].last_failed_evaluation_time #=> Time
resp.config_rules_evaluation_status[0].first_activated_time #=> Time
resp.config_rules_evaluation_status[0].last_deactivated_time #=> Time
resp.config_rules_evaluation_status[0].last_error_code #=> String
resp.config_rules_evaluation_status[0].last_error_message #=> String
resp.config_rules_evaluation_status[0].first_evaluation_started #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_names (Array<String>) —

    The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • :limit (Integer) —

    The number of rule evaluation results that you want returned.

    This parameter is required if the rule limit for your account is more than the default of 150 rules.

    For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

Returns:

See Also:



1337
1338
1339
1340
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1337

def describe_config_rule_evaluation_status(params = {}, options = {})
  req = build_request(:describe_config_rule_evaluation_status, params)
  req.send_request(options)
end

#describe_config_rules(params = {}) ⇒ Types::DescribeConfigRulesResponse

Returns details about your AWS Config rules.

Examples:

Request syntax with placeholder values


resp = client.describe_config_rules({
  config_rule_names: ["ConfigRuleName"],
  next_token: "String",
})

Response structure


resp.config_rules #=> Array
resp.config_rules[0].config_rule_name #=> String
resp.config_rules[0].config_rule_arn #=> String
resp.config_rules[0].config_rule_id #=> String
resp.config_rules[0].description #=> String
resp.config_rules[0].scope.compliance_resource_types #=> Array
resp.config_rules[0].scope.compliance_resource_types[0] #=> String
resp.config_rules[0].scope.tag_key #=> String
resp.config_rules[0].scope.tag_value #=> String
resp.config_rules[0].scope.compliance_resource_id #=> String
resp.config_rules[0].source.owner #=> String, one of "CUSTOM_LAMBDA", "AWS"
resp.config_rules[0].source.source_identifier #=> String
resp.config_rules[0].source.source_details #=> Array
resp.config_rules[0].source.source_details[0].event_source #=> String, one of "aws.config"
resp.config_rules[0].source.source_details[0].message_type #=> String, one of "ConfigurationItemChangeNotification", "ConfigurationSnapshotDeliveryCompleted", "ScheduledNotification", "OversizedConfigurationItemChangeNotification"
resp.config_rules[0].source.source_details[0].maximum_execution_frequency #=> String, one of "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"
resp.config_rules[0].input_parameters #=> String
resp.config_rules[0].maximum_execution_frequency #=> String, one of "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"
resp.config_rules[0].config_rule_state #=> String, one of "ACTIVE", "DELETING", "DELETING_RESULTS", "EVALUATING"
resp.config_rules[0].created_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_names (Array<String>) —

    The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1393
1394
1395
1396
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1393

def describe_config_rules(params = {}, options = {})
  req = build_request(:describe_config_rules, params)
  req.send_request(options)
end

#describe_configuration_aggregator_sources_status(params = {}) ⇒ Types::DescribeConfigurationAggregatorSourcesStatusResponse

Returns status information for sources within an aggregator. The status includes information about the last time AWS 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.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_aggregator_sources_status({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  update_status: ["FAILED"], # accepts FAILED, SUCCEEDED, OUTDATED
  next_token: "String",
  limit: 1,
})

Response structure


resp.aggregated_source_status_list #=> Array
resp.aggregated_source_status_list[0].source_id #=> String
resp.aggregated_source_status_list[0].source_type #=> String, one of "ACCOUNT", "ORGANIZATION"
resp.aggregated_source_status_list[0].aws_region #=> String
resp.aggregated_source_status_list[0].last_update_status #=> String, one of "FAILED", "SUCCEEDED", "OUTDATED"
resp.aggregated_source_status_list[0].last_update_time #=> Time
resp.aggregated_source_status_list[0].last_error_code #=> String
resp.aggregated_source_status_list[0].last_error_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :update_status (Array<String>) —

    Filters the status type.

    • Valid value FAILED indicates errors while moving data.

    • Valid value SUCCEEDED indicates the data was successfully moved.

    • Valid value OUTDATED indicates the data is not the most recent.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • :limit (Integer) —

    The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

Returns:

See Also:



1454
1455
1456
1457
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1454

def describe_configuration_aggregator_sources_status(params = {}, options = {})
  req = build_request(:describe_configuration_aggregator_sources_status, params)
  req.send_request(options)
end

#describe_configuration_aggregators(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_aggregators({
  configuration_aggregator_names: ["ConfigurationAggregatorName"],
  next_token: "String",
  limit: 1,
})

Response structure


resp.configuration_aggregators #=> Array
resp.configuration_aggregators[0].configuration_aggregator_name #=> String
resp.configuration_aggregators[0].configuration_aggregator_arn #=> String
resp.configuration_aggregators[0]. #=> Array
resp.configuration_aggregators[0].[0]. #=> Array
resp.configuration_aggregators[0].[0].[0] #=> String
resp.configuration_aggregators[0].[0].all_aws_regions #=> Boolean
resp.configuration_aggregators[0].[0].aws_regions #=> Array
resp.configuration_aggregators[0].[0].aws_regions[0] #=> String
resp.configuration_aggregators[0].organization_aggregation_source.role_arn #=> String
resp.configuration_aggregators[0].organization_aggregation_source.aws_regions #=> Array
resp.configuration_aggregators[0].organization_aggregation_source.aws_regions[0] #=> String
resp.configuration_aggregators[0].organization_aggregation_source.all_aws_regions #=> Boolean
resp.configuration_aggregators[0].creation_time #=> Time
resp.configuration_aggregators[0].last_updated_time #=> Time
resp.configuration_aggregators[0].created_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_names (Array<String>) —

    The name of the configuration aggregators.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

  • :limit (Integer) —

    The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

Returns:

See Also:



1512
1513
1514
1515
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1512

def describe_configuration_aggregators(params = {}, options = {})
  req = build_request(:describe_configuration_aggregators, params)
  req.send_request(options)
end

#describe_configuration_recorder_status(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_recorder_status({
  configuration_recorder_names: ["RecorderName"],
})

Response structure


resp.configuration_recorders_status #=> Array
resp.configuration_recorders_status[0].name #=> String
resp.configuration_recorders_status[0].last_start_time #=> Time
resp.configuration_recorders_status[0].last_stop_time #=> Time
resp.configuration_recorders_status[0].recording #=> Boolean
resp.configuration_recorders_status[0].last_status #=> String, one of "Pending", "Success", "Failure"
resp.configuration_recorders_status[0].last_error_code #=> String
resp.configuration_recorders_status[0].last_error_message #=> String
resp.configuration_recorders_status[0].last_status_change_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder_names (Array<String>) —

    The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

Returns:

See Also:



1557
1558
1559
1560
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1557

def describe_configuration_recorder_status(params = {}, options = {})
  req = build_request(:describe_configuration_recorder_status, params)
  req.send_request(options)
end

#describe_configuration_recorders(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_recorders({
  configuration_recorder_names: ["RecorderName"],
})

Response structure


resp.configuration_recorders #=> Array
resp.configuration_recorders[0].name #=> String
resp.configuration_recorders[0].role_arn #=> String
resp.configuration_recorders[0].recording_group.all_supported #=> Boolean
resp.configuration_recorders[0].recording_group.include_global_resource_types #=> Boolean
resp.configuration_recorders[0].recording_group.resource_types #=> Array
resp.configuration_recorders[0].recording_group.resource_types[0] #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder_names (Array<String>) —

    A list of configuration recorder names.

Returns:

See Also:



1598
1599
1600
1601
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1598

def describe_configuration_recorders(params = {}, options = {})
  req = build_request(:describe_configuration_recorders, params)
  req.send_request(options)
end

#describe_conformance_pack_compliance(params = {}) ⇒ Types::DescribeConformancePackComplianceResponse

Returns compliance details for each rule in that conformance pack.

You must provide exact rule names.

Examples:

Request syntax with placeholder values


resp = client.describe_conformance_pack_compliance({
  conformance_pack_name: "ConformancePackName", # required
  filters: {
    config_rule_names: ["StringWithCharLimit64"],
    compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, INSUFFICIENT_DATA
  },
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.conformance_pack_name #=> String
resp.conformance_pack_rule_compliance_list #=> Array
resp.conformance_pack_rule_compliance_list[0].config_rule_name #=> String
resp.conformance_pack_rule_compliance_list[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "INSUFFICIENT_DATA"
resp.conformance_pack_rule_compliance_list[0].controls #=> Array
resp.conformance_pack_rule_compliance_list[0].controls[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_name (required, String) —

    Name of the conformance pack.

  • :filters (Types::ConformancePackComplianceFilters) —

    A ConformancePackComplianceFilters object.

  • :limit (Integer) —

    The maximum number of AWS Config rules within a conformance pack are returned on each page.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1655

def describe_conformance_pack_compliance(params = {}, options = {})
  req = build_request(:describe_conformance_pack_compliance, params)
  req.send_request(options)
end

#describe_conformance_pack_status(params = {}) ⇒ Types::DescribeConformancePackStatusResponse

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

Examples:

Request syntax with placeholder values


resp = client.describe_conformance_pack_status({
  conformance_pack_names: ["ConformancePackName"],
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.conformance_pack_status_details #=> Array
resp.conformance_pack_status_details[0].conformance_pack_name #=> String
resp.conformance_pack_status_details[0].conformance_pack_id #=> String
resp.conformance_pack_status_details[0].conformance_pack_arn #=> String
resp.conformance_pack_status_details[0].conformance_pack_state #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.conformance_pack_status_details[0].stack_arn #=> String
resp.conformance_pack_status_details[0].conformance_pack_status_reason #=> String
resp.conformance_pack_status_details[0].last_update_requested_time #=> Time
resp.conformance_pack_status_details[0].last_update_completed_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_names (Array<String>) —

    Comma-separated list of conformance pack names.

  • :limit (Integer) —

    The maximum number of conformance packs status returned on each page.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



1706
1707
1708
1709
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1706

def describe_conformance_pack_status(params = {}, options = {})
  req = build_request(:describe_conformance_pack_status, params)
  req.send_request(options)
end

#describe_conformance_packs(params = {}) ⇒ Types::DescribeConformancePacksResponse

Returns a list of one or more conformance packs.

Examples:

Request syntax with placeholder values


resp = client.describe_conformance_packs({
  conformance_pack_names: ["ConformancePackName"],
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.conformance_pack_details #=> Array
resp.conformance_pack_details[0].conformance_pack_name #=> String
resp.conformance_pack_details[0].conformance_pack_arn #=> String
resp.conformance_pack_details[0].conformance_pack_id #=> String
resp.conformance_pack_details[0].delivery_s3_bucket #=> String
resp.conformance_pack_details[0].delivery_s3_key_prefix #=> String
resp.conformance_pack_details[0].conformance_pack_input_parameters #=> Array
resp.conformance_pack_details[0].conformance_pack_input_parameters[0].parameter_name #=> String
resp.conformance_pack_details[0].conformance_pack_input_parameters[0].parameter_value #=> String
resp.conformance_pack_details[0].last_update_requested_time #=> Time
resp.conformance_pack_details[0].created_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_names (Array<String>) —

    Comma-separated list of conformance pack names for which you want details. If you do not specify any names, AWS Config returns details for all your conformance packs.

  • :limit (Integer) —

    The maximum number of conformance packs returned on each page.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



1757
1758
1759
1760
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1757

def describe_conformance_packs(params = {}, options = {})
  req = build_request(:describe_conformance_packs, params)
  req.send_request(options)
end

#describe_delivery_channel_status(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_delivery_channel_status({
  delivery_channel_names: ["ChannelName"],
})

Response structure


resp.delivery_channels_status #=> Array
resp.delivery_channels_status[0].name #=> String
resp.delivery_channels_status[0].config_snapshot_delivery_info.last_status #=> String, one of "Success", "Failure", "Not_Applicable"
resp.delivery_channels_status[0].config_snapshot_delivery_info.last_error_code #=> String
resp.delivery_channels_status[0].config_snapshot_delivery_info.last_error_message #=> String
resp.delivery_channels_status[0].config_snapshot_delivery_info.last_attempt_time #=> Time
resp.delivery_channels_status[0].config_snapshot_delivery_info.last_successful_time #=> Time
resp.delivery_channels_status[0].config_snapshot_delivery_info.next_delivery_time #=> Time
resp.delivery_channels_status[0].config_history_delivery_info.last_status #=> String, one of "Success", "Failure", "Not_Applicable"
resp.delivery_channels_status[0].config_history_delivery_info.last_error_code #=> String
resp.delivery_channels_status[0].config_history_delivery_info.last_error_message #=> String
resp.delivery_channels_status[0].config_history_delivery_info.last_attempt_time #=> Time
resp.delivery_channels_status[0].config_history_delivery_info.last_successful_time #=> Time
resp.delivery_channels_status[0].config_history_delivery_info.next_delivery_time #=> Time
resp.delivery_channels_status[0].config_stream_delivery_info.last_status #=> String, one of "Success", "Failure", "Not_Applicable"
resp.delivery_channels_status[0].config_stream_delivery_info.last_error_code #=> String
resp.delivery_channels_status[0].config_stream_delivery_info.last_error_message #=> String
resp.delivery_channels_status[0].config_stream_delivery_info.last_status_change_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_channel_names (Array<String>) —

    A list of delivery channel names.

Returns:

See Also:



1809
1810
1811
1812
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1809

def describe_delivery_channel_status(params = {}, options = {})
  req = build_request(:describe_delivery_channel_status, params)
  req.send_request(options)
end

#describe_delivery_channels(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_delivery_channels({
  delivery_channel_names: ["ChannelName"],
})

Response structure


resp.delivery_channels #=> Array
resp.delivery_channels[0].name #=> String
resp.delivery_channels[0].s3_bucket_name #=> String
resp.delivery_channels[0].s3_key_prefix #=> String
resp.delivery_channels[0].s3_kms_key_arn #=> String
resp.delivery_channels[0].sns_topic_arn #=> String
resp.delivery_channels[0].config_snapshot_delivery_properties.delivery_frequency #=> String, one of "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_channel_names (Array<String>) —

    A list of delivery channel names.

Returns:

See Also:



1850
1851
1852
1853
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1850

def describe_delivery_channels(params = {}, options = {})
  req = build_request(:describe_delivery_channels, params)
  req.send_request(options)
end

#describe_organization_config_rule_statuses(params = {}) ⇒ Types::DescribeOrganizationConfigRuleStatusesResponse

Provides organization config rule deployment status for an organization.

The status is not considered successful until organization config rule 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 config rule names. It is only applicable, when you request all the organization config rules.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_config_rule_statuses({
  organization_config_rule_names: ["StringWithCharLimit64"],
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_config_rule_statuses #=> Array
resp.organization_config_rule_statuses[0].organization_config_rule_name #=> String
resp.organization_config_rule_statuses[0].organization_rule_status #=> String, one of "CREATE_SUCCESSFUL", "CREATE_IN_PROGRESS", "CREATE_FAILED", "DELETE_SUCCESSFUL", "DELETE_FAILED", "DELETE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.organization_config_rule_statuses[0].error_code #=> String
resp.organization_config_rule_statuses[0].error_message #=> String
resp.organization_config_rule_statuses[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_config_rule_names (Array<String>) —

    The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.

  • :limit (Integer) —

    The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1910
1911
1912
1913
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1910

def describe_organization_config_rule_statuses(params = {}, options = {})
  req = build_request(:describe_organization_config_rule_statuses, params)
  req.send_request(options)
end

#describe_organization_config_rules(params = {}) ⇒ Types::DescribeOrganizationConfigRulesResponse

Returns a list of organization config rules.

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.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_config_rules({
  organization_config_rule_names: ["StringWithCharLimit64"],
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_config_rules #=> Array
resp.organization_config_rules[0].organization_config_rule_name #=> String
resp.organization_config_rules[0].organization_config_rule_arn #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.description #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.rule_identifier #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.input_parameters #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.maximum_execution_frequency #=> String, one of "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"
resp.organization_config_rules[0].organization_managed_rule_metadata.resource_types_scope #=> Array
resp.organization_config_rules[0].organization_managed_rule_metadata.resource_types_scope[0] #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.resource_id_scope #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.tag_key_scope #=> String
resp.organization_config_rules[0].organization_managed_rule_metadata.tag_value_scope #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.description #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.lambda_function_arn #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.organization_config_rule_trigger_types #=> Array
resp.organization_config_rules[0].organization_custom_rule_metadata.organization_config_rule_trigger_types[0] #=> String, one of "ConfigurationItemChangeNotification", "OversizedConfigurationItemChangeNotification", "ScheduledNotification"
resp.organization_config_rules[0].organization_custom_rule_metadata.input_parameters #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.maximum_execution_frequency #=> String, one of "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"
resp.organization_config_rules[0].organization_custom_rule_metadata.resource_types_scope #=> Array
resp.organization_config_rules[0].organization_custom_rule_metadata.resource_types_scope[0] #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.resource_id_scope #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.tag_key_scope #=> String
resp.organization_config_rules[0].organization_custom_rule_metadata.tag_value_scope #=> String
resp.organization_config_rules[0].excluded_accounts #=> Array
resp.organization_config_rules[0].excluded_accounts[0] #=> String
resp.organization_config_rules[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_config_rule_names (Array<String>) —

    The names of organization config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization config rules.

  • :limit (Integer) —

    The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



1985
1986
1987
1988
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1985

def describe_organization_config_rules(params = {}, options = {})
  req = build_request(:describe_organization_config_rules, params)
  req.send_request(options)
end

#describe_organization_conformance_pack_statuses(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_conformance_pack_statuses({
  organization_conformance_pack_names: ["OrganizationConformancePackName"],
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_conformance_pack_statuses #=> Array
resp.organization_conformance_pack_statuses[0].organization_conformance_pack_name #=> String
resp.organization_conformance_pack_statuses[0].status #=> String, one of "CREATE_SUCCESSFUL", "CREATE_IN_PROGRESS", "CREATE_FAILED", "DELETE_SUCCESSFUL", "DELETE_FAILED", "DELETE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.organization_conformance_pack_statuses[0].error_code #=> String
resp.organization_conformance_pack_statuses[0].error_message #=> String
resp.organization_conformance_pack_statuses[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_conformance_pack_names (Array<String>) —

    The names of organization conformance packs for which you want status details. If you do not specify any names, AWS Config returns details for all your organization conformance packs.

  • :limit (Integer) —

    The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2045
2046
2047
2048
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2045

def describe_organization_conformance_pack_statuses(params = {}, options = {})
  req = build_request(:describe_organization_conformance_pack_statuses, params)
  req.send_request(options)
end

#describe_organization_conformance_packs(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_conformance_packs({
  organization_conformance_pack_names: ["OrganizationConformancePackName"],
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_conformance_packs #=> Array
resp.organization_conformance_packs[0].organization_conformance_pack_name #=> String
resp.organization_conformance_packs[0].organization_conformance_pack_arn #=> String
resp.organization_conformance_packs[0].delivery_s3_bucket #=> String
resp.organization_conformance_packs[0].delivery_s3_key_prefix #=> String
resp.organization_conformance_packs[0].conformance_pack_input_parameters #=> Array
resp.organization_conformance_packs[0].conformance_pack_input_parameters[0].parameter_name #=> String
resp.organization_conformance_packs[0].conformance_pack_input_parameters[0].parameter_value #=> String
resp.organization_conformance_packs[0].excluded_accounts #=> Array
resp.organization_conformance_packs[0].excluded_accounts[0] #=> String
resp.organization_conformance_packs[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_conformance_pack_names (Array<String>) —

    The name that you assign to an organization conformance pack.

  • :limit (Integer) —

    The maximum number of organization config packs returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2105
2106
2107
2108
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2105

def describe_organization_conformance_packs(params = {}, options = {})
  req = build_request(:describe_organization_conformance_packs, params)
  req.send_request(options)
end

#describe_pending_aggregation_requests(params = {}) ⇒ Types::DescribePendingAggregationRequestsResponse

Returns a list of all pending aggregation requests.

Examples:

Request syntax with placeholder values


resp = client.describe_pending_aggregation_requests({
  limit: 1,
  next_token: "String",
})

Response structure


resp.pending_aggregation_requests #=> Array
resp.pending_aggregation_requests[0]. #=> String
resp.pending_aggregation_requests[0].requester_aws_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2143
2144
2145
2146
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2143

def describe_pending_aggregation_requests(params = {}, options = {})
  req = build_request(:describe_pending_aggregation_requests, params)
  req.send_request(options)
end

#describe_remediation_configurations(params = {}) ⇒ Types::DescribeRemediationConfigurationsResponse

Returns the details of one or more remediation configurations.

Examples:

Request syntax with placeholder values


resp = client.describe_remediation_configurations({
  config_rule_names: ["ConfigRuleName"], # required
})

Response structure


resp.remediation_configurations #=> Array
resp.remediation_configurations[0].config_rule_name #=> String
resp.remediation_configurations[0].target_type #=> String, one of "SSM_DOCUMENT"
resp.remediation_configurations[0].target_id #=> String
resp.remediation_configurations[0].target_version #=> String
resp.remediation_configurations[0].parameters #=> Hash
resp.remediation_configurations[0].parameters["StringWithCharLimit256"].resource_value.value #=> String, one of "RESOURCE_ID"
resp.remediation_configurations[0].parameters["StringWithCharLimit256"].static_value.values #=> Array
resp.remediation_configurations[0].parameters["StringWithCharLimit256"].static_value.values[0] #=> String
resp.remediation_configurations[0].resource_type #=> String
resp.remediation_configurations[0].automatic #=> Boolean
resp.remediation_configurations[0].execution_controls.ssm_controls.concurrent_execution_rate_percentage #=> Integer
resp.remediation_configurations[0].execution_controls.ssm_controls.error_percentage #=> Integer
resp.remediation_configurations[0].maximum_automatic_attempts #=> Integer
resp.remediation_configurations[0].retry_attempt_seconds #=> Integer
resp.remediation_configurations[0].arn #=> String
resp.remediation_configurations[0].created_by_service #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_names (required, Array<String>) —

    A list of AWS Config rule names of remediation configurations for which you want details.

Returns:

See Also:



2188
2189
2190
2191
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2188

def describe_remediation_configurations(params = {}, options = {})
  req = build_request(:describe_remediation_configurations, params)
  req.send_request(options)
end

#describe_remediation_exceptions(params = {}) ⇒ Types::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.

AWS 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_remediation_exceptions({
  config_rule_name: "ConfigRuleName", # required
  resource_keys: [
    {
      resource_type: "StringWithCharLimit256",
      resource_id: "StringWithCharLimit1024",
    },
  ],
  limit: 1,
  next_token: "String",
})

Response structure


resp.remediation_exceptions #=> Array
resp.remediation_exceptions[0].config_rule_name #=> String
resp.remediation_exceptions[0].resource_type #=> String
resp.remediation_exceptions[0].resource_id #=> String
resp.remediation_exceptions[0].message #=> String
resp.remediation_exceptions[0].expiration_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule.

  • :resource_keys (Array<Types::RemediationExceptionResourceKey>) —

    An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

  • :limit (Integer) —

    The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



2263
2264
2265
2266
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2263

def describe_remediation_exceptions(params = {}, options = {})
  req = build_request(:describe_remediation_exceptions, params)
  req.send_request(options)
end

#describe_remediation_execution_status(params = {}) ⇒ Types::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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_remediation_execution_status({
  config_rule_name: "ConfigRuleName", # required
  resource_keys: [
    {
      resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
      resource_id: "ResourceId", # required
    },
  ],
  limit: 1,
  next_token: "String",
})

Response structure


resp.remediation_execution_statuses #=> Array
resp.remediation_execution_statuses[0].resource_key.resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.remediation_execution_statuses[0].resource_key.resource_id #=> String
resp.remediation_execution_statuses[0].state #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.remediation_execution_statuses[0].step_details #=> Array
resp.remediation_execution_statuses[0].step_details[0].name #=> String
resp.remediation_execution_statuses[0].step_details[0].state #=> String, one of "SUCCEEDED", "PENDING", "FAILED"
resp.remediation_execution_statuses[0].step_details[0].error_message #=> String
resp.remediation_execution_statuses[0].step_details[0].start_time #=> Time
resp.remediation_execution_statuses[0].step_details[0].stop_time #=> Time
resp.remediation_execution_statuses[0].invocation_time #=> Time
resp.remediation_execution_statuses[0].last_updated_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    A list of AWS Config rule names.

  • :resource_keys (Array<Types::ResourceKey>) —

    A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

  • :limit (Integer) —

    The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2331
2332
2333
2334
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2331

def describe_remediation_execution_status(params = {}, options = {})
  req = build_request(:describe_remediation_execution_status, params)
  req.send_request(options)
end

#describe_retention_configurations(params = {}) ⇒ Types::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, AWS Config supports only one retention configuration per region in your account.

Examples:

Request syntax with placeholder values


resp = client.describe_retention_configurations({
  retention_configuration_names: ["RetentionConfigurationName"],
  next_token: "NextToken",
})

Response structure


resp.retention_configurations #=> Array
resp.retention_configurations[0].name #=> String
resp.retention_configurations[0].retention_period_in_days #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :retention_configuration_names (Array<String>) —

    A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account.

    Currently, AWS Config supports only one retention configuration per region in your account.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2382
2383
2384
2385
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2382

def describe_retention_configurations(params = {}, options = {})
  req = build_request(:describe_retention_configurations, params)
  req.send_request(options)
end

#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse

Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS 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.

Examples:

Request syntax with placeholder values


resp = client.get_aggregate_compliance_details_by_config_rule({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  config_rule_name: "ConfigRuleName", # required
  account_id: "AccountId", # required
  aws_region: "AwsRegion", # required
  compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.aggregate_evaluation_results #=> Array
resp.aggregate_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.config_rule_name #=> String
resp.aggregate_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_type #=> String
resp.aggregate_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_id #=> String
resp.aggregate_evaluation_results[0].evaluation_result_identifier.ordering_timestamp #=> Time
resp.aggregate_evaluation_results[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.aggregate_evaluation_results[0].result_recorded_time #=> Time
resp.aggregate_evaluation_results[0].config_rule_invoked_time #=> Time
resp.aggregate_evaluation_results[0].annotation #=> String
resp.aggregate_evaluation_results[0]. #=> String
resp.aggregate_evaluation_results[0].aws_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want compliance information.

  • :account_id (required, String) —

    The 12-digit account ID of the source account.

  • :aws_region (required, String) —

    The source region from where the data is aggregated.

  • :compliance_type (String) —

    The resource compliance status.

    For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2465
2466
2467
2468
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2465

def get_aggregate_compliance_details_by_config_rule(params = {}, options = {})
  req = build_request(:get_aggregate_compliance_details_by_config_rule, params)
  req.send_request(options)
end

#get_aggregate_config_rule_compliance_summary(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.get_aggregate_config_rule_compliance_summary({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  filters: {
    account_id: "AccountId",
    aws_region: "AwsRegion",
  },
  group_by_key: "ACCOUNT_ID", # accepts ACCOUNT_ID, AWS_REGION
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.group_by_key #=> String
resp.aggregate_compliance_counts #=> Array
resp.aggregate_compliance_counts[0].group_name #=> String
resp.aggregate_compliance_counts[0].compliance_summary.compliant_resource_count.capped_count #=> Integer
resp.aggregate_compliance_counts[0].compliance_summary.compliant_resource_count.cap_exceeded #=> Boolean
resp.aggregate_compliance_counts[0].compliance_summary.non_compliant_resource_count.capped_count #=> Integer
resp.aggregate_compliance_counts[0].compliance_summary.non_compliant_resource_count.cap_exceeded #=> Boolean
resp.aggregate_compliance_counts[0].compliance_summary.compliance_summary_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :filters (Types::ConfigRuleComplianceSummaryFilters) —

    Filters the results based on the ConfigRuleComplianceSummaryFilters object.

  • :group_by_key (String) —

    Groups the result based on ACCOUNT_ID or AWS_REGION.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2532
2533
2534
2535
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2532

def get_aggregate_config_rule_compliance_summary(params = {}, options = {})
  req = build_request(:get_aggregate_config_rule_compliance_summary, params)
  req.send_request(options)
end

#get_aggregate_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetAggregateConformancePackComplianceSummaryResponse

Returns the count of compliant and noncompliant conformance packs across all AWS Accounts and AWS Regions. You can filter based on AWS Account ID or AWS Region.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Examples:

Request syntax with placeholder values


resp = client.get_aggregate_conformance_pack_compliance_summary({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  filters: {
    account_id: "AccountId",
    aws_region: "AwsRegion",
  },
  group_by_key: "ACCOUNT_ID", # accepts ACCOUNT_ID, AWS_REGION
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.aggregate_conformance_pack_compliance_summaries #=> Array
resp.aggregate_conformance_pack_compliance_summaries[0].compliance_summary.compliant_conformance_pack_count #=> Integer
resp.aggregate_conformance_pack_compliance_summaries[0].compliance_summary.non_compliant_conformance_pack_count #=> Integer
resp.aggregate_conformance_pack_compliance_summaries[0].group_name #=> String
resp.group_by_key #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :filters (Types::AggregateConformancePackComplianceSummaryFilters) —

    Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

  • :group_by_key (String) —

    Groups the result based on AWS Account ID or AWS Region.

  • :limit (Integer) —

    The maximum number of results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2596
2597
2598
2599
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2596

def get_aggregate_conformance_pack_compliance_summary(params = {}, options = {})
  req = build_request(:get_aggregate_conformance_pack_compliance_summary, params)
  req.send_request(options)
end

#get_aggregate_discovered_resource_counts(params = {}) ⇒ Types::GetAggregateDiscoveredResourceCountsResponse

Returns the resource counts across accounts and regions that are present in your AWS 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.

Examples:

Request syntax with placeholder values


resp = client.get_aggregate_discovered_resource_counts({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  filters: {
    resource_type: "AWS::EC2::CustomerGateway", # accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
    account_id: "AccountId",
    region: "AwsRegion",
  },
  group_by_key: "RESOURCE_TYPE", # accepts RESOURCE_TYPE, ACCOUNT_ID, AWS_REGION
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.total_discovered_resources #=> Integer
resp.group_by_key #=> String
resp.grouped_resource_counts #=> Array
resp.grouped_resource_counts[0].group_name #=> String
resp.grouped_resource_counts[0].resource_count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :filters (Types::ResourceCountFilters) —

    Filters the results based on the ResourceCountFilters object.

  • :group_by_key (String) —

    The key to group the resource counts.

  • :limit (Integer) —

    The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2663
2664
2665
2666
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2663

def get_aggregate_discovered_resource_counts(params = {}, options = {})
  req = build_request(:get_aggregate_discovered_resource_counts, params)
  req.send_request(options)
end

#get_aggregate_resource_config(params = {}) ⇒ Types::GetAggregateResourceConfigResponse

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Examples:

Request syntax with placeholder values


resp = client.get_aggregate_resource_config({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  resource_identifier: { # required
    source_account_id: "AccountId", # required
    source_region: "AwsRegion", # required
    resource_id: "ResourceId", # required
    resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
    resource_name: "ResourceName",
  },
})

Response structure


resp.configuration_item.version #=> String
resp.configuration_item. #=> String
resp.configuration_item.configuration_item_capture_time #=> Time
resp.configuration_item.configuration_item_status #=> String, one of "OK", "ResourceDiscovered", "ResourceNotRecorded", "ResourceDeleted", "ResourceDeletedNotRecorded"
resp.configuration_item.configuration_state_id #=> String
resp.configuration_item.configuration_item_md5_hash #=> String
resp.configuration_item.arn #=> String
resp.configuration_item.resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.configuration_item.resource_id #=> String
resp.configuration_item.resource_name #=> String
resp.configuration_item.aws_region #=> String
resp.configuration_item.availability_zone #=> String
resp.configuration_item.resource_creation_time #=> Time
resp.configuration_item.tags #=> Hash
resp.configuration_item.tags["Name"] #=> String
resp.configuration_item.related_events #=> Array
resp.configuration_item.related_events[0] #=> String
resp.configuration_item.relationships #=> Array
resp.configuration_item.relationships[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.configuration_item.relationships[0].resource_id #=> String
resp.configuration_item.relationships[0].resource_name #=> String
resp.configuration_item.relationships[0].relationship_name #=> String
resp.configuration_item.configuration #=> String
resp.configuration_item.supplementary_configuration #=> Hash
resp.configuration_item.supplementary_configuration["SupplementaryConfigurationName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :resource_identifier (required, Types::AggregateResourceIdentifier) —

    An object that identifies aggregate resource.

Returns:

See Also:



2726
2727
2728
2729
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2726

def get_aggregate_resource_config(params = {}, options = {})
  req = build_request(:get_aggregate_resource_config, params)
  req.send_request(options)
end

#get_compliance_details_by_config_rule(params = {}) ⇒ Types::GetComplianceDetailsByConfigRuleResponse

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

Examples:

Request syntax with placeholder values


resp = client.get_compliance_details_by_config_rule({
  config_rule_name: "StringWithCharLimit64", # required
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.evaluation_results #=> Array
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.config_rule_name #=> String
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_type #=> String
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_id #=> String
resp.evaluation_results[0].evaluation_result_identifier.ordering_timestamp #=> Time
resp.evaluation_results[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.evaluation_results[0].result_recorded_time #=> Time
resp.evaluation_results[0].config_rule_invoked_time #=> Time
resp.evaluation_results[0].annotation #=> String
resp.evaluation_results[0].result_token #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want compliance information.

  • :compliance_types (Array<String>) —

    Filters the results by compliance.

    The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2787
2788
2789
2790
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2787

def get_compliance_details_by_config_rule(params = {}, options = {})
  req = build_request(:get_compliance_details_by_config_rule, params)
  req.send_request(options)
end

#get_compliance_details_by_resource(params = {}) ⇒ Types::GetComplianceDetailsByResourceResponse

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

Examples:

Request syntax with placeholder values


resp = client.get_compliance_details_by_resource({
  resource_type: "StringWithCharLimit256", # required
  resource_id: "BaseResourceId", # required
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  next_token: "String",
})

Response structure


resp.evaluation_results #=> Array
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.config_rule_name #=> String
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_type #=> String
resp.evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_id #=> String
resp.evaluation_results[0].evaluation_result_identifier.ordering_timestamp #=> Time
resp.evaluation_results[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.evaluation_results[0].result_recorded_time #=> Time
resp.evaluation_results[0].config_rule_invoked_time #=> Time
resp.evaluation_results[0].annotation #=> String
resp.evaluation_results[0].result_token #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The type of the AWS resource for which you want compliance information.

  • :resource_id (required, String) —

    The ID of the AWS resource for which you want compliance information.

  • :compliance_types (Array<String>) —

    Filters the results by compliance.

    The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



2846
2847
2848
2849
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2846

def get_compliance_details_by_resource(params = {}, options = {})
  req = build_request(:get_compliance_details_by_resource, params)
  req.send_request(options)
end

#get_compliance_summary_by_config_rule(params = {}) ⇒ Types::GetComplianceSummaryByConfigRuleResponse

Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Examples:

Response structure


resp.compliance_summary.compliant_resource_count.capped_count #=> Integer
resp.compliance_summary.compliant_resource_count.cap_exceeded #=> Boolean
resp.compliance_summary.non_compliant_resource_count.capped_count #=> Integer
resp.compliance_summary.non_compliant_resource_count.cap_exceeded #=> Boolean
resp.compliance_summary.compliance_summary_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2870
2871
2872
2873
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2870

def get_compliance_summary_by_config_rule(params = {}, options = {})
  req = build_request(:get_compliance_summary_by_config_rule, params)
  req.send_request(options)
end

#get_compliance_summary_by_resource_type(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.get_compliance_summary_by_resource_type({
  resource_types: ["StringWithCharLimit256"],
})

Response structure


resp.compliance_summaries_by_resource_type #=> Array
resp.compliance_summaries_by_resource_type[0].resource_type #=> String
resp.compliance_summaries_by_resource_type[0].compliance_summary.compliant_resource_count.capped_count #=> Integer
resp.compliance_summaries_by_resource_type[0].compliance_summary.compliant_resource_count.cap_exceeded #=> Boolean
resp.compliance_summaries_by_resource_type[0].compliance_summary.non_compliant_resource_count.capped_count #=> Integer
resp.compliance_summaries_by_resource_type[0].compliance_summary.non_compliant_resource_count.cap_exceeded #=> Boolean
resp.compliance_summaries_by_resource_type[0].compliance_summary.compliance_summary_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_types (Array<String>) —

    Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

    For this request, you can specify an AWS resource type such as AWS::EC2::Instance. You can specify that the resource type is an AWS account by specifying AWS::::Account.

Returns:

See Also:



2913
2914
2915
2916
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2913

def get_compliance_summary_by_resource_type(params = {}, options = {})
  req = build_request(:get_compliance_summary_by_resource_type, params)
  req.send_request(options)
end

#get_conformance_pack_compliance_details(params = {}) ⇒ Types::GetConformancePackComplianceDetailsResponse

Returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack.

Examples:

Request syntax with placeholder values


resp = client.get_conformance_pack_compliance_details({
  conformance_pack_name: "ConformancePackName", # required
  filters: {
    config_rule_names: ["StringWithCharLimit64"],
    compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, INSUFFICIENT_DATA
    resource_type: "StringWithCharLimit256",
    resource_ids: ["StringWithCharLimit256"],
  },
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.conformance_pack_name #=> String
resp.conformance_pack_rule_evaluation_results #=> Array
resp.conformance_pack_rule_evaluation_results[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "INSUFFICIENT_DATA"
resp.conformance_pack_rule_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.config_rule_name #=> String
resp.conformance_pack_rule_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_type #=> String
resp.conformance_pack_rule_evaluation_results[0].evaluation_result_identifier.evaluation_result_qualifier.resource_id #=> String
resp.conformance_pack_rule_evaluation_results[0].evaluation_result_identifier.ordering_timestamp #=> Time
resp.conformance_pack_rule_evaluation_results[0].config_rule_invoked_time #=> Time
resp.conformance_pack_rule_evaluation_results[0].result_recorded_time #=> Time
resp.conformance_pack_rule_evaluation_results[0].annotation #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_name (required, String) —

    Name of the conformance pack.

  • :filters (Types::ConformancePackEvaluationFilters) —

    A ConformancePackEvaluationFilters object.

  • :limit (Integer) —

    The maximum number of evaluation results returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



2974
2975
2976
2977
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2974

def get_conformance_pack_compliance_details(params = {}, options = {})
  req = build_request(:get_conformance_pack_compliance_details, params)
  req.send_request(options)
end

#get_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetConformancePackComplianceSummaryResponse

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Examples:

Request syntax with placeholder values


resp = client.get_conformance_pack_compliance_summary({
  conformance_pack_names: ["ConformancePackName"], # required
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.conformance_pack_compliance_summary_list #=> Array
resp.conformance_pack_compliance_summary_list[0].conformance_pack_name #=> String
resp.conformance_pack_compliance_summary_list[0].conformance_pack_compliance_status #=> String, one of "COMPLIANT", "NON_COMPLIANT", "INSUFFICIENT_DATA"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_names (required, Array<String>) —

    Names of conformance packs.

  • :limit (Integer) —

    The maximum number of conformance packs returned on each page.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3017
3018
3019
3020
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3017

def get_conformance_pack_compliance_summary(params = {}, options = {})
  req = build_request(:get_conformance_pack_compliance_summary, params)
  req.send_request(options)
end

#get_discovered_resource_counts(params = {}) ⇒ Types::GetDiscoveredResourceCountsResponse

Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.

Example

  1. AWS 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.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. AWS 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, AWS 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 AWS Config customer.

  • You just enabled resource recording.

It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

Examples:

Request syntax with placeholder values


resp = client.get_discovered_resource_counts({
  resource_types: ["StringWithCharLimit256"],
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.total_discovered_resources #=> Integer
resp.resource_counts #=> Array
resp.resource_counts[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.resource_counts[0].count #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_types (Array<String>) —

    The comma-separated list that specifies the resource types that you want AWS Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

    If a value for resourceTypes is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account.

    If the configuration recorder is turned off, AWS Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

  • :limit (Integer) —

    The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3114
3115
3116
3117
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3114

def get_discovered_resource_counts(params = {}, options = {})
  req = build_request(:get_discovered_resource_counts, params)
  req.send_request(options)
end

#get_organization_config_rule_detailed_status(params = {}) ⇒ Types::GetOrganizationConfigRuleDetailedStatusResponse

Returns detailed status for each member account within an organization for a given organization config rule.

Examples:

Request syntax with placeholder values


resp = client.get_organization_config_rule_detailed_status({
  organization_config_rule_name: "OrganizationConfigRuleName", # required
  filters: {
    account_id: "AccountId",
    member_account_rule_status: "CREATE_SUCCESSFUL", # accepts CREATE_SUCCESSFUL, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_SUCCESSFUL, DELETE_FAILED, DELETE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_IN_PROGRESS, UPDATE_FAILED
  },
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_config_rule_detailed_status #=> Array
resp.organization_config_rule_detailed_status[0]. #=> String
resp.organization_config_rule_detailed_status[0].config_rule_name #=> String
resp.organization_config_rule_detailed_status[0]. #=> String, one of "CREATE_SUCCESSFUL", "CREATE_IN_PROGRESS", "CREATE_FAILED", "DELETE_SUCCESSFUL", "DELETE_FAILED", "DELETE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.organization_config_rule_detailed_status[0].error_code #=> String
resp.organization_config_rule_detailed_status[0].error_message #=> String
resp.organization_config_rule_detailed_status[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_config_rule_name (required, String) —

    The name of organization config rule for which you want status details for member accounts.

  • :filters (Types::StatusDetailFilters) —

    A StatusDetailFilters object.

  • :limit (Integer) —

    The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3170
3171
3172
3173
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3170

def get_organization_config_rule_detailed_status(params = {}, options = {})
  req = build_request(:get_organization_config_rule_detailed_status, params)
  req.send_request(options)
end

#get_organization_conformance_pack_detailed_status(params = {}) ⇒ Types::GetOrganizationConformancePackDetailedStatusResponse

Returns detailed status for each member account within an organization for a given organization conformance pack.

Examples:

Request syntax with placeholder values


resp = client.get_organization_conformance_pack_detailed_status({
  organization_conformance_pack_name: "OrganizationConformancePackName", # required
  filters: {
    account_id: "AccountId",
    status: "CREATE_SUCCESSFUL", # accepts CREATE_SUCCESSFUL, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_SUCCESSFUL, DELETE_FAILED, DELETE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_IN_PROGRESS, UPDATE_FAILED
  },
  limit: 1,
  next_token: "String",
})

Response structure


resp.organization_conformance_pack_detailed_statuses #=> Array
resp.organization_conformance_pack_detailed_statuses[0]. #=> String
resp.organization_conformance_pack_detailed_statuses[0].conformance_pack_name #=> String
resp.organization_conformance_pack_detailed_statuses[0].status #=> String, one of "CREATE_SUCCESSFUL", "CREATE_IN_PROGRESS", "CREATE_FAILED", "DELETE_SUCCESSFUL", "DELETE_FAILED", "DELETE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.organization_conformance_pack_detailed_statuses[0].error_code #=> String
resp.organization_conformance_pack_detailed_statuses[0].error_message #=> String
resp.organization_conformance_pack_detailed_statuses[0].last_update_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_conformance_pack_name (required, String) —

    The name of organization conformance pack for which you want status details for member accounts.

  • :filters (Types::OrganizationResourceDetailedStatusFilters) —

    An OrganizationResourceDetailedStatusFilters object.

  • :limit (Integer) —

    The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3226
3227
3228
3229
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3226

def get_organization_conformance_pack_detailed_status(params = {}, options = {})
  req = build_request(:get_organization_conformance_pack_detailed_status, params)
  req.send_request(options)
end

#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse

Returns a list of configuration items 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), AWS Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, AWS 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_resource_config_history({
  resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
  resource_id: "ResourceId", # required
  later_time: Time.now,
  earlier_time: Time.now,
  chronological_order: "Reverse", # accepts Reverse, Forward
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.configuration_items #=> Array
resp.configuration_items[0].version #=> String
resp.configuration_items[0]. #=> String
resp.configuration_items[0].configuration_item_capture_time #=> Time
resp.configuration_items[0].configuration_item_status #=> String, one of "OK", "ResourceDiscovered", "ResourceNotRecorded", "ResourceDeleted", "ResourceDeletedNotRecorded"
resp.configuration_items[0].configuration_state_id #=> String
resp.configuration_items[0].configuration_item_md5_hash #=> String
resp.configuration_items[0].arn #=> String
resp.configuration_items[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.configuration_items[0].resource_id #=> String
resp.configuration_items[0].resource_name #=> String
resp.configuration_items[0].aws_region #=> String
resp.configuration_items[0].availability_zone #=> String
resp.configuration_items[0].resource_creation_time #=> Time
resp.configuration_items[0].tags #=> Hash
resp.configuration_items[0].tags["Name"] #=> String
resp.configuration_items[0].related_events #=> Array
resp.configuration_items[0].related_events[0] #=> String
resp.configuration_items[0].relationships #=> Array
resp.configuration_items[0].relationships[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.configuration_items[0].relationships[0].resource_id #=> String
resp.configuration_items[0].relationships[0].resource_name #=> String
resp.configuration_items[0].relationships[0].relationship_name #=> String
resp.configuration_items[0].configuration #=> String
resp.configuration_items[0].supplementary_configuration #=> Hash
resp.configuration_items[0].supplementary_configuration["SupplementaryConfigurationName"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The resource type.

  • :resource_id (required, String) —

    The ID of the resource (for example., sg-xxxxxx).

  • :later_time (Time, DateTime, Date, Integer, String) —

    The time stamp that indicates a later time. If not specified, current time is taken.

  • :earlier_time (Time, DateTime, Date, Integer, String) —

    The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

  • :chronological_order (String) —

    The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

  • :limit (Integer) —

    The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3332
3333
3334
3335
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3332

def get_resource_config_history(params = {}, options = {})
  req = build_request(:get_resource_config_history, params)
  req.send_request(options)
end

#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse

Returns the details of a specific stored query.

Examples:

Request syntax with placeholder values


resp = client.get_stored_query({
  query_name: "QueryName", # required
})

Response structure


resp.stored_query.query_id #=> String
resp.stored_query.query_arn #=> String
resp.stored_query.query_name #=> String
resp.stored_query.description #=> String
resp.stored_query.expression #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_name (required, String) —

    The name of the query.

Returns:

See Also:



3364
3365
3366
3367
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3364

def get_stored_query(params = {}, options = {})
  req = build_request(:get_stored_query, params)
  req.send_request(options)
end

#list_aggregate_discovered_resources(params = {}) ⇒ Types::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.

Examples:

Request syntax with placeholder values


resp = client.list_aggregate_discovered_resources({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
  filters: {
    account_id: "AccountId",
    resource_id: "ResourceId",
    resource_name: "ResourceName",
    region: "AwsRegion",
  },
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.resource_identifiers #=> Array
resp.resource_identifiers[0]. #=> String
resp.resource_identifiers[0].source_region #=> String
resp.resource_identifiers[0].resource_id #=> String
resp.resource_identifiers[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.resource_identifiers[0].resource_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :resource_type (required, String) —

    The type of resources that you want AWS Config to list in the response.

  • :filters (Types::ResourceFilters) —

    Filters the results based on the ResourceFilters object.

  • :limit (Integer) —

    The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3435
3436
3437
3438
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3435

def list_aggregate_discovered_resources(params = {}, options = {})
  req = build_request(:list_aggregate_discovered_resources, params)
  req.send_request(options)
end

#list_discovered_resources(params = {}) ⇒ Types::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 AWS Config has discovered, including those that AWS 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, AWS 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.

Examples:

Request syntax with placeholder values


resp = client.list_discovered_resources({
  resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
  resource_ids: ["ResourceId"],
  resource_name: "ResourceName",
  limit: 1,
  include_deleted_resources: false,
  next_token: "NextToken",
})

Response structure


resp.resource_identifiers #=> Array
resp.resource_identifiers[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.resource_identifiers[0].resource_id #=> String
resp.resource_identifiers[0].resource_name #=> String
resp.resource_identifiers[0].resource_deletion_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The type of resources that you want AWS Config to list in the response.

  • :resource_ids (Array<String>) —

    The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

  • :resource_name (String) —

    The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

  • :limit (Integer) —

    The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

  • :include_deleted_resources (Boolean) —

    Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3515
3516
3517
3518
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3515

def list_discovered_resources(params = {}, options = {})
  req = build_request(:list_discovered_resources, params)
  req.send_request(options)
end

#list_stored_queries(params = {}) ⇒ Types::ListStoredQueriesResponse

Lists the stored queries for a single AWS account and a single AWS Region. The default is 100.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stored_queries({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.stored_query_metadata #=> Array
resp.stored_query_metadata[0].query_id #=> String
resp.stored_query_metadata[0].query_arn #=> String
resp.stored_query_metadata[0].query_name #=> String
resp.stored_query_metadata[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

  • :max_results (Integer) —

    The maximum number of results to be returned with a single call.

Returns:

See Also:



3557
3558
3559
3560
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3557

def list_stored_queries(params = {}, options = {})
  req = build_request(:list_stored_queries, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List the tags for AWS Config resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

  • :limit (Integer) —

    The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default.

  • :next_token (String) —

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

See Also:



3602
3603
3604
3605
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3602

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_aggregation_authorization(params = {}) ⇒ Types::PutAggregationAuthorizationResponse

Authorizes the aggregator account and region to collect data from the source account and region.

Examples:

Request syntax with placeholder values


resp = client.put_aggregation_authorization({
  authorized_account_id: "AccountId", # required
  authorized_aws_region: "AwsRegion", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.aggregation_authorization.aggregation_authorization_arn #=> String
resp.aggregation_authorization. #=> String
resp.aggregation_authorization.authorized_aws_region #=> String
resp.aggregation_authorization.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authorized_account_id (required, String) —

    The 12-digit account ID of the account authorized to aggregate data.

  • :authorized_aws_region (required, String) —

    The region authorized to collect aggregated data.

  • :tags (Array<Types::Tag>) —

    An array of tag object.

Returns:

See Also:



3647
3648
3649
3650
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3647

def put_aggregation_authorization(params = {}, options = {})
  req = build_request(:put_aggregation_authorization, params)
  req.send_request(options)
end

#put_config_rule(params = {}) ⇒ Struct

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS 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 AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config 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 AWS 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 AWS Config supports is 150.

For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_config_rule({
  config_rule: { # required
    config_rule_name: "ConfigRuleName",
    config_rule_arn: "StringWithCharLimit256",
    config_rule_id: "StringWithCharLimit64",
    description: "EmptiableStringWithCharLimit256",
    scope: {
      compliance_resource_types: ["StringWithCharLimit256"],
      tag_key: "StringWithCharLimit128",
      tag_value: "StringWithCharLimit256",
      compliance_resource_id: "BaseResourceId",
    },
    source: { # required
      owner: "CUSTOM_LAMBDA", # required, accepts CUSTOM_LAMBDA, AWS
      source_identifier: "StringWithCharLimit256", # required
      source_details: [
        {
          event_source: "aws.config", # accepts aws.config
          message_type: "ConfigurationItemChangeNotification", # accepts ConfigurationItemChangeNotification, ConfigurationSnapshotDeliveryCompleted, ScheduledNotification, OversizedConfigurationItemChangeNotification
          maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
        },
      ],
    },
    input_parameters: "StringWithCharLimit1024",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    config_rule_state: "ACTIVE", # accepts ACTIVE, DELETING, DELETING_RESULTS, EVALUATING
    created_by: "StringWithCharLimit256",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule (required, Types::ConfigRule) —

    The rule that you want to add to your account.

  • :tags (Array<Types::Tag>) —

    An array of tag object.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3746
3747
3748
3749
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3746

def put_config_rule(params = {}, options = {})
  req = build_request(:put_config_rule, params)
  req.send_request(options)
end

#put_configuration_aggregator(params = {}) ⇒ Types::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.

accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeAggregator to get the previous accounts and then append new ones.

AWS Config should be enabled in source accounts and regions you want to aggregate.

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, AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations. If the caller is a registered delegated administrator, AWS Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the AWS Config developer guide.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_aggregator({
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  account_aggregation_sources: [
    {
      account_ids: ["AccountId"], # required
      all_aws_regions: false,
      aws_regions: ["String"],
    },
  ],
  organization_aggregation_source: {
    role_arn: "String", # required
    aws_regions: ["String"],
    all_aws_regions: false,
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.configuration_aggregator.configuration_aggregator_name #=> String
resp.configuration_aggregator.configuration_aggregator_arn #=> String
resp.configuration_aggregator. #=> Array
resp.configuration_aggregator.[0]. #=> Array
resp.configuration_aggregator.[0].[0] #=> String
resp.configuration_aggregator.[0].all_aws_regions #=> Boolean
resp.configuration_aggregator.[0].aws_regions #=> Array
resp.configuration_aggregator.[0].aws_regions[0] #=> String
resp.configuration_aggregator.organization_aggregation_source.role_arn #=> String
resp.configuration_aggregator.organization_aggregation_source.aws_regions #=> Array
resp.configuration_aggregator.organization_aggregation_source.aws_regions[0] #=> String
resp.configuration_aggregator.organization_aggregation_source.all_aws_regions #=> Boolean
resp.configuration_aggregator.creation_time #=> Time
resp.configuration_aggregator.last_updated_time #=> Time
resp.configuration_aggregator.created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :account_aggregation_sources (Array<Types::AccountAggregationSource>) —

    A list of AccountAggregationSource object.

  • :organization_aggregation_source (Types::OrganizationAggregationSource) —

    An OrganizationAggregationSource object.

  • :tags (Array<Types::Tag>) —

    An array of tag object.

Returns:

See Also:



3843
3844
3845
3846
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3843

def put_configuration_aggregator(params = {}, options = {})
  req = build_request(:put_configuration_aggregator, params)
  req.send_request(options)
end

#put_configuration_recorder(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.put_configuration_recorder({
  configuration_recorder: { # required
    name: "RecorderName",
    role_arn: "String",
    recording_group: {
      all_supported: false,
      include_global_resource_types: false,
      resource_types: ["AWS::EC2::CustomerGateway"], # accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder (required, Types::ConfigurationRecorder) —

    The configuration recorder object that records each configuration change made to the resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3888
3889
3890
3891
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3888

def put_configuration_recorder(params = {}, options = {})
  req = build_request(:put_configuration_recorder, params)
  req.send_request(options)
end

#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse

Creates or updates a conformance pack. A conformance pack is a collection of AWS Config rules that can be easily deployed in an account and a region and across AWS 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 AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Examples:

Request syntax with placeholder values


resp = client.put_conformance_pack({
  conformance_pack_name: "ConformancePackName", # required
  template_s3_uri: "TemplateS3Uri",
  template_body: "TemplateBody",
  delivery_s3_bucket: "DeliveryS3Bucket",
  delivery_s3_key_prefix: "DeliveryS3KeyPrefix",
  conformance_pack_input_parameters: [
    {
      parameter_name: "ParameterName", # required
      parameter_value: "ParameterValue", # required
    },
  ],
})

Response structure


resp.conformance_pack_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conformance_pack_name (required, String) —

    Name of the conformance pack you want to create.

  • :template_s3_uri (String) —

    Location of file containing the template body (s3://bucketname/prefix). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.

    You must have access to read Amazon S3 bucket.

  • :template_body (String) —

    A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

    You can only use a YAML template with one resource type, that is, config rule and a remediation action.

  • :delivery_s3_bucket (String) —

    Amazon S3 bucket where AWS Config stores conformance pack templates.

    This field is optional.

  • :delivery_s3_key_prefix (String) —

    The prefix for the Amazon S3 bucket.

    This field is optional.

  • :conformance_pack_input_parameters (Array<Types::ConformancePackInputParameter>) —

    A list of ConformancePackInputParameter objects.

Returns:

See Also:



3975
3976
3977
3978
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3975

def put_conformance_pack(params = {}, options = {})
  req = build_request(:put_conformance_pack, params)
  req.send_request(options)
end

#put_delivery_channel(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.put_delivery_channel({
  delivery_channel: { # required
    name: "ChannelName",
    s3_bucket_name: "String",
    s3_key_prefix: "String",
    s3_kms_key_arn: "String",
    sns_topic_arn: "String",
    config_snapshot_delivery_properties: {
      delivery_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :delivery_channel (required, Types::DeliveryChannel) —

    The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4023
4024
4025
4026
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4023

def put_delivery_channel(params = {}, options = {})
  req = build_request(:put_delivery_channel, params)
  req.send_request(options)
end

#put_evaluations(params = {}) ⇒ Types::PutEvaluationsResponse

Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.

Examples:

Request syntax with placeholder values


resp = client.put_evaluations({
  evaluations: [
    {
      compliance_resource_type: "StringWithCharLimit256", # required
      compliance_resource_id: "BaseResourceId", # required
      compliance_type: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
      annotation: "StringWithCharLimit256",
      ordering_timestamp: Time.now, # required
    },
  ],
  result_token: "String", # required
  test_mode: false,
})

Response structure


resp.failed_evaluations #=> Array
resp.failed_evaluations[0].compliance_resource_type #=> String
resp.failed_evaluations[0].compliance_resource_id #=> String
resp.failed_evaluations[0].compliance_type #=> String, one of "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA"
resp.failed_evaluations[0].annotation #=> String
resp.failed_evaluations[0].ordering_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :evaluations (Array<Types::Evaluation>) —

    The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.

  • :result_token (required, String) —

    An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation.

  • :test_mode (Boolean) —

    Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.

    When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

Returns:

See Also:



4085
4086
4087
4088
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4085

def put_evaluations(params = {}, options = {})
  req = build_request(:put_evaluations, params)
  req.send_request(options)
end

#put_external_evaluation(params = {}) ⇒ Struct

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the AWS Config rule is provided.

Examples:

Request syntax with placeholder values


resp = client.put_external_evaluation({
  config_rule_name: "ConfigRuleName", # required
  external_evaluation: { # required
    compliance_resource_type: "StringWithCharLimit256", # required
    compliance_resource_id: "BaseResourceId", # required
    compliance_type: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
    annotation: "StringWithCharLimit256",
    ordering_timestamp: Time.now, # required
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule.

  • :external_evaluation (required, Types::ExternalEvaluation) —

    An ExternalEvaluation object that provides details about compliance.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4119
4120
4121
4122
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4119

def put_external_evaluation(params = {}, options = {})
  req = build_request(:put_external_evaluation, params)
  req.send_request(options)
end

#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse

Adds or updates organization config rule for your entire organization evaluating whether your AWS 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 AWS 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. AWS Config verifies the existence of role with GetRole action.

To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com.

You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier key.

The maximum number of organization config rules that AWS 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.

Examples:

Request syntax with placeholder values


resp = client.put_organization_config_rule({
  organization_config_rule_name: "OrganizationConfigRuleName", # required
  organization_managed_rule_metadata: {
    description: "StringWithCharLimit256Min0",
    rule_identifier: "StringWithCharLimit256", # required
    input_parameters: "StringWithCharLimit2048",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    resource_types_scope: ["StringWithCharLimit256"],
    resource_id_scope: "StringWithCharLimit768",
    tag_key_scope: "StringWithCharLimit128",
    tag_value_scope: "StringWithCharLimit256",
  },
  organization_custom_rule_metadata: {
    description: "StringWithCharLimit256Min0",
    lambda_function_arn: "StringWithCharLimit256", # required
    organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # required, accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification, ScheduledNotification
    input_parameters: "StringWithCharLimit2048",
    maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
    resource_types_scope: ["StringWithCharLimit256"],
    resource_id_scope: "StringWithCharLimit768",
    tag_key_scope: "StringWithCharLimit128",
    tag_value_scope: "StringWithCharLimit256",
  },
  excluded_accounts: ["AccountId"],
})

Response structure


resp.organization_config_rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_config_rule_name (required, String) —

    The name that you assign to an organization config rule.

  • :organization_managed_rule_metadata (Types::OrganizationManagedRuleMetadata) —

    An OrganizationManagedRuleMetadata object.

  • :organization_custom_rule_metadata (Types::OrganizationCustomRuleMetadata) —

    An OrganizationCustomRuleMetadata object.

  • :excluded_accounts (Array<String>) —

    A comma-separated list of accounts that you want to exclude from an organization config rule.

Returns:

See Also:



4219
4220
4221
4222
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4219

def put_organization_config_rule(params = {}, options = {})
  req = build_request(:put_organization_config_rule, params)
  req.send_request(options)
end

#put_organization_conformance_pack(params = {}) ⇒ Types::PutOrganizationConformancePackResponse

Deploys conformance packs across member accounts in an AWS Organization.

Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure AWS 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 AWS Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

AWS 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.

You can create 50 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

Examples:

Request syntax with placeholder values


resp = client.put_organization_conformance_pack({
  organization_conformance_pack_name: "OrganizationConformancePackName", # required
  template_s3_uri: "TemplateS3Uri",
  template_body: "TemplateBody",
  delivery_s3_bucket: "DeliveryS3Bucket",
  delivery_s3_key_prefix: "DeliveryS3KeyPrefix",
  conformance_pack_input_parameters: [
    {
      parameter_name: "ParameterName", # required
      parameter_value: "ParameterValue", # required
    },
  ],
  excluded_accounts: ["AccountId"],
})

Response structure


resp.organization_conformance_pack_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :organization_conformance_pack_name (required, String) —

    Name of the organization conformance pack you want to create.

  • :template_s3_uri (String) —

    Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

    You must have access to read Amazon S3 bucket.

  • :template_body (String) —

    A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

  • :delivery_s3_bucket (String) —

    Amazon S3 bucket where AWS Config stores conformance pack templates.

    This field is optional. If used, it must be prefixed with awsconfigconforms.

  • :delivery_s3_key_prefix (String) —

    The prefix for the Amazon S3 bucket.

    This field is optional.

  • :conformance_pack_input_parameters (Array<Types::ConformancePackInputParameter>) —

    A list of ConformancePackInputParameter objects.

  • :excluded_accounts (Array<String>) —

    A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.

Returns:

See Also:



4325
4326
4327
4328
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4325

def put_organization_conformance_pack(params = {}, options = {})
  req = build_request(:put_organization_conformance_pack, params)
  req.send_request(options)
end

#put_remediation_configurations(params = {}) ⇒ Types::PutRemediationConfigurationsResponse

Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS 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 AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

Examples:

Request syntax with placeholder values


resp = client.put_remediation_configurations({
  remediation_configurations: [ # required
    {
      config_rule_name: "ConfigRuleName", # required
      target_type: "SSM_DOCUMENT", # required, accepts SSM_DOCUMENT
      target_id: "StringWithCharLimit256", # required
      target_version: "String",
      parameters: {
        "StringWithCharLimit256" => {
          resource_value: {
            value: "RESOURCE_ID", # required, accepts RESOURCE_ID
          },
          static_value: {
            values: ["StringWithCharLimit256"], # required
          },
        },
      },
      resource_type: "String",
      automatic: false,
      execution_controls: {
        ssm_controls: {
          concurrent_execution_rate_percentage: 1,
          error_percentage: 1,
        },
      },
      maximum_automatic_attempts: 1,
      retry_attempt_seconds: 1,
      arn: "StringWithCharLimit1024",
      created_by_service: "StringWithCharLimit1024",
    },
  ],
})

Response structure


resp.failed_batches #=> Array
resp.failed_batches[0].failure_message #=> String
resp.failed_batches[0].failed_items #=> Array
resp.failed_batches[0].failed_items[0].config_rule_name #=> String
resp.failed_batches[0].failed_items[0].target_type #=> String, one of "SSM_DOCUMENT"
resp.failed_batches[0].failed_items[0].target_id #=> String
resp.failed_batches[0].failed_items[0].target_version #=> String
resp.failed_batches[0].failed_items[0].parameters #=> Hash
resp.failed_batches[0].failed_items[0].parameters["StringWithCharLimit256"].resource_value.value #=> String, one of "RESOURCE_ID"
resp.failed_batches[0].failed_items[0].parameters["StringWithCharLimit256"].static_value.values #=> Array
resp.failed_batches[0].failed_items[0].parameters["StringWithCharLimit256"].static_value.values[0] #=> String
resp.failed_batches[0].failed_items[0].resource_type #=> String
resp.failed_batches[0].failed_items[0].automatic #=> Boolean
resp.failed_batches[0].failed_items[0].execution_controls.ssm_controls.concurrent_execution_rate_percentage #=> Integer
resp.failed_batches[0].failed_items[0].execution_controls.ssm_controls.error_percentage #=> Integer
resp.failed_batches[0].failed_items[0].maximum_automatic_attempts #=> Integer
resp.failed_batches[0].failed_items[0].retry_attempt_seconds #=> Integer
resp.failed_batches[0].failed_items[0].arn #=> String
resp.failed_batches[0].failed_items[0].created_by_service #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



4415
4416
4417
4418
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4415

def put_remediation_configurations(params = {}, options = {})
  req = build_request(:put_remediation_configurations, params)
  req.send_request(options)
end

#put_remediation_exceptions(params = {}) ⇒ Types::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 AWS Config rule.

AWS 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.

Examples:

Request syntax with placeholder values


resp = client.put_remediation_exceptions({
  config_rule_name: "ConfigRuleName", # required
  resource_keys: [ # required
    {
      resource_type: "StringWithCharLimit256",
      resource_id: "StringWithCharLimit1024",
    },
  ],
  message: "StringWithCharLimit1024",
  expiration_time: Time.now,
})

Response structure


resp.failed_batches #=> Array
resp.failed_batches[0].failure_message #=> String
resp.failed_batches[0].failed_items #=> Array
resp.failed_batches[0].failed_items[0].config_rule_name #=> String
resp.failed_batches[0].failed_items[0].resource_type #=> String
resp.failed_batches[0].failed_items[0].resource_id #=> String
resp.failed_batches[0].failed_items[0].message #=> String
resp.failed_batches[0].failed_items[0].expiration_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The name of the AWS Config rule for which you want to create remediation exception.

  • :resource_keys (required, Array<Types::RemediationExceptionResourceKey>) —

    An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

  • :message (String) —

    The message contains an explanation of the exception.

  • :expiration_time (Time, DateTime, Date, Integer, String) —

    The exception is automatically deleted after the expiration date.

Returns:

See Also:



4479
4480
4481
4482
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4479

def put_remediation_exceptions(params = {}, options = {})
  req = build_request(:put_remediation_exceptions, params)
  req.send_request(options)
end

#put_resource_config(params = {}) ⇒ Struct

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in AWS 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 AWS Config APIs.

The custom resource type must be registered with AWS CloudFormation. This API accepts the configuration item registered with AWS CloudFormation.

When you call this API, AWS Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

Examples:

Request syntax with placeholder values


resp = client.put_resource_config({
  resource_type: "ResourceTypeString", # required
  schema_version_id: "SchemaVersionId", # required
  resource_id: "ResourceId", # required
  resource_name: "ResourceName",
  configuration: "Configuration", # required
  tags: {
    "Name" => "Value",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_type (required, String) —

    The type of the resource. The custom resource type must be registered with AWS CloudFormation.

    You cannot use the organization names “aws”, “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

  • :schema_version_id (required, String) —

    Version of the schema registered for the ResourceType in AWS CloudFormation.

  • :resource_id (required, String) —

    Unique identifier of the resource.

  • :resource_name (String) —

    Name of the resource.

  • :configuration (required, String) —

    The configuration object of the resource in valid JSON format. It must match the schema registered with AWS CloudFormation.

    The configuration JSON must not exceed 64 KB.

  • :tags (Hash<String,String>) —

    Tags associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4553
4554
4555
4556
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4553

def put_resource_config(params = {}, options = {})
  req = build_request(:put_resource_config, params)
  req.send_request(options)
end

#put_retention_configuration(params = {}) ⇒ Types::PutRetentionConfigurationResponse

Creates and updates the retention configuration with details about retention period (number of days) that AWS 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, AWS Config supports only one retention configuration per region in your account.

Examples:

Request syntax with placeholder values


resp = client.put_retention_configuration({
  retention_period_in_days: 1, # required
})

Response structure


resp.retention_configuration.name #=> String
resp.retention_configuration.retention_period_in_days #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :retention_period_in_days (required, Integer) —

    Number of days AWS Config stores your historical information.

    Currently, only applicable to the configuration item history.

Returns:

See Also:



4596
4597
4598
4599
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4596

def put_retention_configuration(params = {}, options = {})
  req = build_request(:put_retention_configuration, params)
  req.send_request(options)
end

#put_stored_query(params = {}) ⇒ Types::PutStoredQueryResponse

Saves a new query or updates an existing saved query. The QueryName must be unique for a single AWS account and a single AWS Region. You can create upto 300 queries in a single AWS account and a single AWS Region.

Examples:

Request syntax with placeholder values


resp = client.put_stored_query({
  stored_query: { # required
    query_id: "QueryId",
    query_arn: "QueryArn",
    query_name: "QueryName", # required
    description: "QueryDescription",
    expression: "QueryExpression",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.query_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stored_query (required, Types::StoredQuery) —

    A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

    When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.

  • :tags (Array<Types::Tag>) —

    A list of Tags object.

Returns:

See Also:



4649
4650
4651
4652
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4649

def put_stored_query(params = {}, options = {})
  req = build_request(:put_stored_query, params)
  req.send_request(options)
end

#select_aggregate_resource_config(params = {}) ⇒ Types::SelectAggregateResourceConfigResponse

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS 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 AWS Config Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.select_aggregate_resource_config({
  expression: "Expression", # required
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  limit: 1,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.results #=> Array
resp.results[0] #=> String
resp.query_info.select_fields #=> Array
resp.query_info.select_fields[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :expression (required, String) —

    The SQL query SELECT command.

  • :configuration_aggregator_name (required, String) —

    The name of the configuration aggregator.

  • :limit (Integer) —

    The maximum number of query results returned on each page.

  • :max_results (Integer) —

    The maximum number of query results returned on each page. AWS Config also allows the Limit request parameter.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



4713
4714
4715
4716
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4713

def select_aggregate_resource_config(params = {}, options = {})
  req = build_request(:select_aggregate_resource_config, params)
  req.send_request(options)
end

#select_resource_config(params = {}) ⇒ Types::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 AWS Config Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.select_resource_config({
  expression: "Expression", # required
  limit: 1,
  next_token: "NextToken",
})

Response structure


resp.results #=> Array
resp.results[0] #=> String
resp.query_info.select_fields #=> Array
resp.query_info.select_fields[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :expression (required, String) —

    The SQL query SELECT command.

  • :limit (Integer) —

    The maximum number of query results returned on each page.

  • :next_token (String) —

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Returns:

See Also:



4765
4766
4767
4768
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4765

def select_resource_config(params = {}, options = {})
  req = build_request(:select_resource_config, params)
  req.send_request(options)
end

#start_config_rules_evaluation(params = {}) ⇒ Struct

Runs an on-demand evaluation for the specified AWS 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 AWS Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Examples:

Request syntax with placeholder values


resp = client.start_config_rules_evaluation({
  config_rule_names: ["ConfigRuleName"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_names (Array<String>) —

    The list of names of AWS Config rules that you want to run evaluations for.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4824
4825
4826
4827
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4824

def start_config_rules_evaluation(params = {}, options = {})
  req = build_request(:start_config_rules_evaluation, params)
  req.send_request(options)
end

#start_configuration_recorder(params = {}) ⇒ Struct

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

You must have created at least one delivery channel to successfully start the configuration recorder.

Examples:

Request syntax with placeholder values


resp = client.start_configuration_recorder({
  configuration_recorder_name: "RecorderName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder_name (required, String) —

    The name of the recorder object that records each configuration change made to the resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4851
4852
4853
4854
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4851

def start_configuration_recorder(params = {}, options = {})
  req = build_request(:start_configuration_recorder, params)
  req.send_request(options)
end

#start_remediation_execution(params = {}) ⇒ Types::StartRemediationExecutionResponse

Runs an on-demand remediation for the specified AWS 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.

Examples:

Request syntax with placeholder values


resp = client.start_remediation_execution({
  config_rule_name: "ConfigRuleName", # required
  resource_keys: [ # required
    {
      resource_type: "AWS::EC2::CustomerGateway", # required, accepts AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Host, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::EC2::RegisteredHAInstance, AWS::EC2::NatGateway, AWS::EC2::EgressOnlyInternetGateway, AWS::EC2::VPCEndpoint, AWS::EC2::VPCEndpointService, AWS::EC2::FlowLog, AWS::EC2::VPCPeeringConnection, AWS::Elasticsearch::Domain, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ACM::Certificate, AWS::RDS::DBInstance, AWS::RDS::DBSubnetGroup, AWS::RDS::DBSecurityGroup, AWS::RDS::DBSnapshot, AWS::RDS::DBCluster, AWS::RDS::DBClusterSnapshot, AWS::RDS::EventSubscription, AWS::S3::Bucket, AWS::S3::AccountPublicAccessBlock, AWS::Redshift::Cluster, AWS::Redshift::ClusterSnapshot, AWS::Redshift::ClusterParameterGroup, AWS::Redshift::ClusterSecurityGroup, AWS::Redshift::ClusterSubnetGroup, AWS::Redshift::EventSubscription, AWS::SSM::ManagedInstanceInventory, AWS::CloudWatch::Alarm, AWS::CloudFormation::Stack, AWS::ElasticLoadBalancing::LoadBalancer, AWS::AutoScaling::AutoScalingGroup, AWS::AutoScaling::LaunchConfiguration, AWS::AutoScaling::ScalingPolicy, AWS::AutoScaling::ScheduledAction, AWS::DynamoDB::Table, AWS::CodeBuild::Project, AWS::WAF::RateBasedRule, AWS::WAF::Rule, AWS::WAF::RuleGroup, AWS::WAF::WebACL, AWS::WAFRegional::RateBasedRule, AWS::WAFRegional::Rule, AWS::WAFRegional::RuleGroup, AWS::WAFRegional::WebACL, AWS::CloudFront::Distribution, AWS::CloudFront::StreamingDistribution, AWS::Lambda::Function, AWS::NetworkFirewall::Firewall, AWS::NetworkFirewall::FirewallPolicy, AWS::NetworkFirewall::RuleGroup, AWS::ElasticBeanstalk::Application, AWS::ElasticBeanstalk::ApplicationVersion, AWS::ElasticBeanstalk::Environment, AWS::WAFv2::WebACL, AWS::WAFv2::RuleGroup, AWS::WAFv2::IPSet, AWS::WAFv2::RegexPatternSet, AWS::WAFv2::ManagedRuleSet, AWS::XRay::EncryptionConfig, AWS::SSM::AssociationCompliance, AWS::SSM::PatchCompliance, AWS::Shield::Protection, AWS::ShieldRegional::Protection, AWS::Config::ConformancePackCompliance, AWS::Config::ResourceCompliance, AWS::ApiGateway::Stage, AWS::ApiGateway::RestApi, AWS::ApiGatewayV2::Stage, AWS::ApiGatewayV2::Api, AWS::CodePipeline::Pipeline, AWS::ServiceCatalog::CloudFormationProvisionedProduct, AWS::ServiceCatalog::CloudFormationProduct, AWS::ServiceCatalog::Portfolio, AWS::SQS::Queue, AWS::KMS::Key, AWS::QLDB::Ledger, AWS::SecretsManager::Secret, AWS::SNS::Topic, AWS::SSM::FileData
      resource_id: "ResourceId", # required
    },
  ],
})

Response structure


resp.failure_message #=> String
resp.failed_items #=> Array
resp.failed_items[0].resource_type #=> String, one of "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::EC2::RegisteredHAInstance", "AWS::EC2::NatGateway", "AWS::EC2::EgressOnlyInternetGateway", "AWS::EC2::VPCEndpoint", "AWS::EC2::VPCEndpointService", "AWS::EC2::FlowLog", "AWS::EC2::VPCPeeringConnection", "AWS::Elasticsearch::Domain", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::DBCluster", "AWS::RDS::DBClusterSnapshot", "AWS::RDS::EventSubscription", "AWS::S3::Bucket", "AWS::S3::AccountPublicAccessBlock", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription", "AWS::SSM::ManagedInstanceInventory", "AWS::CloudWatch::Alarm", "AWS::CloudFormation::Stack", "AWS::ElasticLoadBalancing::LoadBalancer", "AWS::AutoScaling::AutoScalingGroup", "AWS::AutoScaling::LaunchConfiguration", "AWS::AutoScaling::ScalingPolicy", "AWS::AutoScaling::ScheduledAction", "AWS::DynamoDB::Table", "AWS::CodeBuild::Project", "AWS::WAF::RateBasedRule", "AWS::WAF::Rule", "AWS::WAF::RuleGroup", "AWS::WAF::WebACL", "AWS::WAFRegional::RateBasedRule", "AWS::WAFRegional::Rule", "AWS::WAFRegional::RuleGroup", "AWS::WAFRegional::WebACL", "AWS::CloudFront::Distribution", "AWS::CloudFront::StreamingDistribution", "AWS::Lambda::Function", "AWS::NetworkFirewall::Firewall", "AWS::NetworkFirewall::FirewallPolicy", "AWS::NetworkFirewall::RuleGroup", "AWS::ElasticBeanstalk::Application", "AWS::ElasticBeanstalk::ApplicationVersion", "AWS::ElasticBeanstalk::Environment", "AWS::WAFv2::WebACL", "AWS::WAFv2::RuleGroup", "AWS::WAFv2::IPSet", "AWS::WAFv2::RegexPatternSet", "AWS::WAFv2::ManagedRuleSet", "AWS::XRay::EncryptionConfig", "AWS::SSM::AssociationCompliance", "AWS::SSM::PatchCompliance", "AWS::Shield::Protection", "AWS::ShieldRegional::Protection", "AWS::Config::ConformancePackCompliance", "AWS::Config::ResourceCompliance", "AWS::ApiGateway::Stage", "AWS::ApiGateway::RestApi", "AWS::ApiGatewayV2::Stage", "AWS::ApiGatewayV2::Api", "AWS::CodePipeline::Pipeline", "AWS::ServiceCatalog::CloudFormationProvisionedProduct", "AWS::ServiceCatalog::CloudFormationProduct", "AWS::ServiceCatalog::Portfolio", "AWS::SQS::Queue", "AWS::KMS::Key", "AWS::QLDB::Ledger", "AWS::SecretsManager::Secret", "AWS::SNS::Topic", "AWS::SSM::FileData"
resp.failed_items[0].resource_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_rule_name (required, String) —

    The list of names of AWS Config rules that you want to run remediation execution for.

  • :resource_keys (required, Array<Types::ResourceKey>) —

    A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Returns:

See Also:



4901
4902
4903
4904
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4901

def start_remediation_execution(params = {}, options = {})
  req = build_request(:start_remediation_execution, params)
  req.send_request(options)
end

#stop_configuration_recorder(params = {}) ⇒ Struct

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Examples:

Request syntax with placeholder values


resp = client.stop_configuration_recorder({
  configuration_recorder_name: "RecorderName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_recorder_name (required, String) —

    The name of the recorder object that records each configuration change made to the resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4925
4926
4927
4928
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4925

def stop_configuration_recorder(params = {}, options = {})
  req = build_request(:stop_configuration_recorder, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

  • :tags (required, Array<Types::Tag>) —

    An array of tag object.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4961
4962
4963
4964
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4961

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

  • :tag_keys (required, Array<String>) —

    The keys of the tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4989
4990
4991
4992
 
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4989

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end