describeTapeArchives method

Future<DescribeTapeArchivesOutput> describeTapeArchives({ int? limit, String? marker, List<String>? tapeARNs, })

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

May throw InvalidGatewayRequestException. May throw InternalServerError.

Parameter limit : Specifies that the number of virtual tapes described be limited to the specified number.

Parameter marker : An opaque string that indicates the position at which to begin describing virtual tapes.

Parameter tapeARNs : Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Implementation

Future<DescribeTapeArchivesOutput> describeTapeArchives({
  int? limit,
  String? marker,
  List<String>? tapeARNs,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    1152921504606846976,
  );
  _s.validateStringLength(
    'marker',
    marker,
    1,
    1000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'StorageGateway_20130630.DescribeTapeArchives'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (limit != null) 'Limit': limit,
      if (marker != null) 'Marker': marker,
      if (tapeARNs != null) 'TapeARNs': tapeARNs,
    },
  );

  return DescribeTapeArchivesOutput.fromJson(jsonResponse.body);
}