Skip to content

describe_vpc_endpoint_service_configurations

Operation

describe_vpc_endpoint_service_configurations

Describes the VPC endpoint service configurations in your account (your services).

Parameters:

Name Type Description Default
request DescribeVpcEndpointServiceConfigurationsInput | DescribeVpcEndpointServiceConfigurationsInputDict | 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[DescribeVpcEndpointServiceConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointServiceConfigurationsOutput

An instance of DescribeVpcEndpointServiceConfigurationsOutput.

describe_vpc_endpoint_service_configurations async

Describes the VPC endpoint service configurations in your account (your services).

Parameters:

Name Type Description Default
request DescribeVpcEndpointServiceConfigurationsInput | DescribeVpcEndpointServiceConfigurationsInputDict | 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[DescribeVpcEndpointServiceConfigurationsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointServiceConfigurationsOutput

An instance of DescribeVpcEndpointServiceConfigurationsOutput.

Input

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

DescribeVpcEndpointServiceConfigurationsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcEndpointServiceConfigurationsInput.

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.

  • service-name - The name of the service.

  • service-id - The ID of the service.

  • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

  • 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for 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 results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

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

The IDs of the endpoint services.

DescribeVpcEndpointServiceConfigurationsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointServiceConfigurationsInput 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.

  • service-name - The name of the service.

  • service-id - The ID of the service.

  • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

  • 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for 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 results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

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

The token to retrieve the next page of results.

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

The IDs of the endpoint services.

Output

DescribeVpcEndpointServiceConfigurationsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointServiceConfigurationsOutput structure.

Attributes

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.

service_configurations class-attribute instance-attribute
service_configurations: list[ServiceConfiguration] | None = ...

Information about the services.