Menu
AWS Config
API Reference (API Version 2014-11-12)

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.

Request Syntax

{
   "deliveryChannelName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

deliveryChannelName

The name of the delivery channel through which the snapshot is delivered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax

{
   "configSnapshotId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configSnapshotId

The ID of the snapshot that is being created.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

NoAvailableConfigurationRecorderException

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

HTTP Status Code: 400

NoRunningConfigurationRecorderException

There is no configuration recorder running.

HTTP Status Code: 400

NoSuchDeliveryChannelException

You have specified a delivery channel that does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: