Skip to content

describe_addresses_attribute async

describe_addresses_attribute(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    allocation_ids: Optional[AllocationIds] = None,
    attribute: Optional[AddressAttributeName] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[AddressMaxResults] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeAddressesAttributeResult

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

Parameters:

  • allocation_ids (Optional[AllocationIds], default: None ) –

    [EC2-VPC] The allocation IDs.

  • attribute (Optional[AddressAttributeName], default: None ) –

    The attribute of the IP address.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • max_results (Optional[AddressMaxResults], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_addresses_attribute(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    allocation_ids: Optional["capo_ec2.types.allocation_ids.AllocationIds"] = None,
    attribute: Optional[
        "capo_ec2.types.address_attribute_name.AddressAttributeName"
    ] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_ec2.types.address_max_results.AddressMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_addresses_attribute_result.DescribeAddressesAttributeResult":
    """<p>Describes the attributes of the specified Elastic IP addresses. For requirements, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS">Using reverse DNS for email applications</a>.</p>

    Args:
        allocation_ids: <p>[EC2-VPC] The allocation IDs.</p>
        attribute: <p>The attribute of the IP address.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_addresses_attribute_request.DescribeAddressesAttributeRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_addresses_attribute_result.DescribeAddressesAttributeResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_addresses_attribute

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_addresses_attribute.async_describe_addresses_attribute(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAddressesAttribute")
    )
    input_: capo_ec2.types.describe_addresses_attribute_request.DescribeAddressesAttributeRequest = {}
    if allocation_ids is not None:
        input_["allocation_ids"] = allocation_ids
    if attribute is not None:
        input_["attribute"] = attribute
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run

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