libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.DescribeAlias

Description

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Synopsis

Creating a Request

data DescribeAlias Source #

Represents the input for a request operation.

See: newDescribeAlias smart constructor.

Constructors

DescribeAlias' 

Fields

  • aliasId :: Text

    The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Instances

Instances details
Eq DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

(==) :: DescribeAlias -> DescribeAlias -> Bool #

(/=) :: DescribeAlias -> DescribeAlias -> Bool #

Read DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

readsPrec :: Int -> ReadS DescribeAlias #

readList :: ReadS [DescribeAlias] #

readPrec :: ReadPrec DescribeAlias #

readListPrec :: ReadPrec [DescribeAlias] #

Show DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

showsPrec :: Int -> DescribeAlias -> ShowS #

show :: DescribeAlias -> String #

showList :: [DescribeAlias] -> ShowS #

Generic DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Associated Types

type Rep DescribeAlias :: Type -> Type #

Methods

from :: DescribeAlias -> Rep DescribeAlias x #

to :: Rep DescribeAlias x -> DescribeAlias #

NFData DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

rnf :: DescribeAlias -> () #

Hashable DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

hashWithSalt :: Int -> DescribeAlias -> Int #

hash :: DescribeAlias -> Int #

ToJSON DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

toJSON :: DescribeAlias -> Value #

toEncoding :: DescribeAlias -> Encoding #

toJSONList :: [DescribeAlias] -> Value #

toEncodingList :: [DescribeAlias] -> Encoding #

AWSRequest DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Associated Types

type AWSResponse DescribeAlias #

Methods

request :: DescribeAlias -> Request DescribeAlias #

response :: MonadResource m => Logger -> Service -> Proxy DescribeAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlias))) #

ToHeaders DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

toHeaders :: DescribeAlias -> [Header] #

ToPath DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

toPath :: DescribeAlias -> ByteString #

ToQuery DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

toQuery :: DescribeAlias -> QueryString #

type Rep DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

type Rep DescribeAlias = D1 ('MetaData "DescribeAlias" "Amazonka.GameLift.DescribeAlias" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeAlias Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

type AWSResponse DescribeAlias = DescribeAliasResponse

newDescribeAlias Source #

Arguments

:: Text

$sel:aliasId:DescribeAlias'

-> DescribeAlias 

Create a value of DescribeAlias 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:aliasId:DescribeAlias', describeAlias_aliasId - The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Request Lenses

describeAlias_aliasId :: Lens' DescribeAlias Text Source #

The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Destructuring the Response

data DescribeAliasResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeAliasResponse smart constructor.

Constructors

DescribeAliasResponse' 

Fields

Instances

Instances details
Eq DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

(==) :: DescribeAliasResponse -> DescribeAliasResponse -> Bool #

(/=) :: DescribeAliasResponse -> DescribeAliasResponse -> Bool #

Read DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

readsPrec :: Int -> ReadS DescribeAliasResponse #

readList :: ReadS [DescribeAliasResponse] #

readPrec :: ReadPrec DescribeAliasResponse #

readListPrec :: ReadPrec [DescribeAliasResponse] #

Show DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

showsPrec :: Int -> DescribeAliasResponse -> ShowS #

show :: DescribeAliasResponse -> String #

showList :: [DescribeAliasResponse] -> ShowS #

Generic DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Associated Types

type Rep DescribeAliasResponse :: Type -> Type #

Methods

from :: DescribeAliasResponse -> Rep DescribeAliasResponse x #

to :: Rep DescribeAliasResponse x -> DescribeAliasResponse #

NFData DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

Methods

rnf :: DescribeAliasResponse -> () #

type Rep DescribeAliasResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeAlias

type Rep DescribeAliasResponse = D1 ('MetaData "DescribeAliasResponse" "Amazonka.GameLift.DescribeAlias" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeAliasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alias)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAliasResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAliasResponse'

-> DescribeAliasResponse 

Create a value of DescribeAliasResponse 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:alias:DescribeAliasResponse', describeAliasResponse_alias - The requested alias resource.

$sel:httpStatus:DescribeAliasResponse', describeAliasResponse_httpStatus - The response's http status code.

Response Lenses

describeAliasResponse_alias :: Lens' DescribeAliasResponse (Maybe Alias) Source #

The requested alias resource.

describeAliasResponse_httpStatus :: Lens' DescribeAliasResponse Int Source #

The response's http status code.