Client

configservice

R Documentation

AWS Config¶

Description¶

Config

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

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

Usage¶

configservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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¶

svc <- configservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_get_aggregate_resource_config: Returns the current configuration items for resources that are present in your Config aggregator
batch_get_resource_config: Returns the BaseConfigurationItem 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 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 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 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 a single Amazon Web Services account and a single Amazon Web Services Region
deliver_config_snapshot: Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel; Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules; Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack
describe_aggregation_authorizations: Returns a list of authorizations granted to various aggregator accounts and regions
describe_compliance_by_config_rule: Indicates whether the specified Config rules are compliant
describe_compliance_by_resource: Indicates whether the specified Amazon Web Services resources are compliant; Returns status information for each of your Config managed rules
describe_config_rules: Returns details about your Config rules
describe_configuration_aggregators: Returns the details of one or more configuration aggregators; Returns status information for sources within an aggregator
describe_configuration_recorders: Returns the details for the specified configuration recorders; Returns the current status of the specified configuration recorder as well as the status of the last recording event for the 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; Provides organization Config rule deployment status for an organization; Returns a list of organization conformance packs; 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; Returns the evaluation results for the specified Config rule for a specific resource in a rule; Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator; Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator; Returns the resource counts across accounts and regions that are present in your 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 Config rule
get_compliance_details_by_resource: Returns the evaluation results for the specified Amazon Web Services resource
get_compliance_summary_by_config_rule: Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each; Returns the number of resources that are compliant and the number that are noncompliant; Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack; Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack
get_custom_rule_policy: Returns the policy definition containing the logic for your Config Custom Policy rule
get_discovered_resource_counts: Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account; Returns detailed status for each member account within an organization for a given organization Config rule; Returns detailed status for each member account within an organization for a given organization conformance pack
get_organization_custom_rule_policy: Returns the policy definition containing the logic for your organization Config Custom Policy rule
get_resource_config_history: For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type
get_resource_evaluation_summary: Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run
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; Returns a list of conformance pack compliance scores
list_discovered_resources: Accepts a resource type and returns a list of resource identifiers for the resources of that type
list_resource_evaluations: Returns a list of proactive resource evaluations
list_stored_queries: Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region
list_tags_for_resource: List the tags for 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 Config rule to evaluate if your Amazon Web Services 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 configuration changes for specified resource types
put_conformance_pack: Creates or updates a conformance pack
put_delivery_channel: Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic
put_evaluations: Used by an Lambda function to deliver evaluation results to Config
put_external_evaluation: Add or updates the evaluations for process checks
put_organization_config_rule: Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations
put_organization_conformance_pack: Deploys conformance packs across member accounts in an Amazon Web Services Organization
put_remediation_configurations: Adds or updates the remediation configuration with a specific Config rule with the selected target or action
put_remediation_exceptions: A remediation exception is when a specified 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 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 Amazon Web Services 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 Config rules against the last known configuration state of the resources
start_configuration_recorder: Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account
start_remediation_execution: Runs an on-demand remediation for the specified Config rules against the last known remediation configuration
start_resource_evaluation: Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules
stop_configuration_recorder: Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account
tag_resource: Associates the specified tags to a resource with the specified resourceArn
untag_resource: Deletes specified tags from a resource

Examples¶

## Not run: 
svc <- configservice()
svc$batch_get_aggregate_resource_config(
  Foo = 123
)

## End(Not run)