Skip to content

describe_vpc_endpoint_associations

Operation

describe_vpc_endpoint_associations

describe_vpc_endpoint_associations(request: DescribeVpcEndpointAssociationsInput | DescribeVpcEndpointAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointAssociationsInputDict]) -> DescribeVpcEndpointAssociationsOutput

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

Parameters:

Name Type Description Default
request DescribeVpcEndpointAssociationsInput | DescribeVpcEndpointAssociationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeVpcEndpointAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointAssociationsOutput

An instance of DescribeVpcEndpointAssociationsOutput.

describe_vpc_endpoint_associations async

describe_vpc_endpoint_associations(request: DescribeVpcEndpointAssociationsInput | DescribeVpcEndpointAssociationsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointAssociationsInputDict]) -> DescribeVpcEndpointAssociationsOutput

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

Parameters:

Name Type Description Default
request DescribeVpcEndpointAssociationsInput | DescribeVpcEndpointAssociationsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeVpcEndpointAssociationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointAssociationsOutput

An instance of DescribeVpcEndpointAssociationsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeVpcEndpointAssociationsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcEndpointAssociationsInput.

Attributes

dry_run instance-attribute
dry_run: bool | 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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | 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 instance-attribute
max_results: int | None

The maximum page size.

next_token instance-attribute
next_token: str | None

The pagination token.

vpc_endpoint_ids instance-attribute
vpc_endpoint_ids: Sequence[str] | None

The IDs of the VPC endpoints.

DescribeVpcEndpointAssociationsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointAssociationsInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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.

filters class-attribute instance-attribute
filters: list[Filter] | 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 class-attribute instance-attribute
max_results: int | None = ...

The maximum page size.

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination token.

vpc_endpoint_ids class-attribute instance-attribute
vpc_endpoint_ids: list[str] | None = ...

The IDs of the VPC endpoints.

Output

DescribeVpcEndpointAssociationsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointAssociationsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination token.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

vpc_endpoint_associations class-attribute instance-attribute
vpc_endpoint_associations: list[VpcEndpointAssociation] | None = ...

Details of the endpoint associations.