amazonka-gamelift-1.6.0: Amazon GameLift SDK.

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

Network.AWS.GameLift.DescribeAlias

Contents

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.

Alias-related operations include:

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

Synopsis

Creating a Request

describeAlias #

Arguments

:: Text

dAliasId

-> DescribeAlias 

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

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

  • dAliasId - Unique identifier for a fleet alias. Specify the alias you want to retrieve.

data DescribeAlias #

Represents the input for a request action.

See: describeAlias smart constructor.

Instances

Eq DescribeAlias # 
Data DescribeAlias # 

Methods

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

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

toConstr :: DescribeAlias -> Constr #

dataTypeOf :: DescribeAlias -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAlias) #

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

gmapT :: (forall b. Data b => b -> b) -> DescribeAlias -> DescribeAlias #

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

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

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

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

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

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

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

Read DescribeAlias # 
Show DescribeAlias # 
Generic DescribeAlias # 

Associated Types

type Rep DescribeAlias :: * -> * #

Hashable DescribeAlias # 
ToJSON DescribeAlias # 
NFData DescribeAlias # 

Methods

rnf :: DescribeAlias -> () #

AWSRequest DescribeAlias # 
ToHeaders DescribeAlias # 
ToPath DescribeAlias # 
ToQuery DescribeAlias # 
type Rep DescribeAlias # 
type Rep DescribeAlias = D1 * (MetaData "DescribeAlias" "Network.AWS.GameLift.DescribeAlias" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" True) (C1 * (MetaCons "DescribeAlias'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dAliasId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs DescribeAlias # 

Request Lenses

dAliasId :: Lens' DescribeAlias Text #

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

Destructuring the Response

describeAliasResponse #

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

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

data DescribeAliasResponse #

Represents the returned data in response to a request action.

See: describeAliasResponse smart constructor.

Instances

Eq DescribeAliasResponse # 
Data DescribeAliasResponse # 

Methods

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

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

toConstr :: DescribeAliasResponse -> Constr #

dataTypeOf :: DescribeAliasResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAliasResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> DescribeAliasResponse -> DescribeAliasResponse #

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

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

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

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

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

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

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

Read DescribeAliasResponse # 
Show DescribeAliasResponse # 
Generic DescribeAliasResponse # 
NFData DescribeAliasResponse # 

Methods

rnf :: DescribeAliasResponse -> () #

type Rep DescribeAliasResponse # 
type Rep DescribeAliasResponse = D1 * (MetaData "DescribeAliasResponse" "Network.AWS.GameLift.DescribeAlias" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "DescribeAliasResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_darsAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Alias))) (S1 * (MetaSel (Just Symbol "_darsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

darsAlias :: Lens' DescribeAliasResponse (Maybe Alias) #

Object that contains the requested alias.

darsResponseStatus :: Lens' DescribeAliasResponse Int #

  • - | The response status code.