Skip to content

describe_vpc_endpoint_service_configurations async

describe_vpc_endpoint_service_configurations(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    service_ids: Optional[VpcEndpointServiceIdList] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[Integer] = None,
    next_token: Optional[String] = None,
) -> DescribeVpcEndpointServiceConfigurationsResult

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

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.

  • service_ids (Optional[VpcEndpointServiceIdList], default: None ) –

    The IDs of the endpoint services.

  • filters (Optional[FilterList], default: 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: - 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 (Optional[Integer], default: 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 (Optional[String], default: None ) –

    The token to retrieve the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_vpc_endpoint_service_configurations(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    service_ids: Optional[
        "capo_ec2.types.vpc_endpoint_service_id_list.VpcEndpointServiceIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.integer.Integer"] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.describe_vpc_endpoint_service_configurations_result.DescribeVpcEndpointServiceConfigurationsResult":
    """<p>Describes the VPC endpoint service configurations in your account (your services).</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>
        service_ids: <p>The IDs of the endpoint services.</p>
        filters: <p>The filters.</p> <ul> <li> <p> <code>service-name</code> - The name of the service.</p> </li> <li> <p> <code>service-id</code> - The ID of the service.</p> </li> <li> <p> <code>service-state</code> - The state of the service (<code>Pending</code> | <code>Available</code> | <code>Deleting</code> | <code>Deleted</code> | <code>Failed</code>). </p> </li> <li> <p> <code>supported-ip-address-types</code> - The IP address type (<code>ipv4</code> | <code>ipv6</code>).</p> </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
        max_results: <p>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 <code>NextToken</code> value. This value can be between 5 and 1,000; if <code>MaxResults</code> is given a value larger than 1,000, only 1,000 results are returned.</p>
        next_token: <p>The token to retrieve the next page of results.</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_service_configurations_request.DescribeVpcEndpointServiceConfigurationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_vpc_endpoint_service_configurations_result.DescribeVpcEndpointServiceConfigurationsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_vpc_endpoint_service_configurations

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeVpcEndpointServiceConfigurations"),
    )
    input_: capo_ec2.types.describe_vpc_endpoint_service_configurations_request.DescribeVpcEndpointServiceConfigurationsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if service_ids is not None:
        input_["service_ids"] = service_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