ConfigService / Client / put_delivery_channel

put_delivery_channel#

ConfigService.Client.put_delivery_channel(**kwargs)#

Creates or updates a delivery channel to deliver configuration information and other compliance information.

You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel.

For more information, see **Working with the Delivery Channel** in the Config Developer Guide.

Note

One delivery channel per account per Region

You can have only one delivery channel for each account for each Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.put_delivery_channel(
    DeliveryChannel={
        'name': 'string',
        's3BucketName': 'string',
        's3KeyPrefix': 'string',
        's3KmsKeyArn': 'string',
        'snsTopicARN': 'string',
        'configSnapshotDeliveryProperties': {
            'deliveryFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
        }
    }
)
Parameters:

DeliveryChannel (dict) –

[REQUIRED]

An object for the delivery channel. A delivery channel sends notifications and updated configuration states.

  • name (string) –

    The name of the delivery channel. By default, Config assigns the name “default” when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

  • s3BucketName (string) –

    The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

    If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

  • s3KeyPrefix (string) –

    The prefix for the specified Amazon S3 bucket.

  • s3KmsKeyArn (string) –

    The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

  • snsTopicARN (string) –

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

    If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

  • configSnapshotDeliveryProperties (dict) –

    The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

    • deliveryFrequency (string) –

      The frequency with which Config delivers configuration snapshots.

Returns:

None

Exceptions

  • ConfigService.Client.exceptions.MaxNumberOfDeliveryChannelsExceededException

  • ConfigService.Client.exceptions.NoAvailableConfigurationRecorderException

  • ConfigService.Client.exceptions.InvalidDeliveryChannelNameException

  • ConfigService.Client.exceptions.NoSuchBucketException

  • ConfigService.Client.exceptions.InvalidS3KeyPrefixException

  • ConfigService.Client.exceptions.InvalidS3KmsKeyArnException

  • ConfigService.Client.exceptions.InvalidSNSTopicARNException

  • ConfigService.Client.exceptions.InsufficientDeliveryPolicyException