ExAws.AWS.Config.Core

AWS Config

AWS Config

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.

Source

Summary

delete_delivery_channel!(client, input)

Same as delete_delivery_channel/2 but raise on error

delete_delivery_channel(client, input)

DeleteDeliveryChannel

deliver_config_snapshot!(client, input)

Same as deliver_config_snapshot/2 but raise on error

deliver_config_snapshot(client, input)

DeliverConfigSnapshot

describe_configuration_recorder_status!(client, input)

Same as describe_configuration_recorder_status/2 but raise on error

describe_configuration_recorder_status(client, input)

DescribeConfigurationRecorderStatus

describe_configuration_recorders!(client, input)

Same as describe_configuration_recorders/2 but raise on error

describe_configuration_recorders(client, input)

DescribeConfigurationRecorders

describe_delivery_channel_status!(client, input)

Same as describe_delivery_channel_status/2 but raise on error

describe_delivery_channel_status(client, input)

DescribeDeliveryChannelStatus

describe_delivery_channels!(client, input)

Same as describe_delivery_channels/2 but raise on error

describe_delivery_channels(client, input)

DescribeDeliveryChannels

get_resource_config_history!(client, input)

Same as get_resource_config_history/2 but raise on error

get_resource_config_history(client, input)

GetResourceConfigHistory

list_discovered_resources!(client, input)

Same as list_discovered_resources/2 but raise on error

list_discovered_resources(client, input)

ListDiscoveredResources

put_configuration_recorder!(client, input)

Same as put_configuration_recorder/2 but raise on error

put_configuration_recorder(client, input)

PutConfigurationRecorder

put_delivery_channel!(client, input)

Same as put_delivery_channel/2 but raise on error

put_delivery_channel(client, input)

PutDeliveryChannel

start_configuration_recorder!(client, input)

Same as start_configuration_recorder/2 but raise on error

start_configuration_recorder(client, input)

StartConfigurationRecorder

stop_configuration_recorder!(client, input)

Same as stop_configuration_recorder/2 but raise on error

stop_configuration_recorder(client, input)

StopConfigurationRecorder

Types

resource_type :: binary

channel_name :: binary

list_discovered_resources_request :: [include_deleted_resources: boolean, limit: limit, next_token: next_token, resource_ids: resource_id_list, resource_name: resource_name, resource_type: resource_type]

arn :: binary

account_id :: binary

name :: binary

limit :: integer

stop_configuration_recorder_request :: [{:configuration_recorder_name, recorder_name}]

related_event :: binary

delivery_channel_status :: [config_history_delivery_info: config_export_delivery_info, config_snapshot_delivery_info: config_export_delivery_info, config_stream_delivery_info: config_stream_delivery_info, name: binary]

recording_group :: [all_supported: all_supported, resource_types: resource_type_list]

version :: binary

date :: integer

earlier_time :: integer

tags :: [{name, value}]

configuration_item :: [account_id: account_id, arn: arn, availability_zone: availability_zone, aws_region: aws_region, configuration: configuration, configuration_item_capture_time: configuration_item_capture_time, configuration_item_m_d5_hash: configuration_item_m_d5_hash, configuration_item_status: configuration_item_status, configuration_state_id: configuration_state_id, related_events: related_event_list, relationships: relationship_list, resource_creation_time: resource_creation_time, resource_id: resource_id, resource_name: resource_name, resource_type: resource_type, tags: tags, version: version]

relationship :: [relationship_name: relationship_name, resource_id: resource_id, resource_name: resource_name, resource_type: resource_type]

availability_zone :: binary

config_stream_delivery_info :: [last_error_code: binary, last_error_message: binary, last_status: delivery_status, last_status_change_time: date]

later_time :: integer

recorder_name :: binary

resource_id :: binary

deliver_config_snapshot_response :: [{:config_snapshot_id, binary}]

relationship_name :: binary

value :: binary

get_resource_config_history_request :: [chronological_order: chronological_order, earlier_time: earlier_time, later_time: later_time, limit: limit, next_token: next_token, resource_id: resource_id, resource_type: resource_type]

delivery_channel :: [name: channel_name, s3_bucket_name: binary, s3_key_prefix: binary, sns_topic_arn: binary]

