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.DescribeVpcEndpointServiceConfigurations

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVpcEndpointServiceConfigurations Source #

Constructors

DescribeVpcEndpointServiceConfigurations' 

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.

    • 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.
  • maxResults :: Maybe Int

    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.

  • nextToken :: Maybe Text

    The token to retrieve the next page of results.

  • serviceIds :: Maybe [Text]

    The IDs of one or more services.

Instances

Instances details
ToHeaders DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

ToPath DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

ToQuery DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

AWSPager DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

AWSRequest DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Generic DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Read DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Show DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

NFData DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Eq DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Hashable DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

type AWSResponse DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

type Rep DescribeVpcEndpointServiceConfigurations Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

type Rep DescribeVpcEndpointServiceConfigurations = D1 ('MetaData "DescribeVpcEndpointServiceConfigurations" "Amazonka.EC2.DescribeVpcEndpointServiceConfigurations" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpcEndpointServiceConfigurations'" '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 "serviceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeVpcEndpointServiceConfigurations :: DescribeVpcEndpointServiceConfigurations Source #

Create a value of DescribeVpcEndpointServiceConfigurations 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:DescribeVpcEndpointServiceConfigurations', describeVpcEndpointServiceConfigurations_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:DescribeVpcEndpointServiceConfigurations', describeVpcEndpointServiceConfigurations_filters - One or more 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.

$sel:maxResults:DescribeVpcEndpointServiceConfigurations', describeVpcEndpointServiceConfigurations_maxResults - 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.

DescribeVpcEndpointServiceConfigurations, describeVpcEndpointServiceConfigurations_nextToken - The token to retrieve the next page of results.

$sel:serviceIds:DescribeVpcEndpointServiceConfigurations', describeVpcEndpointServiceConfigurations_serviceIds - The IDs of one or more services.

Request Lenses

describeVpcEndpointServiceConfigurations_dryRun :: Lens' DescribeVpcEndpointServiceConfigurations (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.

describeVpcEndpointServiceConfigurations_filters :: Lens' DescribeVpcEndpointServiceConfigurations (Maybe [Filter]) Source #

One or more 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.

describeVpcEndpointServiceConfigurations_maxResults :: Lens' DescribeVpcEndpointServiceConfigurations (Maybe Int) Source #

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.

Destructuring the Response

data DescribeVpcEndpointServiceConfigurationsResponse Source #

Constructors

DescribeVpcEndpointServiceConfigurationsResponse' 

Fields

Instances

Instances details
Generic DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Read DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Show DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

NFData DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

Eq DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

type Rep DescribeVpcEndpointServiceConfigurationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpcEndpointServiceConfigurations

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

newDescribeVpcEndpointServiceConfigurationsResponse Source #

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

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

$sel:serviceConfigurations:DescribeVpcEndpointServiceConfigurationsResponse', describeVpcEndpointServiceConfigurationsResponse_serviceConfigurations - Information about one or more services.

$sel:httpStatus:DescribeVpcEndpointServiceConfigurationsResponse', describeVpcEndpointServiceConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

describeVpcEndpointServiceConfigurationsResponse_nextToken :: Lens' DescribeVpcEndpointServiceConfigurationsResponse (Maybe Text) Source #

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