describe_tape_archives `async` ¶

describe_tape_archives(
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    tape_ar_ns: Optional[TapeARNs] = None,
    marker: Optional[Marker] = None,
    limit: Optional[PositiveIntObject] = None,
) -> DescribeTapeArchivesOutput

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, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Parameters:

tape_ar_ns (Optional[TapeARNs], default: None ) –

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
marker (Optional[Marker], default: None ) –

An opaque string that indicates the position at which to begin describing virtual tapes.
limit (Optional[PositiveIntObject], default: None ) –

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

Raises:

InternalServerError –

An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException –

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py

async def describe_tape_archives(
    self,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    tape_ar_ns: Optional["capo_storage_gateway.types.tape_ar_ns.TapeARNs"] = None,
    marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
    limit: Optional[
        "capo_storage_gateway.types.positive_int_object.PositiveIntObject"
    ] = None,
) -> "capo_storage_gateway.types.describe_tape_archives_output.DescribeTapeArchivesOutput":
    """<p>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.</p> <p>If a specific <code>TapeARN</code> is not specified, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.</p>

    Args:
        tape_ar_ns: <p>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.</p>
        marker: <p>An opaque string that indicates the position at which to begin describing virtual tapes.</p>
        limit: <p>Specifies that the number of virtual tapes described be limited to the specified number.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.describe_tape_archives_input.DescribeTapeArchivesInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.describe_tape_archives_output.DescribeTapeArchivesOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_tape_archives

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.describe_tape_archives.async_describe_tape_archives(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTapeArchives")
    )
    input_: capo_storage_gateway.types.describe_tape_archives_input.DescribeTapeArchivesInput = {}
    if tape_ar_ns is not None:
        input_["tape_ar_ns"] = tape_ar_ns
    if marker is not None:
        input_["marker"] = marker
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_tape_archives async ¶

describe_tape_archives `async` ¶