amazonka-apigateway-1.3.7: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.UpdateStage

Contents

Description

Changes information about a Stage resource.

See: AWS API Reference for UpdateStage.

Synopsis

Creating a Request

updateStage Source

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:

Request Lenses

usPatchOperations :: Lens' UpdateStage [PatchOperation] Source

A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.

usRestAPIId :: Lens' UpdateStage Text Source

The identifier of the RestApi resource for the Stage resource to change information about.

usStageName :: Lens' UpdateStage Text Source

The name of the Stage resource to change information about.

Destructuring the Response

stage :: Stage Source

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:

data Stage Source

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

See: stage smart constructor.

Response Lenses

sDeploymentId :: Lens' Stage (Maybe Text) Source

The identifier of the Deployment that the stage points to.

sVariables :: Lens' Stage (HashMap Text Text) Source

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

sClientCertificateId :: Lens' Stage (Maybe Text) Source

Undocumented member.

sCreatedDate :: Lens' Stage (Maybe UTCTime) Source

The date and time that the stage was created, in ISO 8601 format.

sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source

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

sMethodSettings :: Lens' Stage (HashMap Text MethodSetting) Source

A map that defines the method settings for a Stage resource. Keys are defined as '{resource_path}/{http_method}' for an individual method override, or \\*\/\\* for the settings applied to all methods in the stage.

sLastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source

The date and time that information about the stage was last updated, in ISO 8601 format.

sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source

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

sCacheClusterEnabled :: Lens' Stage (Maybe Bool) Source

Specifies whether a cache cluster is enabled for the stage.

sStageName :: Lens' Stage (Maybe Text) Source

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) Source

The stage's description.