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

Description

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGatewayRouteTables Source #

See: newDescribeTransitGatewayRouteTables smart constructor.

Constructors

DescribeTransitGatewayRouteTables' 

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:

    • default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
    • default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
    • state - The state of the route table (available | deleting | deleted | pending).
    • transit-gateway-id - The ID of the transit gateway.
    • transit-gateway-route-table-id - The ID of the transit gateway route table.
  • 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.

  • transitGatewayRouteTableIds :: Maybe [Text]

    The IDs of the transit gateway route tables.

Instances

Instances details
ToHeaders DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

ToPath DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

ToQuery DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

AWSPager DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

AWSRequest DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Generic DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Associated Types

type Rep DescribeTransitGatewayRouteTables :: Type -> Type #

Read DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Show DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

NFData DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Eq DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Hashable DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

type AWSResponse DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

type Rep DescribeTransitGatewayRouteTables Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

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

newDescribeTransitGatewayRouteTables :: DescribeTransitGatewayRouteTables Source #

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

  • default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
  • default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
  • state - The state of the route table (available | deleting | deleted | pending).
  • transit-gateway-id - The ID of the transit gateway.
  • transit-gateway-route-table-id - The ID of the transit gateway route table.

$sel:maxResults:DescribeTransitGatewayRouteTables', describeTransitGatewayRouteTables_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.

DescribeTransitGatewayRouteTables, describeTransitGatewayRouteTables_nextToken - The token for the next page of results.

$sel:transitGatewayRouteTableIds:DescribeTransitGatewayRouteTables', describeTransitGatewayRouteTables_transitGatewayRouteTableIds - The IDs of the transit gateway route tables.

Request Lenses

describeTransitGatewayRouteTables_dryRun :: Lens' DescribeTransitGatewayRouteTables (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.

describeTransitGatewayRouteTables_filters :: Lens' DescribeTransitGatewayRouteTables (Maybe [Filter]) Source #

One or more filters. The possible values are:

  • default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
  • default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
  • state - The state of the route table (available | deleting | deleted | pending).
  • transit-gateway-id - The ID of the transit gateway.
  • transit-gateway-route-table-id - The ID of the transit gateway route table.

describeTransitGatewayRouteTables_maxResults :: Lens' DescribeTransitGatewayRouteTables (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 DescribeTransitGatewayRouteTablesResponse Source #

Constructors

DescribeTransitGatewayRouteTablesResponse' 

Fields

Instances

Instances details
Generic DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Read DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Show DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

NFData DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

Eq DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

type Rep DescribeTransitGatewayRouteTablesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeTransitGatewayRouteTables

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

newDescribeTransitGatewayRouteTablesResponse Source #

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

DescribeTransitGatewayRouteTables, describeTransitGatewayRouteTablesResponse_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:transitGatewayRouteTables:DescribeTransitGatewayRouteTablesResponse', describeTransitGatewayRouteTablesResponse_transitGatewayRouteTables - Information about the transit gateway route tables.

$sel:httpStatus:DescribeTransitGatewayRouteTablesResponse', describeTransitGatewayRouteTablesResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewayRouteTablesResponse_nextToken :: Lens' DescribeTransitGatewayRouteTablesResponse (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.