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

Description

Gets information about the prefix list references in a specified transit gateway route table.

This operation returns paginated results.

Synopsis

Creating a Request

data GetTransitGatewayPrefixListReferences Source #

Constructors

GetTransitGatewayPrefixListReferences' 

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. The possible values are:

    • attachment.resource-id - The ID of the resource for the attachment.
    • attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
    • attachment.transit-gateway-attachment-id - The ID of the attachment.
    • is-blackhole - Whether traffic matching the route is blocked (true | false).
    • prefix-list-id - The ID of the prefix list.
    • prefix-list-owner-id - The ID of the owner of the prefix list.
    • state - The state of the prefix list reference (pending | available | modifying | deleting).
  • 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.

  • transitGatewayRouteTableId :: Text

    The ID of the transit gateway route table.

Instances

Instances details
ToHeaders GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

ToPath GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

ToQuery GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

AWSPager GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

AWSRequest GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Generic GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Read GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Show GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

NFData GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Eq GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Hashable GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

type AWSResponse GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

type Rep GetTransitGatewayPrefixListReferences Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

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

newGetTransitGatewayPrefixListReferences Source #

Create a value of GetTransitGatewayPrefixListReferences 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:GetTransitGatewayPrefixListReferences', getTransitGatewayPrefixListReferences_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:GetTransitGatewayPrefixListReferences', getTransitGatewayPrefixListReferences_filters - One or more filters. The possible values are:

  • attachment.resource-id - The ID of the resource for the attachment.
  • attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
  • attachment.transit-gateway-attachment-id - The ID of the attachment.
  • is-blackhole - Whether traffic matching the route is blocked (true | false).
  • prefix-list-id - The ID of the prefix list.
  • prefix-list-owner-id - The ID of the owner of the prefix list.
  • state - The state of the prefix list reference (pending | available | modifying | deleting).

$sel:maxResults:GetTransitGatewayPrefixListReferences', getTransitGatewayPrefixListReferences_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.

GetTransitGatewayPrefixListReferences, getTransitGatewayPrefixListReferences_nextToken - The token for the next page of results.

GetTransitGatewayPrefixListReferences, getTransitGatewayPrefixListReferences_transitGatewayRouteTableId - The ID of the transit gateway route table.

Request Lenses

getTransitGatewayPrefixListReferences_dryRun :: Lens' GetTransitGatewayPrefixListReferences (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.

getTransitGatewayPrefixListReferences_filters :: Lens' GetTransitGatewayPrefixListReferences (Maybe [Filter]) Source #

One or more filters. The possible values are:

  • attachment.resource-id - The ID of the resource for the attachment.
  • attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
  • attachment.transit-gateway-attachment-id - The ID of the attachment.
  • is-blackhole - Whether traffic matching the route is blocked (true | false).
  • prefix-list-id - The ID of the prefix list.
  • prefix-list-owner-id - The ID of the owner of the prefix list.
  • state - The state of the prefix list reference (pending | available | modifying | deleting).

getTransitGatewayPrefixListReferences_maxResults :: Lens' GetTransitGatewayPrefixListReferences (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.

Destructuring the Response

data GetTransitGatewayPrefixListReferencesResponse Source #

Constructors

GetTransitGatewayPrefixListReferencesResponse' 

Fields

Instances

Instances details
Generic GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Read GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Show GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

NFData GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

Eq GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

type Rep GetTransitGatewayPrefixListReferencesResponse Source # 
Instance details

Defined in Amazonka.EC2.GetTransitGatewayPrefixListReferences

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

newGetTransitGatewayPrefixListReferencesResponse Source #

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

GetTransitGatewayPrefixListReferences, getTransitGatewayPrefixListReferencesResponse_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:transitGatewayPrefixListReferences:GetTransitGatewayPrefixListReferencesResponse', getTransitGatewayPrefixListReferencesResponse_transitGatewayPrefixListReferences - Information about the prefix list references.

$sel:httpStatus:GetTransitGatewayPrefixListReferencesResponse', getTransitGatewayPrefixListReferencesResponse_httpStatus - The response's http status code.

Response Lenses

getTransitGatewayPrefixListReferencesResponse_nextToken :: Lens' GetTransitGatewayPrefixListReferencesResponse (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.