Network.AWS.GameLift.ListAliases

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Alias-related operations include:

• CreateAlias
• ListAliases
• DescribeAlias
• UpdateAlias
• DeleteAlias
• ResolveAlias

Creating a Request

listAliases :: ListAliases

Creates a value of ListAliases with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• laRoutingStrategyType - Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include the following: * SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets. * TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
• laNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
• laName - Descriptive label that is associated with an alias. Alias names do not need to be unique.
• laLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

data ListAliases

Represents the input for a request action.

See: listAliases smart constructor.

Instances

Eq ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

(==) :: ListAliases -> ListAliases -> Bool

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

Data ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListAliases -> c ListAliases

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListAliases

toConstr :: ListAliases -> Constr

dataTypeOf :: ListAliases -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListAliases)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListAliases)

gmapT :: (forall b. Data b => b -> b) -> ListAliases -> ListAliases

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListAliases -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListAliases -> r

gmapQ :: (forall d. Data d => d -> u) -> ListAliases -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListAliases -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListAliases -> m ListAliases

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAliases -> m ListAliases

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAliases -> m ListAliases

Read ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliases

readList :: ReadS [ListAliases]

readPrec :: ReadPrec ListAliases

readListPrec :: ReadPrec [ListAliases]

Show ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

showsPrec :: Int -> ListAliases -> ShowS

show :: ListAliases -> String

showList :: [ListAliases] -> ShowS

Generic ListAliases

Defined in Network.AWS.GameLift.ListAliases

Associated Types

type Rep ListAliases :: Type -> Type

Methods

from :: ListAliases -> Rep ListAliases x

to :: Rep ListAliases x -> ListAliases

Hashable ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

hashWithSalt :: Int -> ListAliases -> Int

hash :: ListAliases -> Int

ToJSON ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

toJSON :: ListAliases -> Value

toEncoding :: ListAliases -> Encoding

toJSONList :: [ListAliases] -> Value

toEncodingList :: [ListAliases] -> Encoding

AWSRequest ListAliases

Defined in Network.AWS.GameLift.ListAliases

Associated Types

type Rs ListAliases :: Type

Methods

request :: ListAliases -> Request ListAliases

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListAliases -> ClientResponse -> m (Response ListAliases)

ToHeaders ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

toHeaders :: ListAliases -> [Header]

ToPath ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

toPath :: ListAliases -> ByteString

ToQuery ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

toQuery :: ListAliases -> QueryString

NFData ListAliases

Defined in Network.AWS.GameLift.ListAliases

Methods

rnf :: ListAliases -> ()

type Rep ListAliases

Defined in Network.AWS.GameLift.ListAliases

type Rep ListAliases = D1 (MetaData "ListAliases" "Network.AWS.GameLift.ListAliases" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "ListAliases'" PrefixI True) ((S1 (MetaSel (Just "_laRoutingStrategyType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RoutingStrategyType)) :*: S1 (MetaSel (Just "_laNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_laName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_laLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))

type Rs ListAliases

Defined in Network.AWS.GameLift.ListAliases

type Rs ListAliases = ListAliasesResponse

Request Lenses

laRoutingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType)

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include the following: * SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets. * TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

laNextToken :: Lens' ListAliases (Maybe Text)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

laName :: Lens' ListAliases (Maybe Text)

Descriptive label that is associated with an alias. Alias names do not need to be unique.

laLimit :: Lens' ListAliases (Maybe Natural)

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Destructuring the Response

listAliasesResponse

Arguments

:: Int

larsResponseStatus

-> ListAliasesResponse

Creates a value of ListAliasesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• larsAliases - Collection of alias records that match the list request.
• larsNextToken - Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
• larsResponseStatus - -- | The response status code.

data ListAliasesResponse

Represents the returned data in response to a request action.

See: listAliasesResponse smart constructor.

Instances

Eq ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Methods

(==) :: ListAliasesResponse -> ListAliasesResponse -> Bool

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

Data ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListAliasesResponse -> c ListAliasesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListAliasesResponse

toConstr :: ListAliasesResponse -> Constr

dataTypeOf :: ListAliasesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListAliasesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListAliasesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListAliasesResponse -> ListAliasesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListAliasesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListAliasesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListAliasesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListAliasesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListAliasesResponse -> m ListAliasesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAliasesResponse -> m ListAliasesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAliasesResponse -> m ListAliasesResponse

Read ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliasesResponse

readList :: ReadS [ListAliasesResponse]

readPrec :: ReadPrec ListAliasesResponse

readListPrec :: ReadPrec [ListAliasesResponse]

Show ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Methods

showsPrec :: Int -> ListAliasesResponse -> ShowS

show :: ListAliasesResponse -> String

showList :: [ListAliasesResponse] -> ShowS

Generic ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Associated Types

type Rep ListAliasesResponse :: Type -> Type

Methods

from :: ListAliasesResponse -> Rep ListAliasesResponse x

to :: Rep ListAliasesResponse x -> ListAliasesResponse

NFData ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

Methods

rnf :: ListAliasesResponse -> ()

type Rep ListAliasesResponse

Defined in Network.AWS.GameLift.ListAliases

type Rep ListAliasesResponse = D1 (MetaData "ListAliasesResponse" "Network.AWS.GameLift.ListAliases" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "ListAliasesResponse'" PrefixI True) (S1 (MetaSel (Just "_larsAliases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Alias])) :*: (S1 (MetaSel (Just "_larsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_larsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

larsAliases :: Lens' ListAliasesResponse [Alias]

Collection of alias records that match the list request.

larsNextToken :: Lens' ListAliasesResponse (Maybe Text)

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

larsResponseStatus :: Lens' ListAliasesResponse Int

• - | The response status code.