Skip to content

get_associated_ipv6_pool_cidrs

get_associated_ipv6_pool_cidrs(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    pool_id: Optional[Ipv6PoolEc2Id] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[Ipv6PoolMaxResults] = None,
    dry_run: Optional[Boolean] = None,
) -> GetAssociatedIpv6PoolCidrsResult

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

Parameters:

  • pool_id (Optional[Ipv6PoolEc2Id], default: None ) –

    The ID of the IPv6 address pool.

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

    The token for the next page of results.

  • max_results (Optional[Ipv6PoolMaxResults], 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/ec2.py
def get_associated_ipv6_pool_cidrs(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    pool_id: Optional["capo_ec2.types.ipv6_pool_ec2_id.Ipv6PoolEc2Id"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_ec2.types.ipv6_pool_max_results.Ipv6PoolMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.get_associated_ipv6_pool_cidrs_result.GetAssociatedIpv6PoolCidrsResult":
    """<p>Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.</p>

    Args:
        pool_id: <p>The ID of the IPv6 address pool.</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.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_associated_ipv6_pool_cidrs_request.GetAssociatedIpv6PoolCidrsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_associated_ipv6_pool_cidrs_result.GetAssociatedIpv6PoolCidrsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_associated_ipv6_pool_cidrs

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_associated_ipv6_pool_cidrs.get_associated_ipv6_pool_cidrs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAssociatedIpv6PoolCidrs")
    )
    input_: capo_ec2.types.get_associated_ipv6_pool_cidrs_request.GetAssociatedIpv6PoolCidrsRequest = {}
    if pool_id is not None:
        input_["pool_id"] = pool_id
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output