amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeVpcEndpoints

Description

Describes one or more of your VPC endpoints.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVpcEndpoints Source #

Contains the parameters for DescribeVpcEndpoints.

See: newDescribeVpcEndpoints smart constructor.

Constructors

DescribeVpcEndpoints' 

Fields

  • dryRun :: Maybe Bool

    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 :: Maybe [Filter]

    One or more filters.

    • ip-address-type - The IP address type (ipv4 | ipv6).
    • service-name - The name of the service.
    • 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.
    • vpc-id - The ID of the VPC in which the endpoint resides.
    • vpc-endpoint-id - The ID of the endpoint.
    • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
    • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
  • maxResults :: Maybe Int

    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.

  • nextToken :: Maybe Text

    The token for the next set of items to return. (You received this token from a prior call.)

  • vpcEndpointIds :: Maybe [Text]

    One or more endpoint IDs.

Instances

Instances details
ToHeaders DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

ToPath DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

ToQuery DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

AWSPager DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

AWSRequest DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Associated Types

type AWSResponse DescribeVpcEndpoints #

Generic DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Associated Types

type Rep DescribeVpcEndpoints :: Type -> Type #

Read DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Show DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

NFData DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Methods

rnf :: DescribeVpcEndpoints -> () #

Eq DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Hashable DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

type AWSResponse DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

type Rep DescribeVpcEndpoints Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

type Rep DescribeVpcEndpoints = D1 ('MetaData "DescribeVpcEndpoints" "Amazonka.EC2.DescribeVpcEndpoints" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcEndpoints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcEndpointIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeVpcEndpoints :: DescribeVpcEndpoints Source #

Create a value of DescribeVpcEndpoints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeVpcEndpoints', describeVpcEndpoints_dryRun - 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.

$sel:filters:DescribeVpcEndpoints', describeVpcEndpoints_filters - One or more filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).
  • service-name - The name of the service.
  • 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.
  • vpc-id - The ID of the VPC in which the endpoint resides.
  • vpc-endpoint-id - The ID of the endpoint.
  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
  • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

$sel:maxResults:DescribeVpcEndpoints', describeVpcEndpoints_maxResults - 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.

DescribeVpcEndpoints, describeVpcEndpoints_nextToken - The token for the next set of items to return. (You received this token from a prior call.)

$sel:vpcEndpointIds:DescribeVpcEndpoints', describeVpcEndpoints_vpcEndpointIds - One or more endpoint IDs.

Request Lenses

describeVpcEndpoints_dryRun :: Lens' DescribeVpcEndpoints (Maybe Bool) Source #

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.

describeVpcEndpoints_filters :: Lens' DescribeVpcEndpoints (Maybe [Filter]) Source #

One or more filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).
  • service-name - The name of the service.
  • 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.
  • vpc-id - The ID of the VPC in which the endpoint resides.
  • vpc-endpoint-id - The ID of the endpoint.
  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
  • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

describeVpcEndpoints_maxResults :: Lens' DescribeVpcEndpoints (Maybe Int) Source #

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.

describeVpcEndpoints_nextToken :: Lens' DescribeVpcEndpoints (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a prior call.)

Destructuring the Response

data DescribeVpcEndpointsResponse Source #

Contains the output of DescribeVpcEndpoints.

See: newDescribeVpcEndpointsResponse smart constructor.

Constructors

DescribeVpcEndpointsResponse' 

Fields

Instances

Instances details
Generic DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Associated Types

type Rep DescribeVpcEndpointsResponse :: Type -> Type #

Read DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Show DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

NFData DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

Eq DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

type Rep DescribeVpcEndpointsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpoints

type Rep DescribeVpcEndpointsResponse = D1 ('MetaData "DescribeVpcEndpointsResponse" "Amazonka.EC2.DescribeVpcEndpoints" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vpcEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcEndpoint])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVpcEndpointsResponse Source #

Create a value of DescribeVpcEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeVpcEndpoints, describeVpcEndpointsResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:vpcEndpoints:DescribeVpcEndpointsResponse', describeVpcEndpointsResponse_vpcEndpoints - Information about the endpoints.

$sel:httpStatus:DescribeVpcEndpointsResponse', describeVpcEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

describeVpcEndpointsResponse_nextToken :: Lens' DescribeVpcEndpointsResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.