Amazonka.Route53RecoveryCluster.ListRoutingControls

List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.

A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.

/You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC./

Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:

• Viewing and updating routing control states
• Working with routing controls in Route 53 ARC

This operation returns paginated results.

Creating a Request

data ListRoutingControls

See: newListRoutingControls smart constructor.

Constructors

ListRoutingControls'

Fields

• controlPanelArn :: Maybe Text

  The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

• maxResults :: Maybe Natural

  The number of routing controls objects that you want to return with this call. The default value is 500.

• nextToken :: Maybe Text

  The token for the next set of results. You receive this token from a previous call.

Instances

ToJSON ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

toJSON :: ListRoutingControls -> Value

toEncoding :: ListRoutingControls -> Encoding

toJSONList :: [ListRoutingControls] -> Value

toEncodingList :: [ListRoutingControls] -> Encoding

ToHeaders ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

toHeaders :: ListRoutingControls -> [Header]

ToPath ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

toPath :: ListRoutingControls -> ByteString

ToQuery ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

toQuery :: ListRoutingControls -> QueryString

AWSPager ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

page :: ListRoutingControls -> AWSResponse ListRoutingControls -> Maybe ListRoutingControls

AWSRequest ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Associated Types

type AWSResponse ListRoutingControls

Methods

request :: (Service -> Service) -> ListRoutingControls -> Request ListRoutingControls

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

Generic ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Associated Types

type Rep ListRoutingControls :: Type -> Type

Methods

from :: ListRoutingControls -> Rep ListRoutingControls x

to :: Rep ListRoutingControls x -> ListRoutingControls

Read ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

readsPrec :: Int -> ReadS ListRoutingControls

readList :: ReadS [ListRoutingControls]

readPrec :: ReadPrec ListRoutingControls

readListPrec :: ReadPrec [ListRoutingControls]

Show ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

showsPrec :: Int -> ListRoutingControls -> ShowS

show :: ListRoutingControls -> String

showList :: [ListRoutingControls] -> ShowS

NFData ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

rnf :: ListRoutingControls -> ()

Eq ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

(==) :: ListRoutingControls -> ListRoutingControls -> Bool

(/=) :: ListRoutingControls -> ListRoutingControls -> Bool

Hashable ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

hashWithSalt :: Int -> ListRoutingControls -> Int

hash :: ListRoutingControls -> Int

type AWSResponse ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

type AWSResponse ListRoutingControls = ListRoutingControlsResponse

type Rep ListRoutingControls

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

type Rep ListRoutingControls = D1 ('MetaData "ListRoutingControls" "Amazonka.Route53RecoveryCluster.ListRoutingControls" "amazonka-route53-recovery-cluster-2.0-DxeQnRCPOPo1FMbWCdEnyv" 'False) (C1 ('MetaCons "ListRoutingControls'" 'PrefixI 'True) (S1 ('MetaSel ('Just "controlPanelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListRoutingControls :: ListRoutingControls

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

ListRoutingControls, listRoutingControls_controlPanelArn - The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

$sel:maxResults:ListRoutingControls', listRoutingControls_maxResults - The number of routing controls objects that you want to return with this call. The default value is 500.

ListRoutingControls, listRoutingControls_nextToken - The token for the next set of results. You receive this token from a previous call.

Request Lenses

listRoutingControls_controlPanelArn :: Lens' ListRoutingControls (Maybe Text)

The Amazon Resource Name (ARN) of the control panel of the routing controls to list.

listRoutingControls_maxResults :: Lens' ListRoutingControls (Maybe Natural)

The number of routing controls objects that you want to return with this call. The default value is 500.

listRoutingControls_nextToken :: Lens' ListRoutingControls (Maybe Text)

The token for the next set of results. You receive this token from a previous call.

Destructuring the Response

data ListRoutingControlsResponse

See: newListRoutingControlsResponse smart constructor.

Constructors

ListRoutingControlsResponse'

Fields

• nextToken :: Maybe Text

  The token for the next set of results. You receive this token from a previous call.

• httpStatus :: Int

  The response's http status code.

• routingControls :: [RoutingControl]

  The list of routing controls.

Instances

Generic ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Associated Types

type Rep ListRoutingControlsResponse :: Type -> Type

Methods

from :: ListRoutingControlsResponse -> Rep ListRoutingControlsResponse x

to :: Rep ListRoutingControlsResponse x -> ListRoutingControlsResponse

Read ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

readsPrec :: Int -> ReadS ListRoutingControlsResponse

readList :: ReadS [ListRoutingControlsResponse]

readPrec :: ReadPrec ListRoutingControlsResponse

readListPrec :: ReadPrec [ListRoutingControlsResponse]

Show ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

showsPrec :: Int -> ListRoutingControlsResponse -> ShowS

show :: ListRoutingControlsResponse -> String

showList :: [ListRoutingControlsResponse] -> ShowS

NFData ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

rnf :: ListRoutingControlsResponse -> ()

Eq ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

Methods

(==) :: ListRoutingControlsResponse -> ListRoutingControlsResponse -> Bool

(/=) :: ListRoutingControlsResponse -> ListRoutingControlsResponse -> Bool

type Rep ListRoutingControlsResponse

Defined in Amazonka.Route53RecoveryCluster.ListRoutingControls

type Rep ListRoutingControlsResponse = D1 ('MetaData "ListRoutingControlsResponse" "Amazonka.Route53RecoveryCluster.ListRoutingControls" "amazonka-route53-recovery-cluster-2.0-DxeQnRCPOPo1FMbWCdEnyv" 'False) (C1 ('MetaCons "ListRoutingControlsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "routingControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RoutingControl]))))

newListRoutingControlsResponse

Arguments

:: Int

$sel:httpStatus:ListRoutingControlsResponse'

-> ListRoutingControlsResponse

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

ListRoutingControls, listRoutingControlsResponse_nextToken - The token for the next set of results. You receive this token from a previous call.

$sel:httpStatus:ListRoutingControlsResponse', listRoutingControlsResponse_httpStatus - The response's http status code.

$sel:routingControls:ListRoutingControlsResponse', listRoutingControlsResponse_routingControls - The list of routing controls.

Response Lenses

listRoutingControlsResponse_nextToken :: Lens' ListRoutingControlsResponse (Maybe Text)

The token for the next set of results. You receive this token from a previous call.

listRoutingControlsResponse_httpStatus :: Lens' ListRoutingControlsResponse Int

The response's http status code.

listRoutingControlsResponse_routingControls :: Lens' ListRoutingControlsResponse [RoutingControl]

The list of routing controls.