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

Amazonka.APIGateway.UpdateStage

Description

Changes information about a Stage resource.

Synopsis

Creating a Request

data UpdateStage Source #

Requests API Gateway to change information about a Stage resource.

See: newUpdateStage smart constructor.

Constructors

UpdateStage' 

Fields

  • patchOperations :: Maybe [PatchOperation]

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

  • restApiId :: Text
    Required
    The string identifier of the associated RestApi.
  • stageName :: Text
    Required
    The name of the Stage resource to change information about.

Instances

Instances details
Eq UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Read UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Show UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Generic UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Associated Types

type Rep UpdateStage :: Type -> Type #

NFData UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Methods

rnf :: UpdateStage -> () #

Hashable UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

ToJSON UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

AWSRequest UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Associated Types

type AWSResponse UpdateStage #

ToHeaders UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

Methods

toHeaders :: UpdateStage -> [Header] #

ToPath UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

ToQuery UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

type Rep UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

type Rep UpdateStage = D1 ('MetaData "UpdateStage" "Amazonka.APIGateway.UpdateStage" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateStage Source # 
Instance details

Defined in Amazonka.APIGateway.UpdateStage

newUpdateStage Source #

Create a value of UpdateStage 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:patchOperations:UpdateStage', updateStage_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:restApiId:UpdateStage', updateStage_restApiId - [Required] The string identifier of the associated RestApi.

$sel:stageName:UpdateStage', updateStage_stageName - [Required] The name of the Stage resource to change information about.

Request Lenses

updateStage_patchOperations :: Lens' UpdateStage (Maybe [PatchOperation]) Source #

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

updateStage_restApiId :: Lens' UpdateStage Text Source #

Required
The string identifier of the associated RestApi.

updateStage_stageName :: Lens' UpdateStage Text Source #

Required
The name of the Stage resource to change information about.

Destructuring the Response

data Stage Source #

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

Deploy an API

See: newStage smart constructor.

Constructors

Stage' 

Fields

Instances

Instances details
Eq Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Methods

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

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

Read Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Show Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Methods

showsPrec :: Int -> Stage -> ShowS #

show :: Stage -> String #

showList :: [Stage] -> ShowS #

Generic Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Associated Types

type Rep Stage :: Type -> Type #

Methods

from :: Stage -> Rep Stage x #

to :: Rep Stage x -> Stage #

NFData Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Methods

rnf :: Stage -> () #

Hashable Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

Methods

hashWithSalt :: Int -> Stage -> Int #

hash :: Stage -> Int #

FromJSON Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

type Rep Stage Source # 
Instance details

Defined in Amazonka.APIGateway.Types.Stage

type Rep Stage = D1 ('MetaData "Stage" "Amazonka.APIGateway.Types.Stage" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterStatus))))) :*: (((S1 ('MetaSel ('Just "methodSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodSetting))) :*: S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :*: S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :*: S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newStage :: Stage Source #

Create a value of Stage 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:deploymentId:Stage', stage_deploymentId - The identifier of the Deployment that the stage points to.

$sel:variables:Stage', stage_variables - 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-._~:/?#&=,]+.

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.

$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.

$sel:methodSettings:Stage', stage_methodSettings - 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.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.

$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The size of the cache cluster for the stage, if enabled.

$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.

$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.

$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

$sel:description:Stage', stage_description - The stage's description.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the stage points to.

stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

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-._~:/?#&=,]+.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_documentationVersion :: Lens' Stage (Maybe Text) Source #

The version of the associated API documentation.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for an API stage.

stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #

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

stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #

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.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage last updated.

stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #

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

stage_webAclArn :: Lens' Stage (Maybe Text) Source #

The ARN of the WebAcl associated with the Stage.

stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #

Settings for the canary deployment in this stage.

stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether a cache cluster is enabled for the stage.

stage_stageName :: 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 API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

stage_description :: Lens' Stage (Maybe Text) Source #

The stage's description.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

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