Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeVpcEndpointServices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVpcEndpointServices Source #

Contains the parameters for DescribeVpcEndpointServices.

See: newDescribeVpcEndpointServices smart constructor.

Constructors

DescribeVpcEndpointServices'

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.
- owner - The ID or alias of the Amazon Web Services account that owns the service.
- service-name - The name 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 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.
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.)
serviceNames :: Maybe [Text]
One or more service names.

Instances

Instances details

ToHeaders DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods toHeaders :: DescribeVpcEndpointServices -> [Header] #
ToPath DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods toPath :: DescribeVpcEndpointServices -> ByteString #
ToQuery DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods toQuery :: DescribeVpcEndpointServices -> QueryString #
AWSPager DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods page :: DescribeVpcEndpointServices -> AWSResponse DescribeVpcEndpointServices -> Maybe DescribeVpcEndpointServices #
AWSRequest DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Associated Types type AWSResponse DescribeVpcEndpointServices # Methods request :: (Service -> Service) -> DescribeVpcEndpointServices -> Request DescribeVpcEndpointServices # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeVpcEndpointServices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeVpcEndpointServices))) #
Generic DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Associated Types type Rep DescribeVpcEndpointServices :: Type -> Type # Methods from :: DescribeVpcEndpointServices -> Rep DescribeVpcEndpointServices x # to :: Rep DescribeVpcEndpointServices x -> DescribeVpcEndpointServices #
Read DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods readsPrec :: Int -> ReadS DescribeVpcEndpointServices # readList :: ReadS [DescribeVpcEndpointServices] # readPrec :: ReadPrec DescribeVpcEndpointServices # readListPrec :: ReadPrec [DescribeVpcEndpointServices] #
Show DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods showsPrec :: Int -> DescribeVpcEndpointServices -> ShowS # show :: DescribeVpcEndpointServices -> String # showList :: [DescribeVpcEndpointServices] -> ShowS #
NFData DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods rnf :: DescribeVpcEndpointServices -> () #
Eq DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods (==) :: DescribeVpcEndpointServices -> DescribeVpcEndpointServices -> Bool # (/=) :: DescribeVpcEndpointServices -> DescribeVpcEndpointServices -> Bool #
Hashable DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods hashWithSalt :: Int -> DescribeVpcEndpointServices -> Int # hash :: DescribeVpcEndpointServices -> Int #
type AWSResponse DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices type AWSResponse DescribeVpcEndpointServices = DescribeVpcEndpointServicesResponse
type Rep DescribeVpcEndpointServices Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices type Rep DescribeVpcEndpointServices = D1 ('MetaData "DescribeVpcEndpointServices" "Amazonka.EC2.DescribeVpcEndpointServices" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcEndpointServices'" '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 "serviceNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeVpcEndpointServices :: DescribeVpcEndpointServices Source #

Create a value of DescribeVpcEndpointServices 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:DescribeVpcEndpointServices', describeVpcEndpointServices_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:DescribeVpcEndpointServices', describeVpcEndpointServices_filters - One or more filters.

owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name 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 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.

$sel:maxResults:DescribeVpcEndpointServices', describeVpcEndpointServices_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.

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

DescribeVpcEndpointServices, describeVpcEndpointServices_serviceNames - One or more service names.

Request Lenses

describeVpcEndpointServices_dryRun :: Lens' DescribeVpcEndpointServices (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.

describeVpcEndpointServices_filters :: Lens' DescribeVpcEndpointServices (Maybe [Filter]) Source #

One or more filters.

owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name 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 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.

describeVpcEndpointServices_maxResults :: Lens' DescribeVpcEndpointServices (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.

describeVpcEndpointServices_nextToken :: Lens' DescribeVpcEndpointServices (Maybe Text) Source #

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

describeVpcEndpointServices_serviceNames :: Lens' DescribeVpcEndpointServices (Maybe [Text]) Source #

One or more service names.

Destructuring the Response

data DescribeVpcEndpointServicesResponse Source #

Contains the output of DescribeVpcEndpointServices.

See: newDescribeVpcEndpointServicesResponse smart constructor.

Constructors

DescribeVpcEndpointServicesResponse'
Fields nextToken :: Maybe Text The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. serviceDetails :: Maybe [ServiceDetail] Information about the service. serviceNames :: Maybe [Text] A list of supported services. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Associated Types type Rep DescribeVpcEndpointServicesResponse :: Type -> Type # Methods from :: DescribeVpcEndpointServicesResponse -> Rep DescribeVpcEndpointServicesResponse x # to :: Rep DescribeVpcEndpointServicesResponse x -> DescribeVpcEndpointServicesResponse #
Read DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods readsPrec :: Int -> ReadS DescribeVpcEndpointServicesResponse # readList :: ReadS [DescribeVpcEndpointServicesResponse] # readPrec :: ReadPrec DescribeVpcEndpointServicesResponse # readListPrec :: ReadPrec [DescribeVpcEndpointServicesResponse] #
Show DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods showsPrec :: Int -> DescribeVpcEndpointServicesResponse -> ShowS # show :: DescribeVpcEndpointServicesResponse -> String # showList :: [DescribeVpcEndpointServicesResponse] -> ShowS #
NFData DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods rnf :: DescribeVpcEndpointServicesResponse -> () #
Eq DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices Methods (==) :: DescribeVpcEndpointServicesResponse -> DescribeVpcEndpointServicesResponse -> Bool # (/=) :: DescribeVpcEndpointServicesResponse -> DescribeVpcEndpointServicesResponse -> Bool #
type Rep DescribeVpcEndpointServicesResponse Source #
Instance details Defined in Amazonka.EC2.DescribeVpcEndpointServices type Rep DescribeVpcEndpointServicesResponse = D1 ('MetaData "DescribeVpcEndpointServicesResponse" "Amazonka.EC2.DescribeVpcEndpointServices" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcEndpointServicesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceDetail]))) :: (S1 ('MetaSel ('Just "serviceNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVpcEndpointServicesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeVpcEndpointServicesResponse'`
-> DescribeVpcEndpointServicesResponse

Create a value of DescribeVpcEndpointServicesResponse 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:

DescribeVpcEndpointServices, describeVpcEndpointServicesResponse_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:serviceDetails:DescribeVpcEndpointServicesResponse', describeVpcEndpointServicesResponse_serviceDetails - Information about the service.

DescribeVpcEndpointServices, describeVpcEndpointServicesResponse_serviceNames - A list of supported services.

$sel:httpStatus:DescribeVpcEndpointServicesResponse', describeVpcEndpointServicesResponse_httpStatus - The response's http status code.

Response Lenses

describeVpcEndpointServicesResponse_nextToken :: Lens' DescribeVpcEndpointServicesResponse (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.

describeVpcEndpointServicesResponse_serviceDetails :: Lens' DescribeVpcEndpointServicesResponse (Maybe [ServiceDetail]) Source #

Information about the service.

describeVpcEndpointServicesResponse_serviceNames :: Lens' DescribeVpcEndpointServicesResponse (Maybe [Text]) Source #

A list of supported services.

describeVpcEndpointServicesResponse_httpStatus :: Lens' DescribeVpcEndpointServicesResponse Int Source #

The response's http status code.