Network.AWS.APIGateway.GetStage

Gets information about a Stage resource.

Creating a Request

getStage

Arguments

:: Text

gssRestAPIId

-> Text

gssStageName

-> GetStage

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

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

• gssRestAPIId - The string identifier of the associated RestApi .
• gssStageName - The name of the Stage resource to get information about.

data GetStage

Requests Amazon API Gateway to get information about a Stage resource.

See: getStage smart constructor.

Instances

Eq GetStage

Methods

(==) :: GetStage -> GetStage -> Bool

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

Data GetStage

Methods

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

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

toConstr :: GetStage -> Constr

dataTypeOf :: GetStage -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetStage

Methods

readsPrec :: Int -> ReadS GetStage

readList :: ReadS [GetStage]

readPrec :: ReadPrec GetStage

readListPrec :: ReadPrec [GetStage]

Show GetStage

Methods

showsPrec :: Int -> GetStage -> ShowS

show :: GetStage -> String

showList :: [GetStage] -> ShowS

Generic GetStage

Associated Types

type Rep GetStage :: * -> *

Methods

from :: GetStage -> Rep GetStage x

to :: Rep GetStage x -> GetStage

Hashable GetStage

Methods

hashWithSalt :: Int -> GetStage -> Int

hash :: GetStage -> Int

NFData GetStage

Methods

rnf :: GetStage -> ()

AWSRequest GetStage

Associated Types

type Rs GetStage :: *

Methods

request :: GetStage -> Request GetStage

response :: MonadResource m => Logger -> Service -> Proxy * GetStage -> ClientResponse -> m (Response GetStage)

ToQuery GetStage

Methods

toQuery :: GetStage -> QueryString

ToPath GetStage

Methods

toPath :: GetStage -> ByteString

ToHeaders GetStage

Methods

toHeaders :: GetStage -> [Header]

type Rep GetStage

type Rep GetStage = D1 (MetaData "GetStage" "Network.AWS.APIGateway.GetStage" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetStage'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gssRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gssStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetStage

type Rs GetStage = Stage

Request Lenses

gssRestAPIId :: Lens' GetStage Text

The string identifier of the associated RestApi .

gssStageName :: Lens' GetStage Text

The name of the Stage resource to get information about.

Destructuring the Response

stage :: Stage

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

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

• sDeploymentId - The identifier of the Deployment that the stage points to.
• sVariables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .
• sDocumentationVersion - The version of the associated API documentation.
• sClientCertificateId - The identifier of a client certificate for an API stage.
• sCreatedDate - The timestamp when the stage was created.
• sCacheClusterStatus - The status of the cache cluster for the stage, if enabled.
• sMethodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or ** for overriding all methods in the stage.
• sLastUpdatedDate - The timestamp when the stage last updated.
• sCacheClusterSize - The size of the cache cluster for the stage, if enabled.
• sCacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.
• sStageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
• sDescription - The stage's description.

data Stage

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

See: stage smart constructor.

Instances

Eq Stage

Methods

(==) :: Stage -> Stage -> Bool

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

Data Stage

Methods

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

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

toConstr :: Stage -> Constr

dataTypeOf :: Stage -> DataType

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

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

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

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

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

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

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

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

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

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

Read Stage

Methods

readsPrec :: Int -> ReadS Stage

readList :: ReadS [Stage]

readPrec :: ReadPrec Stage

readListPrec :: ReadPrec [Stage]

Show Stage

Methods

showsPrec :: Int -> Stage -> ShowS

show :: Stage -> String

showList :: [Stage] -> ShowS

Generic Stage

Associated Types

type Rep Stage :: * -> *

Methods

from :: Stage -> Rep Stage x

to :: Rep Stage x -> Stage

Hashable Stage

Methods

hashWithSalt :: Int -> Stage -> Int

hash :: Stage -> Int

FromJSON Stage

Methods

parseJSON :: Value -> Parser Stage

parseJSONList :: Value -> Parser [Stage]

NFData Stage

Methods

rnf :: Stage -> ()

type Rep Stage

type Rep Stage = D1 (MetaData "Stage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Stage'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_sDocumentationVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_sClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_sCacheClusterStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sMethodSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodSetting)))) ((:*:) (S1 (MetaSel (Just Symbol "_sLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_sCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize))))) ((:*:) (S1 (MetaSel (Just Symbol "_sCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_sStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

Response Lenses

sDeploymentId :: Lens' Stage (Maybe Text)

The identifier of the Deployment that the stage points to.

sVariables :: Lens' Stage (HashMap Text Text)

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .

sDocumentationVersion :: Lens' Stage (Maybe Text)

The version of the associated API documentation.

sClientCertificateId :: Lens' Stage (Maybe Text)

The identifier of a client certificate for an API stage.

sCreatedDate :: Lens' Stage (Maybe UTCTime)

The timestamp when the stage was created.

sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)

The status of the cache cluster for the stage, if enabled.

sMethodSettings :: Lens' Stage (HashMap Text MethodSetting)

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or ** for overriding all methods in the stage.

sLastUpdatedDate :: Lens' Stage (Maybe UTCTime)

The timestamp when the stage last updated.

sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)

The size of the cache cluster for the stage, if enabled.

sCacheClusterEnabled :: Lens' Stage (Maybe Bool)

Specifies whether a cache cluster is enabled for the stage.

sStageName :: Lens' Stage (Maybe Text)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

sDescription :: Lens' Stage (Maybe Text)

The stage's description.