Skip to content

describe_vpc_endpoint_associations async

describe_vpc_endpoint_associations(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    vpc_endpoint_ids: Optional[VpcEndpointIdList] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[MaxResults2] = None,
    next_token: Optional[String] = None,
) -> DescribeVpcEndpointAssociationsResult

Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.

Parameters:

  • 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.

  • vpc_endpoint_ids (Optional[VpcEndpointIdList], default: None ) –

    The IDs of the VPC endpoints.

  • filters (Optional[FilterList], default: None ) –

    The filters.

    • vpc-endpoint-id - The ID of the VPC endpoint.

    • associated-resource-accessibility - The association state. When the state is accessible, it returns AVAILABLE. When the state is inaccessible, it returns PENDING or FAILED.

    • association-id - The ID of the VPC endpoint association.

    • associated-resource-id - The ID of the associated resource configuration.

    • service-network-arn - The Amazon Resource Name (ARN) of the associated service network. Only VPC endpoints of type service network will be returned.

    • resource-configuration-group-arn - The Amazon Resource Name (ARN) of the resource configuration of type GROUP.

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

    The maximum page size.

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

    The pagination token.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_vpc_endpoint_associations(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    vpc_endpoint_ids: Optional[
        "capo_ec2.types.vpc_endpoint_id_list.VpcEndpointIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.max_results2.MaxResults2"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.describe_vpc_endpoint_associations_result.DescribeVpcEndpointAssociationsResult":
    """<p>Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.</p>

    Args:
        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>
        vpc_endpoint_ids: <p>The IDs of the VPC endpoints.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>vpc-endpoint-id</code> - The ID of the VPC endpoint.</p> </li> <li> <p> <code>associated-resource-accessibility</code> - The association state. When the state is <code>accessible</code>, it returns <code>AVAILABLE</code>. When the state is <code>inaccessible</code>, it returns <code>PENDING</code> or <code>FAILED</code>.</p> </li> <li> <p> <code>association-id</code> - The ID of the VPC endpoint association.</p> </li> <li> <p> <code>associated-resource-id</code> - The ID of the associated resource configuration.</p> </li> <li> <p> <code>service-network-arn</code> - The Amazon Resource Name (ARN) of the associated service network. Only VPC endpoints of type service network will be returned.</p> </li> <li> <p> <code>resource-configuration-group-arn</code> - The Amazon Resource Name (ARN) of the resource configuration of type GROUP.</p> </li> </ul>
        max_results: <p>The maximum page size.</p>
        next_token: <p>The pagination token.</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_vpc_endpoint_associations_request.DescribeVpcEndpointAssociationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_vpc_endpoint_associations_result.DescribeVpcEndpointAssociationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_vpc_endpoint_associations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVpcEndpointAssociations")
    )
    input_: capo_ec2.types.describe_vpc_endpoint_associations_request.DescribeVpcEndpointAssociationsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if vpc_endpoint_ids is not None:
        input_["vpc_endpoint_ids"] = vpc_endpoint_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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