configservice: AWS Config

Description Usage Arguments Value Service syntax Operations Examples

View source: R/configservice_service.R

Description

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config. This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config in the AWS Config Developer Guide.

Usage

1
configservice(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- configservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_get_aggregate_resource_config Returns the current configuration items for resources that are present in your AWS Config aggregator
batch_get_resource_config Returns the current configuration for one or more requested resources
delete_aggregation_authorization Deletes the authorization granted to the specified configuration aggregator account in a specified region
delete_config_rule Deletes the specified AWS Config rule and all of its evaluation results
delete_configuration_aggregator Deletes the specified configuration aggregator and the aggregated data associated with the aggregator
delete_configuration_recorder Deletes the configuration recorder
delete_conformance_pack Deletes the specified conformance pack and all the AWS Config rules, remediation actions, and all evaluation results within that conformance pack
delete_delivery_channel Deletes the delivery channel
delete_evaluation_results Deletes the evaluation results for the specified AWS Config rule
delete_organization_config_rule Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization
delete_organization_conformance_pack Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization
delete_pending_aggregation_request Deletes pending authorization requests for a specified aggregator account in a specified region
delete_remediation_configuration Deletes the remediation configuration
delete_remediation_exceptions Deletes one or more remediation exceptions mentioned in the resource keys
delete_resource_config Records the configuration state for a custom resource that has been deleted
delete_retention_configuration Deletes the retention configuration
delete_stored_query Deletes the stored query for an AWS account in an AWS Region
deliver_config_snapshot Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel
describe_aggregate_compliance_by_config_rules Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules
describe_aggregation_authorizations Returns a list of authorizations granted to various aggregator accounts and regions
describe_compliance_by_config_rule Indicates whether the specified AWS Config rules are compliant
describe_compliance_by_resource Indicates whether the specified AWS resources are compliant
describe_config_rule_evaluation_status Returns status information for each of your AWS managed Config rules
describe_config_rules Returns details about your AWS Config rules
describe_configuration_aggregators Returns the details of one or more configuration aggregators
describe_configuration_aggregator_sources_status Returns status information for sources within an aggregator
describe_configuration_recorders Returns the details for the specified configuration recorders
describe_configuration_recorder_status Returns the current status of the specified configuration recorder
describe_conformance_pack_compliance Returns compliance details for each rule in that conformance pack
describe_conformance_packs Returns a list of one or more conformance packs
describe_conformance_pack_status Provides one or more conformance packs deployment status
describe_delivery_channels Returns details about the specified delivery channel
describe_delivery_channel_status Returns the current status of the specified delivery channel
describe_organization_config_rules Returns a list of organization config rules
describe_organization_config_rule_statuses Provides organization config rule deployment status for an organization
describe_organization_conformance_packs Returns a list of organization conformance packs
describe_organization_conformance_pack_statuses Provides organization conformance pack deployment status for an organization
describe_pending_aggregation_requests Returns a list of all pending aggregation requests
describe_remediation_configurations Returns the details of one or more remediation configurations
describe_remediation_exceptions Returns the details of one or more remediation exceptions
describe_remediation_execution_status 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
describe_retention_configurations Returns the details of one or more retention configurations
get_aggregate_compliance_details_by_config_rule Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule
get_aggregate_config_rule_compliance_summary Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator
get_aggregate_discovered_resource_counts Returns the resource counts across accounts and regions that are present in your AWS Config aggregator
get_aggregate_resource_config Returns configuration item that is aggregated for your specific resource in a specific source account and region
get_compliance_details_by_config_rule Returns the evaluation results for the specified AWS Config rule
get_compliance_details_by_resource Returns the evaluation results for the specified AWS resource
get_compliance_summary_by_config_rule Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each
get_compliance_summary_by_resource_type Returns the number of resources that are compliant and the number that are noncompliant
get_conformance_pack_compliance_details Returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack
get_conformance_pack_compliance_summary Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack
get_discovered_resource_counts 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
get_organization_config_rule_detailed_status Returns detailed status for each member account within an organization for a given organization config rule
get_organization_conformance_pack_detailed_status Returns detailed status for each member account within an organization for a given organization conformance pack
get_resource_config_history Returns a list of configuration items for the specified resource
get_stored_query Returns the details of a specific stored query
list_aggregate_discovered_resources Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions
list_discovered_resources Accepts a resource type and returns a list of resource identifiers for the resources of that type
list_stored_queries List the stored queries for an AWS account in an AWS Region
list_tags_for_resource List the tags for AWS Config resource
put_aggregation_authorization Authorizes the aggregator account and region to collect data from the source account and region
put_config_rule Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations
put_configuration_aggregator Creates and updates the configuration aggregator with the selected source accounts and regions
put_configuration_recorder Creates a new configuration recorder to record the selected resource configurations
put_conformance_pack Creates or updates a conformance pack
put_delivery_channel Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic
put_evaluations Used by an AWS Lambda function to deliver evaluation results to AWS Config
put_external_evaluation Put external evaluation
put_organization_config_rule Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations
put_organization_conformance_pack Deploys conformance packs across member accounts in an AWS Organization
put_remediation_configurations Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action
put_remediation_exceptions A remediation exception is when a specific resource is no longer considered for auto-remediation
put_resource_config Records the configuration state for the resource provided in the request
put_retention_configuration Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information
put_stored_query Saves a new query or updates an existing saved query
select_aggregate_resource_config 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
select_resource_config Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties
start_config_rules_evaluation Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources
start_configuration_recorder Starts recording configurations of the AWS resources you have selected to record in your AWS account
start_remediation_execution Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration
stop_configuration_recorder Stops recording configurations of the AWS resources you have selected to record in your AWS account
tag_resource Associates the specified tags to a resource with the specified resourceArn
untag_resource Deletes specified tags from a resource

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- configservice()
svc$batch_get_aggregate_resource_config(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.