config_export_delivery_info :: [last_attempt_time: date, last_error_code: binary, last_error_message: binary, last_status: delivery_status, last_successful_time: date]

configuration_recorder_status :: [last_error_code: binary, last_error_message: binary, last_start_time: date, last_status: recorder_status, last_status_change_time: date, last_stop_time: date, name: binary, recording: boolean]

deliver_config_snapshot_request :: [{:delivery_channel_name, channel_name}]

all_supported :: boolean

start_configuration_recorder_request :: [{:configuration_recorder_name, recorder_name}]

delete_delivery_channel_request :: [{:delivery_channel_name, channel_name}]

configuration_recorder :: [name: recorder_name, recording_group: recording_group, role_arn: binary]

recorder_status :: binary

resource_name :: binary

delivery_status :: binary

configuration :: binary

next_token :: binary

aws_region :: binary

resource_identifier :: [resource_deletion_time: resource_deletion_time, resource_id: resource_id, resource_name: resource_name, resource_type: resource_type]

Functions

delete_delivery_channel(client, input)

Specs:

DeleteDeliveryChannel

Deletes the specified delivery channel.

The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.

Source
delete_delivery_channel!(client, input)

Specs:

Same as delete_delivery_channel/2 but raise on error.

Source
deliver_config_snapshot(client, input)

Specs:

DeliverConfigSnapshot

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.

  • Notification of starting the delivery.

  • Notification of delivery completed, if the delivery was successfully completed.

  • Notification of delivery failure, if the delivery failed to complete.
Source
deliver_config_snapshot!(client, input)

Specs:

Same as deliver_config_snapshot/2 but raise on error.

Source
describe_configuration_recorder_status(client, input)

Specs:

DescribeConfigurationRecorderStatus

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

Note:Currently, you can specify only one configuration recorder per account.

Source
describe_configuration_recorder_status!(client, input)

Specs:

Same as describe_configuration_recorder_status/2 but raise on error.

Source
describe_configuration_recorders(client, input)

Specs:

DescribeConfigurationRecorders

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

Note: Currently, you can specify only one configuration recorder per account.

Source
describe_configuration_recorders!(client, input)

Specs:

Same as describe_configuration_recorders/2 but raise on error.

Source
describe_delivery_channel_status(client, input)

Specs:

DescribeDeliveryChannelStatus

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.

Note:Currently, you can specify only one delivery channel per account.

Source
describe_delivery_channel_status!(client, input)

Specs:

Same as describe_delivery_channel_status/2 but raise on error.

Source
describe_delivery_channels(client, input)

Specs:

DescribeDeliveryChannels

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.

Note: Currently, you can specify only one delivery channel per account.

Source
describe_delivery_channels!(client, input)

Specs:

Same as describe_delivery_channels/2 but raise on error.

Source
get_resource_config_history(client, input)

Specs:

GetResourceConfigHistory

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.

The response is paginated, and 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, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Note: 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.

Source
get_resource_config_history!(client, input)

Specs:

Same as get_resource_config_history/2 but raise on error.

Source
list_discovered_resources(client, input)

Specs:

ListDiscoveredResources

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.

Note:You can specify either resource IDs or a resource name but not both in the same request. The response is paginated, and 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, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Source
list_discovered_resources!(client, input)

Specs:

Same as list_discovered_resources/2 but raise on error.

Source
put_configuration_recorder(client, input)

Specs:

PutConfigurationRecorder

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Note: Currently, you can specify only one configuration recorder per account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Source
put_configuration_recorder!(client, input)

Specs:

Same as put_configuration_recorder/2 but raise on error.

Source
put_delivery_channel(client, input)

Specs:

PutDeliveryChannel

Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.

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.

Note: Currently, you can specify only one delivery channel per account.

Source
put_delivery_channel!(client, input)

Specs:

Same as put_delivery_channel/2 but raise on error.

Source
start_configuration_recorder(client, input)

Specs:

StartConfigurationRecorder

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.

Source
start_configuration_recorder!(client, input)

Specs:

Same as start_configuration_recorder/2 but raise on error.

Source
stop_configuration_recorder(client, input)

Specs:

StopConfigurationRecorder

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

Source
stop_configuration_recorder!(client, input)

Specs:

Same as stop_configuration_recorder/2 but raise on error.

Source