describeSnapshotSchedule method

Future<DescribeSnapshotScheduleOutput> describeSnapshotSchedule({
  1. required String volumeARN,
})

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

May throw InvalidGatewayRequestException. May throw InternalServerError.

Parameter volumeARN : The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Implementation

Future<DescribeSnapshotScheduleOutput> describeSnapshotSchedule({
  required String volumeARN,
}) async {
  ArgumentError.checkNotNull(volumeARN, 'volumeARN');
  _s.validateStringLength(
    'volumeARN',
    volumeARN,
    50,
    500,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'StorageGateway_20130630.DescribeSnapshotSchedule'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'VolumeARN': volumeARN,
    },
  );

  return DescribeSnapshotScheduleOutput.fromJson(jsonResponse.body);
}