Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, 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.
Parameters:
-
delivery_channel_name
(ChannelName)
–
The name of the delivery channel through which the snapshot is delivered.
Raises:
Source code in docs_src/capo_config_service/_services/config_service.py
| def deliver_config_snapshot(
self,
delivery_channel_name: "capo_config_service.types.channel_name.ChannelName",
*,
config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> "capo_config_service.types.deliver_config_snapshot_response.DeliverConfigSnapshotResponse":
"""<p>Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.</p> <ul> <li> <p>Notification of the start of the delivery.</p> </li> <li> <p>Notification of the completion of the delivery, if the delivery was successfully completed.</p> </li> <li> <p>Notification of delivery failure, if the delivery failed.</p> </li> </ul>
Args:
delivery_channel_name: <p>The name of the delivery channel through which the snapshot is delivered.</p>
Raises:
capo_config_service.errors.no_available_configuration_recorder_exception.NoAvailableConfigurationRecorderException: <p>There are no customer managed configuration recorders available to record your resources. Use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_PutConfigurationRecorder.html">PutConfigurationRecorder</a> operation to create the customer managed configuration recorder.</p>
capo_config_service.errors.no_running_configuration_recorder_exception.NoRunningConfigurationRecorderException: <p>There is no configuration recorder running.</p>
capo_config_service.errors.no_such_delivery_channel_exception.NoSuchDeliveryChannelException: <p>You have specified a delivery channel that does not exist.</p>
capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_config_service.types.deliver_config_snapshot_request.DeliverConfigSnapshotRequest]",
) -> OperationResponse[
"capo_config_service.types.deliver_config_snapshot_response.DeliverConfigSnapshotResponse"
]:
import capo_config_service._operations.starling_dove_service.deliver_config_snapshot
output, http_response = (
capo_config_service._operations.starling_dove_service.deliver_config_snapshot.deliver_config_snapshot(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeliverConfigSnapshot")
)
input_: capo_config_service.types.deliver_config_snapshot_request.DeliverConfigSnapshotRequest = {
"delivery_channel_name": delivery_channel_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|