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

Description

Describes one or more of your carrier gateways.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCarrierGateways Source #

See: newDescribeCarrierGateways smart constructor.

Constructors

DescribeCarrierGateways' 

Fields

  • carrierGatewayIds :: Maybe [Text]

    One or more carrier gateway IDs.

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

    • carrier-gateway-id - The ID of the carrier gateway.
    • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
    • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
    • 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 associated with the carrier gateway.
  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

toHeaders :: DescribeCarrierGateways -> [Header] #

ToPath DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

toPath :: DescribeCarrierGateways -> ByteString #

ToQuery DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

toQuery :: DescribeCarrierGateways -> QueryString #

AWSPager DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

page :: DescribeCarrierGateways -> AWSResponse DescribeCarrierGateways -> Maybe DescribeCarrierGateways #

AWSRequest DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Associated Types

type AWSResponse DescribeCarrierGateways #

Methods

request :: (Service -> Service) -> DescribeCarrierGateways -> Request DescribeCarrierGateways #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCarrierGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCarrierGateways))) #

Generic DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Associated Types

type Rep DescribeCarrierGateways :: Type -> Type #

Methods

from :: DescribeCarrierGateways -> Rep DescribeCarrierGateways x #

to :: Rep DescribeCarrierGateways x -> DescribeCarrierGateways #

Read DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

readsPrec :: Int -> ReadS DescribeCarrierGateways #

readList :: ReadS [DescribeCarrierGateways] #

readPrec :: ReadPrec DescribeCarrierGateways #

readListPrec :: ReadPrec [DescribeCarrierGateways] #

Show DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

showsPrec :: Int -> DescribeCarrierGateways -> ShowS #

show :: DescribeCarrierGateways -> String #

showList :: [DescribeCarrierGateways] -> ShowS #

NFData DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

rnf :: DescribeCarrierGateways -> () #

Eq DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

(==) :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool #

(/=) :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool #

Hashable DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

hashWithSalt :: Int -> DescribeCarrierGateways -> Int #

hash :: DescribeCarrierGateways -> Int #

type AWSResponse DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

type AWSResponse DescribeCarrierGateways = DescribeCarrierGatewaysResponse
type Rep DescribeCarrierGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

type Rep DescribeCarrierGateways = D1 ('MetaData "DescribeCarrierGateways" "Amazonka.EC2.DescribeCarrierGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeCarrierGateways'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "carrierGatewayIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: 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 Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeCarrierGateways :: DescribeCarrierGateways Source #

Create a value of DescribeCarrierGateways 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:carrierGatewayIds:DescribeCarrierGateways', describeCarrierGateways_carrierGatewayIds - One or more carrier gateway IDs.

$sel:dryRun:DescribeCarrierGateways', describeCarrierGateways_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:DescribeCarrierGateways', describeCarrierGateways_filters - One or more filters.

  • carrier-gateway-id - The ID of the carrier gateway.
  • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
  • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
  • 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 associated with the carrier gateway.

$sel:maxResults:DescribeCarrierGateways', describeCarrierGateways_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeCarrierGateways, describeCarrierGateways_nextToken - The token for the next page of results.

Request Lenses

describeCarrierGateways_carrierGatewayIds :: Lens' DescribeCarrierGateways (Maybe [Text]) Source #

One or more carrier gateway IDs.

describeCarrierGateways_dryRun :: Lens' DescribeCarrierGateways (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.

describeCarrierGateways_filters :: Lens' DescribeCarrierGateways (Maybe [Filter]) Source #

One or more filters.

  • carrier-gateway-id - The ID of the carrier gateway.
  • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
  • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
  • 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 associated with the carrier gateway.

describeCarrierGateways_maxResults :: Lens' DescribeCarrierGateways (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeCarrierGateways_nextToken :: Lens' DescribeCarrierGateways (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeCarrierGatewaysResponse Source #

See: newDescribeCarrierGatewaysResponse smart constructor.

Constructors

DescribeCarrierGatewaysResponse' 

Fields

Instances

Instances details
Generic DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Associated Types

type Rep DescribeCarrierGatewaysResponse :: Type -> Type #

Methods

from :: DescribeCarrierGatewaysResponse -> Rep DescribeCarrierGatewaysResponse x #

to :: Rep DescribeCarrierGatewaysResponse x -> DescribeCarrierGatewaysResponse #

Read DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

readsPrec :: Int -> ReadS DescribeCarrierGatewaysResponse #

readList :: ReadS [DescribeCarrierGatewaysResponse] #

readPrec :: ReadPrec DescribeCarrierGatewaysResponse #

readListPrec :: ReadPrec [DescribeCarrierGatewaysResponse] #

Show DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

showsPrec :: Int -> DescribeCarrierGatewaysResponse -> ShowS #

show :: DescribeCarrierGatewaysResponse -> String #

showList :: [DescribeCarrierGatewaysResponse] -> ShowS #

NFData DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

rnf :: DescribeCarrierGatewaysResponse -> () #

Eq DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

Methods

(==) :: DescribeCarrierGatewaysResponse -> DescribeCarrierGatewaysResponse -> Bool #

(/=) :: DescribeCarrierGatewaysResponse -> DescribeCarrierGatewaysResponse -> Bool #

type Rep DescribeCarrierGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeCarrierGateways

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

newDescribeCarrierGatewaysResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeCarrierGatewaysResponse'

-> DescribeCarrierGatewaysResponse 

Create a value of DescribeCarrierGatewaysResponse 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:carrierGateways:DescribeCarrierGatewaysResponse', describeCarrierGatewaysResponse_carrierGateways - Information about the carrier gateway.

DescribeCarrierGateways, describeCarrierGatewaysResponse_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:httpStatus:DescribeCarrierGatewaysResponse', describeCarrierGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeCarrierGatewaysResponse_carrierGateways :: Lens' DescribeCarrierGatewaysResponse (Maybe [CarrierGateway]) Source #

Information about the carrier gateway.

describeCarrierGatewaysResponse_nextToken :: Lens' DescribeCarrierGatewaysResponse (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.

describeCarrierGatewaysResponse_httpStatus :: Lens' DescribeCarrierGatewaysResponse Int Source #

The response's http status code.