describe_vpc_endpoint_services¶
Operation¶
describe_vpc_endpoint_services
async
¶
describe_vpc_endpoint_services(request: DescribeVpcEndpointServicesInput | DescribeVpcEndpointServicesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVpcEndpointServicesOutput
describe_vpc_endpoint_services(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointServicesInputDict]) -> DescribeVpcEndpointServicesOutput
Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in
multiple Availability Zones, and the consumer views the VPC endpoint
service information, the response only includes the common Availability
Zones. For example, when the service provider account uses us-east-1a
and us-east-1c and the consumer uses us-east-1a and us-east-1b,
the response includes the VPC endpoint services in the common
Availability Zone, us-east-1a.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
DescribeVpcEndpointServicesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeVpcEndpointServicesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcEndpointServicesInput 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
¶
The filters.
-
owner- The ID or alias of the Amazon Web Services account that owns the service. -
service-name- The name of the service. -
service-region- The Region of the service. -
service-type- The type of service (Interface|Gateway|GatewayLoadBalancer). -
supported-ip-address-types- The IP address type (ipv4|ipv6). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token for the next set of items to return. (You received this token from a prior call.)
service_names
class-attribute
instance-attribute
¶
The service names.
Dictionaries¶
DescribeVpcEndpointServicesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeVpcEndpointServicesInput.
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.
-
owner- The ID or alias of the Amazon Web Services account that owns the service. -
service-name- The name of the service. -
service-region- The Region of the service. -
service-type- The type of service (Interface|Gateway|GatewayLoadBalancer). -
supported-ip-address-types- The IP address type (ipv4|ipv6). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
Output¶
DescribeVpcEndpointServicesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeVpcEndpointServicesOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
response_metadata
class-attribute
instance-attribute
¶
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.
service_details
class-attribute
instance-attribute
¶
service_details: list[ServiceDetail] | None = ...
Information about the service.