Note

You are viewing the documentation for an older version of boto (boto2).

Boto3, the next version of Boto, is now stable and recommended for general use. It can be used side-by-side with Boto in the same project, so it is easy to start using Boto3 in your existing projects as well as new projects. Going forward, API updates and all new feature work will be focused on Boto3.

For more information, see the documentation for boto3.

Config

boto.configservice

boto.configservice.connect_to_region(region_name, **kw_params)
boto.configservice.regions()

Get all available regions for the AWS Config service.

Return type:list
Returns:A list of boto.regioninfo.RegionInfo

boto.configservice.layer1

class boto.configservice.layer1.ConfigServiceConnection(**kwargs)

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 .

APIVersion = '2014-11-12'
DefaultRegionEndpoint = 'config.us-east-1.amazonaws.com'
DefaultRegionName = 'us-east-1'
ResponseError

alias of JSONResponseError

ServiceName = 'ConfigService'
TargetPrefix = 'StarlingDoveService'
delete_delivery_channel(delivery_channel_name)

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.

Parameters:delivery_channel_name (string) – The name of the delivery channel to delete.
deliver_config_snapshot(delivery_channel_name)

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.
Parameters:delivery_channel_name (string) – The name of the delivery channel through which the snapshot is delivered.
describe_configuration_recorder_status(configuration_recorder_names=None)

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.

Parameters:configuration_recorder_names (list) – 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.
describe_configuration_recorders(configuration_recorder_names=None)

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.

Parameters:configuration_recorder_names (list) – A list of configuration recorder names.
describe_delivery_channel_status(delivery_channel_names=None)

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.

Parameters:delivery_channel_names (list) – A list of delivery channel names.
describe_delivery_channels(delivery_channel_names=None)

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.

Parameters:delivery_channel_names (list) – A list of delivery channel names.
get_resource_config_history(resource_type, resource_id, later_time=None, earlier_time=None, chronological_order=None, limit=None, next_token=None)

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. You can specify a limit on the number of results returned on the page. If a limit is specified, a nextToken is returned as part of the result that you can use to continue this request.

Parameters:
  • resource_type (string) – The resource type.
  • resource_id (string) – The ID of the resource (for example., sg-xxxxxx).
  • later_time (timestamp) – The time stamp that indicates a later time. If not specified, current time is taken.
  • earlier_time (timestamp) – The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from 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 in each page. The default is 10. You cannot specify a limit greater than 100.
  • next_token (string) – An optional parameter used for pagination of the results.
make_request(action, body)
put_configuration_recorder(configuration_recorder)

Creates a new configuration recorder to record the resource configurations.

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

Parameters:configuration_recorder (dict) –

The configuration recorder object that records each configuration change made to the resources. The format should follow:

{‘name’: ‘myrecorder’,
‘roleARN’: ‘arn:aws:iam::123456789012:role/trusted-aws-config’}
put_delivery_channel(delivery_channel)

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.

Parameters:delivery_channel (dict) – The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
start_configuration_recorder(configuration_recorder_name)

Starts recording configurations of all the resources associated with the account.

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

Parameters:configuration_recorder_name (string) – The name of the recorder object that records each configuration change made to the resources.
stop_configuration_recorder(configuration_recorder_name)

Stops recording configurations of all the resources associated with the account.

Parameters:configuration_recorder_name (string) – The name of the recorder object that records each configuration change made to the resources.

boto.configservice.exceptions

exception boto.configservice.exceptions.InsufficientDeliveryPolicyException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidConfigurationRecorderNameException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidDeliveryChannelNameException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidLimitException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidNextTokenException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidRoleException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidS3KeyPrefixException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidSNSTopicARNException(status, reason, body=None, *args)
exception boto.configservice.exceptions.InvalidTimeRangeException(status, reason, body=None, *args)
exception boto.configservice.exceptions.LastDeliveryChannelDeleteFailedException(status, reason, body=None, *args)
exception boto.configservice.exceptions.MaxNumberOfConfigurationRecordersExceededException(status, reason, body=None, *args)
exception boto.configservice.exceptions.MaxNumberOfDeliveryChannelsExceededException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoAvailableConfigurationRecorderException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoAvailableDeliveryChannelException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoRunningConfigurationRecorderException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoSuchBucketException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoSuchConfigurationRecorderException(status, reason, body=None, *args)
exception boto.configservice.exceptions.NoSuchDeliveryChannelException(status, reason, body=None, *args)
exception boto.configservice.exceptions.ResourceNotDiscoveredException(status, reason, body=None, *args)
exception boto.configservice.exceptions.ValidationException(status, reason, body=None, *args)