[ aws . configservice ]
deliver-config-snapshot¶
Description¶
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified.
Notification of the start of the delivery.
Notification of the completion of the delivery, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
deliver-config-snapshot
--delivery-channel-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--delivery-channel-name (string)
The name of the delivery channel through which the snapshot is delivered.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To deliver a configuration snapshot
The following command delivers a configuration snapshot to the Amazon S3 bucket that belongs to the default delivery channel:
aws configservice deliver-config-snapshot --delivery-channel-name default
Output:
{
"configSnapshotId": "d0333b00-a683-44af-921e-examplefb794"
}