Amazonka.GameLift.ListAliases

Retrieves all aliases for this Amazon Web Services 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.

Returned aliases are not listed in any particular order.

Related actions

All APIs by task

This operation returns paginated results.

Creating a Request

data ListAliases

See: newListAliases smart constructor.

Constructors

ListAliases'

Fields

• limit :: Maybe Natural

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

• name :: Maybe Text

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

• nextToken :: Maybe Text

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

• routingStrategyType :: Maybe RoutingStrategyType

  The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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.

Instances

ToJSON ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

toJSON :: ListAliases -> Value

toEncoding :: ListAliases -> Encoding

toJSONList :: [ListAliases] -> Value

toEncodingList :: [ListAliases] -> Encoding

ToHeaders ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

toHeaders :: ListAliases -> [Header]

ToPath ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

toPath :: ListAliases -> ByteString

ToQuery ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

toQuery :: ListAliases -> QueryString

AWSPager ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

page :: ListAliases -> AWSResponse ListAliases -> Maybe ListAliases

AWSRequest ListAliases

Defined in Amazonka.GameLift.ListAliases

Associated Types

type AWSResponse ListAliases

Methods

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

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

Generic ListAliases

Defined in Amazonka.GameLift.ListAliases

Associated Types

type Rep ListAliases :: Type -> Type

Methods

from :: ListAliases -> Rep ListAliases x

to :: Rep ListAliases x -> ListAliases

Read ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliases

readList :: ReadS [ListAliases]

readPrec :: ReadPrec ListAliases

readListPrec :: ReadPrec [ListAliases]

Show ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

showsPrec :: Int -> ListAliases -> ShowS

show :: ListAliases -> String

showList :: [ListAliases] -> ShowS

NFData ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

rnf :: ListAliases -> ()

Eq ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

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

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

Hashable ListAliases

Defined in Amazonka.GameLift.ListAliases

Methods

hashWithSalt :: Int -> ListAliases -> Int

hash :: ListAliases -> Int

type AWSResponse ListAliases

Defined in Amazonka.GameLift.ListAliases

type AWSResponse ListAliases = ListAliasesResponse

type Rep ListAliases

Defined in Amazonka.GameLift.ListAliases

type Rep ListAliases = D1 ('MetaData "ListAliases" "Amazonka.GameLift.ListAliases" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routingStrategyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingStrategyType)))))

newListAliases :: ListAliases

Create a value of ListAliases 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:limit:ListAliases', listAliases_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

ListAliases, listAliases_name - A descriptive label that is associated with an alias. Alias names do not need to be unique.

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

$sel:routingStrategyType:ListAliases', listAliases_routingStrategyType - The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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.

Request Lenses

listAliases_limit :: Lens' ListAliases (Maybe Natural)

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

listAliases_name :: Lens' ListAliases (Maybe Text)

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

listAliases_nextToken :: Lens' ListAliases (Maybe Text)

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

listAliases_routingStrategyType :: Lens' ListAliases (Maybe RoutingStrategyType)

The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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.

Destructuring the Response

data ListAliasesResponse

See: newListAliasesResponse smart constructor.

Constructors

ListAliasesResponse'

Fields

• aliases :: Maybe [Alias]

  A collection of alias resources that match the request parameters.

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

Associated Types

type Rep ListAliasesResponse :: Type -> Type

Methods

from :: ListAliasesResponse -> Rep ListAliasesResponse x

to :: Rep ListAliasesResponse x -> ListAliasesResponse

Read ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

Methods

readsPrec :: Int -> ReadS ListAliasesResponse

readList :: ReadS [ListAliasesResponse]

readPrec :: ReadPrec ListAliasesResponse

readListPrec :: ReadPrec [ListAliasesResponse]

Show ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

Methods

showsPrec :: Int -> ListAliasesResponse -> ShowS

show :: ListAliasesResponse -> String

showList :: [ListAliasesResponse] -> ShowS

NFData ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

Methods

rnf :: ListAliasesResponse -> ()

Eq ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

Methods

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

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

type Rep ListAliasesResponse

Defined in Amazonka.GameLift.ListAliases

type Rep ListAliasesResponse = D1 ('MetaData "ListAliasesResponse" "Amazonka.GameLift.ListAliases" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "ListAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Alias])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAliasesResponse

Arguments

:: Int

$sel:httpStatus:ListAliasesResponse'

-> ListAliasesResponse

Create a value of ListAliasesResponse 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:aliases:ListAliasesResponse', listAliasesResponse_aliases - A collection of alias resources that match the request parameters.

ListAliases, listAliasesResponse_nextToken - A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

$sel:httpStatus:ListAliasesResponse', listAliasesResponse_httpStatus - The response's http status code.

Response Lenses

listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [Alias])

A collection of alias resources that match the request parameters.

listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text)

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

listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int

The response's http status code.