Network.AWS.APIGateway.UpdateStage

Changes information about a Stage resource.

Creating a Request

updateStage

Arguments

:: Text

usRestAPIId

-> Text

usStageName

-> UpdateStage

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

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

• usPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• usRestAPIId - [Required] The string identifier of the associated RestApi .
• usStageName - [Required] The name of the Stage resource to change information about.

data UpdateStage

Requests API Gateway to change information about a Stage resource.

See: updateStage smart constructor.

Instances

Eq UpdateStage

Methods

(==) :: UpdateStage -> UpdateStage -> Bool

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

Data UpdateStage

Methods

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

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

toConstr :: UpdateStage -> Constr

dataTypeOf :: UpdateStage -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateStage

Methods

readsPrec :: Int -> ReadS UpdateStage

readList :: ReadS [UpdateStage]

readPrec :: ReadPrec UpdateStage

readListPrec :: ReadPrec [UpdateStage]

Show UpdateStage

Methods

showsPrec :: Int -> UpdateStage -> ShowS

show :: UpdateStage -> String

showList :: [UpdateStage] -> ShowS

Generic UpdateStage

Associated Types

type Rep UpdateStage :: * -> *

Methods

from :: UpdateStage -> Rep UpdateStage x

to :: Rep UpdateStage x -> UpdateStage

Hashable UpdateStage

Methods

hashWithSalt :: Int -> UpdateStage -> Int

hash :: UpdateStage -> Int

ToJSON UpdateStage

Methods

toJSON :: UpdateStage -> Value

toEncoding :: UpdateStage -> Encoding

toJSONList :: [UpdateStage] -> Value

toEncodingList :: [UpdateStage] -> Encoding

NFData UpdateStage

Methods

rnf :: UpdateStage -> ()

AWSRequest UpdateStage

Associated Types

type Rs UpdateStage :: *

Methods

request :: UpdateStage -> Request UpdateStage

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateStage -> ClientResponse -> m (Response UpdateStage)

ToHeaders UpdateStage

Methods

toHeaders :: UpdateStage -> [Header]

ToPath UpdateStage

Methods

toPath :: UpdateStage -> ByteString

ToQuery UpdateStage

Methods

toQuery :: UpdateStage -> QueryString

type Rep UpdateStage

type Rep UpdateStage = D1 * (MetaData "UpdateStage" "Network.AWS.APIGateway.UpdateStage" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "UpdateStage'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_usPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PatchOperation]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_usStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs UpdateStage

type Rs UpdateStage = Stage

Request Lenses

usPatchOperations :: Lens' UpdateStage [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

usRestAPIId :: Lens' UpdateStage Text

Required

The string identifier of the associated RestApi .

usStageName :: Lens' UpdateStage Text

Required

The name of the Stage resource to change 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-._~:/?#&=,]+ .
• sAccessLogSettings - Settings for logging access in this stage.
• 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.
• sCanarySettings - Settings for the canary deployment in this stage.
• 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 API Gateway.
• sDescription - The stage's description.
• sTags - The collection of tags. Each tag element is associated with a given resource.

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.6.0-JJ9NJtNe0aRBcVRYpJCEA2" 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 "_sAccessLogSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AccessLogSettings))))) ((:*:) * ((:*:) * (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 "_sCanarySettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CanarySettings))))) ((:*:) * ((:*:) * (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))) (S1 * (MetaSel (Just Symbol "_sTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text 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-._~:/?#&=,]+ .

sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings)

Settings for logging access in this stage.

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.

sCanarySettings :: Lens' Stage (Maybe CanarySettings)

Settings for the canary deployment in this stage.

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 API Gateway.

sDescription :: Lens' Stage (Maybe Text)

The stage's description.

sTags :: Lens' Stage (HashMap Text Text)

The collection of tags. Each tag element is associated with a given resource.