aws_sdk_ec2/client/

describe_vpc_endpoints.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeVpcEndpoints`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
    ///   - [`vpc_endpoint_ids(impl Into<String>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::vpc_endpoint_ids) / [`set_vpc_endpoint_ids(Option<Vec::<String>>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::set_vpc_endpoint_ids):<br>required: **false**<br><p>The IDs of the VPC endpoints.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>ip-address-type</code> - The IP address type (<code>ipv4</code> | <code>ipv6</code>).</p></li>  <li>   <p><code>service-name</code> - The name of the service.</p></li>  <li>   <p><code>service-region</code> - The Region of the service.</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.    </key></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>  <li>   <p><code>vpc-id</code> - The ID of the VPC in which the endpoint resides.</p></li>  <li>   <p><code>vpc-endpoint-id</code> - The ID of the endpoint.</p></li>  <li>   <p><code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | <code>rejected</code> | <code>failed</code>).</p></li>  <li>   <p><code>vpc-endpoint-type</code> - The type of VPC endpoint (<code>Interface</code> | <code>Gateway</code> | <code>GatewayLoadBalancer</code> | <code>Resource</code> | <code>ServiceNetwork</code>).</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::set_max_results):<br>required: **false**<br><p>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.</p> <p>Constraint: If the value is greater than 1,000, we return only 1,000 items.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. (You received this token from a prior call.)</p><br>
    /// - On success, responds with [`DescribeVpcEndpointsOutput`](crate::operation::describe_vpc_endpoints::DescribeVpcEndpointsOutput) with field(s):
    ///   - [`vpc_endpoints(Option<Vec::<VpcEndpoint>>)`](crate::operation::describe_vpc_endpoints::DescribeVpcEndpointsOutput::vpc_endpoints): <p>Information about the VPC endpoints.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_vpc_endpoints::DescribeVpcEndpointsOutput::next_token): <p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>
    /// - On failure, responds with [`SdkError<DescribeVpcEndpointsError>`](crate::operation::describe_vpc_endpoints::DescribeVpcEndpointsError)
    pub fn describe_vpc_endpoints(&self) -> crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder {
        crate::operation::describe_vpc_endpoints::builders::DescribeVpcEndpointsFluentBuilder::new(self.handle.clone())
    }
}