Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DescribeAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

All APIs by task

Synopsis

Creating a Request

data DescribeAlias Source #

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

ToJSON DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods toJSON :: DescribeAlias -> Value # toEncoding :: DescribeAlias -> Encoding # toJSONList :: [DescribeAlias] -> Value # toEncodingList :: [DescribeAlias] -> Encoding #
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 #
AWSRequest DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Associated Types type AWSResponse DescribeAlias # Methods request :: (Service -> Service) -> DescribeAlias -> Request DescribeAlias # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAlias))) #
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 #
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 #
NFData DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods rnf :: DescribeAlias -> () #
Eq DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods (==) :: DescribeAlias -> DescribeAlias -> Bool # (/=) :: DescribeAlias -> DescribeAlias -> Bool #
Hashable DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods hashWithSalt :: Int -> DescribeAlias -> Int # hash :: DescribeAlias -> Int #
type AWSResponse DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias type AWSResponse DescribeAlias = DescribeAliasResponse
type Rep DescribeAlias Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias type Rep DescribeAlias = D1 ('MetaData "DescribeAlias" "Amazonka.GameLift.DescribeAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAlias Source #

Arguments

:: Text	`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:

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 #

See: newDescribeAliasResponse smart constructor.

Constructors

DescribeAliasResponse'
Fields alias :: Maybe Alias The requested alias resource. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods rnf :: DescribeAliasResponse -> () #
Eq DescribeAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias Methods (==) :: DescribeAliasResponse -> DescribeAliasResponse -> Bool # (/=) :: DescribeAliasResponse -> DescribeAliasResponse -> Bool #
type Rep DescribeAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeAlias type Rep DescribeAliasResponse = D1 ('MetaData "DescribeAliasResponse" "Amazonka.GameLift.DescribeAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" '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.