describe_addresses ¶

describe_addresses(
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
    max_results: Optional[ListLimit] = None,
    next_token: Optional[String] = None,
) -> DescribeAddressesResult

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Parameters:

max_results (Optional[ListLimit], default: None ) –

The number of ADDRESS objects to return.
next_token (Optional[String], default: None ) –

HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

Raises:

InvalidNextTokenException –

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
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 all the addresses you've created for AWS Snowball This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

>>> client.describe_addresses()

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

def describe_addresses(
    self,
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
    max_results: Optional["capo_snowball.types.list_limit.ListLimit"] = None,
    next_token: Optional["capo_snowball.types.string.String"] = None,
) -> "capo_snowball.types.describe_addresses_result.DescribeAddressesResult":
    """<p>Returns a specified number of <code>ADDRESS</code> objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.</p>

    Args:
        max_results: <p>The number of <code>ADDRESS</code> objects to return.</p>
        next_token: <p>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ADDRESS</code> objects, you have the option of specifying a value for <code>NextToken</code> as the starting point for your list of returned addresses.</p>

    Raises:
        capo_snowball.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> string was altered unexpectedly, and the operation has stopped. Run the operation without changing the <code>NextToken</code> string, and try again.</p>
        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 all the addresses you've created for AWS Snowball
        This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

        >>> client.describe_addresses()
    """

    def _handler(
        req: "OperationRequest[capo_snowball.types.describe_addresses_request.DescribeAddressesRequest]",
    ) -> OperationResponse[
        "capo_snowball.types.describe_addresses_result.DescribeAddressesResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.describe_addresses

        output, http_response = (
            capo_snowball._operations.awsie_snowball_job_management_service.describe_addresses.describe_addresses(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAddresses")
    )
    input_: capo_snowball.types.describe_addresses_request.DescribeAddressesRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output