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

Description

Describes the allocations from the specified customer-owned address pool.

Synopsis

Creating a Request

data GetCoipPoolUsage Source #

See: newGetCoipPoolUsage smart constructor.

Constructors

GetCoipPoolUsage' 

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.

    • coip-address-usage.allocation-id - The allocation ID of the address.
    • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
    • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
    • coip-address-usage.co-ip - The customer-owned IP address.
  • 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.

  • poolId :: Text

    The ID of the address pool.

Instances

Instances details
ToHeaders GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

ToPath GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

ToQuery GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

AWSRequest GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Associated Types

type AWSResponse GetCoipPoolUsage #

Generic GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Associated Types

type Rep GetCoipPoolUsage :: Type -> Type #

Read GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Show GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

NFData GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Methods

rnf :: GetCoipPoolUsage -> () #

Eq GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Hashable GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

type AWSResponse GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

type Rep GetCoipPoolUsage Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

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

newGetCoipPoolUsage Source #

Create a value of GetCoipPoolUsage 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:GetCoipPoolUsage', getCoipPoolUsage_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:GetCoipPoolUsage', getCoipPoolUsage_filters - One or more filters.

  • coip-address-usage.allocation-id - The allocation ID of the address.
  • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
  • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
  • coip-address-usage.co-ip - The customer-owned IP address.

$sel:maxResults:GetCoipPoolUsage', getCoipPoolUsage_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.

$sel:nextToken:GetCoipPoolUsage', getCoipPoolUsage_nextToken - The token for the next page of results.

GetCoipPoolUsage, getCoipPoolUsage_poolId - The ID of the address pool.

Request Lenses

getCoipPoolUsage_dryRun :: Lens' GetCoipPoolUsage (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.

getCoipPoolUsage_filters :: Lens' GetCoipPoolUsage (Maybe [Filter]) Source #

One or more filters.

  • coip-address-usage.allocation-id - The allocation ID of the address.
  • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
  • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
  • coip-address-usage.co-ip - The customer-owned IP address.

getCoipPoolUsage_maxResults :: Lens' GetCoipPoolUsage (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.

getCoipPoolUsage_nextToken :: Lens' GetCoipPoolUsage (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data GetCoipPoolUsageResponse Source #

See: newGetCoipPoolUsageResponse smart constructor.

Constructors

GetCoipPoolUsageResponse' 

Fields

Instances

Instances details
Generic GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Associated Types

type Rep GetCoipPoolUsageResponse :: Type -> Type #

Read GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Show GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

NFData GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

Eq GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

type Rep GetCoipPoolUsageResponse Source # 
Instance details

Defined in Amazonka.EC2.GetCoipPoolUsage

type Rep GetCoipPoolUsageResponse = D1 ('MetaData "GetCoipPoolUsageResponse" "Amazonka.EC2.GetCoipPoolUsage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetCoipPoolUsageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "coipAddressUsages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CoipAddressUsage])) :*: S1 ('MetaSel ('Just "coipPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "localGatewayRouteTableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCoipPoolUsageResponse Source #

Create a value of GetCoipPoolUsageResponse 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:coipAddressUsages:GetCoipPoolUsageResponse', getCoipPoolUsageResponse_coipAddressUsages - Information about the address usage.

GetCoipPoolUsageResponse, getCoipPoolUsageResponse_coipPoolId - The ID of the customer-owned address pool.

GetCoipPoolUsageResponse, getCoipPoolUsageResponse_localGatewayRouteTableId - The ID of the local gateway route table.

$sel:httpStatus:GetCoipPoolUsageResponse', getCoipPoolUsageResponse_httpStatus - The response's http status code.

Response Lenses