describe_address `async` ¶

describe_address(
    address_id: AddressId,
    *,
    config_overrides: Optional[AsyncSnowballClientConfig] = None,
) -> DescribeAddressResult

Takes an AddressId and returns specific details about that address in the form of an Address object.

Parameters:

address_id (AddressId) –

The automatically generated ID for a specific address.

Raises:

InvalidResourceException –

The specified resource can't be found. Check the information you provided in your last request, and try again.
UnknownServiceError –

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

Examples:

To describe an address for a job This operation describes an address for a job.

>>> await client.describe_address(address_id='ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b')

Source code in docs_src/capo_snowball/_services/async_snowball.py

async def describe_address(
    self,
    address_id: "capo_snowball.types.address_id.AddressId",
    *,
    config_overrides: Optional[AsyncSnowballClientConfig] = None,
) -> "capo_snowball.types.describe_address_result.DescribeAddressResult":
    """<p>Takes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code> object.</p>

    Args:
        address_id: <p>The automatically generated ID for a specific address.</p>

    Raises:
        capo_snowball.errors.invalid_resource_exception.InvalidResourceException: <p>The specified resource can't be found. Check the information you provided in your last request, and try again.</p>
        capo_snowball.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe an address for a job
        This operation describes an address for a job.

        >>> await client.describe_address(address_id='ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_snowball.types.describe_address_request.DescribeAddressRequest]",
    ) -> AsyncOperationResponse[
        "capo_snowball.types.describe_address_result.DescribeAddressResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.describe_address

        (
            output,
            http_response,
        ) = await capo_snowball._operations.awsie_snowball_job_management_service.describe_address.async_describe_address(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAddress")
    )
    input_: capo_snowball.types.describe_address_request.DescribeAddressRequest = {
        "address_id": address_id
    }

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

describe_address async ¶

describe_address `async` ¶