deliverConfigSnapshot method

Future<DeliverConfigSnapshotResponse> deliverConfigSnapshot({
  1. required String deliveryChannelName,
})

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.

May throw NoSuchDeliveryChannelException. May throw NoAvailableConfigurationRecorderException. May throw NoRunningConfigurationRecorderException.

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

Implementation

Future<DeliverConfigSnapshotResponse> deliverConfigSnapshot({
  required String deliveryChannelName,
}) async {
  ArgumentError.checkNotNull(deliveryChannelName, 'deliveryChannelName');
  _s.validateStringLength(
    'deliveryChannelName',
    deliveryChannelName,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'StarlingDoveService.DeliverConfigSnapshot'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'deliveryChannelName': deliveryChannelName,
    },
  );

  return DeliverConfigSnapshotResponse.fromJson(jsonResponse.body);
}