Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ApiGatewayV2.UpdateStage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a Stage.

Synopsis

data UpdateStage = UpdateStage' {
- accessLogSettings :: Maybe AccessLogSettings
- autoDeploy :: Maybe Bool
- clientCertificateId :: Maybe Text
- defaultRouteSettings :: Maybe RouteSettings
- deploymentId :: Maybe Text
- description :: Maybe Text
- routeSettings :: Maybe (HashMap Text RouteSettings)
- stageVariables :: Maybe (HashMap Text Text)
- stageName :: Text
- apiId :: Text
}
newUpdateStage :: Text -> Text -> UpdateStage
updateStage_accessLogSettings :: Lens' UpdateStage (Maybe AccessLogSettings)
updateStage_autoDeploy :: Lens' UpdateStage (Maybe Bool)
updateStage_clientCertificateId :: Lens' UpdateStage (Maybe Text)
updateStage_defaultRouteSettings :: Lens' UpdateStage (Maybe RouteSettings)
updateStage_deploymentId :: Lens' UpdateStage (Maybe Text)
updateStage_description :: Lens' UpdateStage (Maybe Text)
updateStage_routeSettings :: Lens' UpdateStage (Maybe (HashMap Text RouteSettings))
updateStage_stageVariables :: Lens' UpdateStage (Maybe (HashMap Text Text))
updateStage_stageName :: Lens' UpdateStage Text
updateStage_apiId :: Lens' UpdateStage Text
data UpdateStageResponse = UpdateStageResponse' {
- accessLogSettings :: Maybe AccessLogSettings
- apiGatewayManaged :: Maybe Bool
- autoDeploy :: Maybe Bool
- clientCertificateId :: Maybe Text
- createdDate :: Maybe ISO8601
- defaultRouteSettings :: Maybe RouteSettings
- deploymentId :: Maybe Text
- description :: Maybe Text
- lastDeploymentStatusMessage :: Maybe Text
- lastUpdatedDate :: Maybe ISO8601
- routeSettings :: Maybe (HashMap Text RouteSettings)
- stageName :: Maybe Text
- stageVariables :: Maybe (HashMap Text Text)
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newUpdateStageResponse :: Int -> UpdateStageResponse
updateStageResponse_accessLogSettings :: Lens' UpdateStageResponse (Maybe AccessLogSettings)
updateStageResponse_apiGatewayManaged :: Lens' UpdateStageResponse (Maybe Bool)
updateStageResponse_autoDeploy :: Lens' UpdateStageResponse (Maybe Bool)
updateStageResponse_clientCertificateId :: Lens' UpdateStageResponse (Maybe Text)
updateStageResponse_createdDate :: Lens' UpdateStageResponse (Maybe UTCTime)
updateStageResponse_defaultRouteSettings :: Lens' UpdateStageResponse (Maybe RouteSettings)
updateStageResponse_deploymentId :: Lens' UpdateStageResponse (Maybe Text)
updateStageResponse_description :: Lens' UpdateStageResponse (Maybe Text)
updateStageResponse_lastDeploymentStatusMessage :: Lens' UpdateStageResponse (Maybe Text)
updateStageResponse_lastUpdatedDate :: Lens' UpdateStageResponse (Maybe UTCTime)
updateStageResponse_routeSettings :: Lens' UpdateStageResponse (Maybe (HashMap Text RouteSettings))
updateStageResponse_stageName :: Lens' UpdateStageResponse (Maybe Text)
updateStageResponse_stageVariables :: Lens' UpdateStageResponse (Maybe (HashMap Text Text))
updateStageResponse_tags :: Lens' UpdateStageResponse (Maybe (HashMap Text Text))
updateStageResponse_httpStatus :: Lens' UpdateStageResponse Int

Creating a Request

data UpdateStage Source #

Updates a Stage.

See: newUpdateStage smart constructor.

Constructors

UpdateStage'

Fields

accessLogSettings :: Maybe AccessLogSettings
Settings for logging access in this stage.
autoDeploy :: Maybe Bool
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
clientCertificateId :: Maybe Text
The identifier of a client certificate for a Stage.
defaultRouteSettings :: Maybe RouteSettings
The default route settings for the stage.
deploymentId :: Maybe Text
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
description :: Maybe Text
The description for the API stage.
routeSettings :: Maybe (HashMap Text RouteSettings)
Route settings for the stage.
stageVariables :: Maybe (HashMap Text Text)
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
stageName :: Text
The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
apiId :: Text
The API identifier.

Instances

Instances details

ToJSON UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods toJSON :: UpdateStage -> Value # toEncoding :: UpdateStage -> Encoding # toJSONList :: [UpdateStage] -> Value # toEncodingList :: [UpdateStage] -> Encoding #
ToHeaders UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods toHeaders :: UpdateStage -> [Header] #
ToPath UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods toPath :: UpdateStage -> ByteString #
ToQuery UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods toQuery :: UpdateStage -> QueryString #
AWSRequest UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Associated Types type AWSResponse UpdateStage # Methods request :: (Service -> Service) -> UpdateStage -> Request UpdateStage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStage))) #
Generic UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Associated Types type Rep UpdateStage :: Type -> Type # Methods from :: UpdateStage -> Rep UpdateStage x # to :: Rep UpdateStage x -> UpdateStage #
Read UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods readsPrec :: Int -> ReadS UpdateStage # readList :: ReadS [UpdateStage] # readPrec :: ReadPrec UpdateStage # readListPrec :: ReadPrec [UpdateStage] #
Show UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods showsPrec :: Int -> UpdateStage -> ShowS # show :: UpdateStage -> String # showList :: [UpdateStage] -> ShowS #
NFData UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods rnf :: UpdateStage -> () #
Eq UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods (==) :: UpdateStage -> UpdateStage -> Bool # (/=) :: UpdateStage -> UpdateStage -> Bool #
Hashable UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods hashWithSalt :: Int -> UpdateStage -> Int # hash :: UpdateStage -> Int #
type AWSResponse UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage type AWSResponse UpdateStage = UpdateStageResponse
type Rep UpdateStage Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage type Rep UpdateStage = D1 ('MetaData "UpdateStage" "Amazonka.ApiGatewayV2.UpdateStage" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "UpdateStage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings)))) :: (S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateStage Source #

Arguments

:: Text	`UpdateStage`
-> Text	`UpdateStage`
-> UpdateStage

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:

UpdateStage, updateStage_accessLogSettings - Settings for logging access in this stage.

UpdateStage, updateStage_autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

UpdateStage, updateStage_clientCertificateId - The identifier of a client certificate for a Stage.

UpdateStage, updateStage_defaultRouteSettings - The default route settings for the stage.

UpdateStage, updateStage_deploymentId - The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

UpdateStage, updateStage_description - The description for the API stage.

UpdateStage, updateStage_routeSettings - Route settings for the stage.

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

UpdateStage, updateStage_stageName - The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

UpdateStage, updateStage_apiId - The API identifier.

Request Lenses

updateStage_accessLogSettings :: Lens' UpdateStage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

updateStage_autoDeploy :: Lens' UpdateStage (Maybe Bool) Source #

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

updateStage_clientCertificateId :: Lens' UpdateStage (Maybe Text) Source #

The identifier of a client certificate for a Stage.

updateStage_defaultRouteSettings :: Lens' UpdateStage (Maybe RouteSettings) Source #

The default route settings for the stage.

updateStage_deploymentId :: Lens' UpdateStage (Maybe Text) Source #

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

updateStage_description :: Lens' UpdateStage (Maybe Text) Source #

The description for the API stage.

updateStage_routeSettings :: Lens' UpdateStage (Maybe (HashMap Text RouteSettings)) Source #

Route settings for the stage.

updateStage_stageVariables :: Lens' UpdateStage (Maybe (HashMap Text Text)) Source #

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

updateStage_stageName :: Lens' UpdateStage Text Source #

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

updateStage_apiId :: Lens' UpdateStage Text Source #

The API identifier.

Destructuring the Response

data UpdateStageResponse Source #

See: newUpdateStageResponse smart constructor.

Constructors

UpdateStageResponse'

Fields

accessLogSettings :: Maybe AccessLogSettings
Settings for logging access in this stage.
apiGatewayManaged :: Maybe Bool
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
autoDeploy :: Maybe Bool
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
clientCertificateId :: Maybe Text
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
createdDate :: Maybe ISO8601
The timestamp when the stage was created.
defaultRouteSettings :: Maybe RouteSettings
Default route settings for the stage.
deploymentId :: Maybe Text
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
description :: Maybe Text
The description of the stage.
lastDeploymentStatusMessage :: Maybe Text
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
lastUpdatedDate :: Maybe ISO8601
The timestamp when the stage was last updated.
routeSettings :: Maybe (HashMap Text RouteSettings)
Route settings for the stage, by routeKey.
stageName :: Maybe Text
The name of the stage.
stageVariables :: Maybe (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-._~:/?#&=,]+.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Associated Types type Rep UpdateStageResponse :: Type -> Type # Methods from :: UpdateStageResponse -> Rep UpdateStageResponse x # to :: Rep UpdateStageResponse x -> UpdateStageResponse #
Read UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods readsPrec :: Int -> ReadS UpdateStageResponse # readList :: ReadS [UpdateStageResponse] # readPrec :: ReadPrec UpdateStageResponse # readListPrec :: ReadPrec [UpdateStageResponse] #
Show UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods showsPrec :: Int -> UpdateStageResponse -> ShowS # show :: UpdateStageResponse -> String # showList :: [UpdateStageResponse] -> ShowS #
NFData UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods rnf :: UpdateStageResponse -> () #
Eq UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage Methods (==) :: UpdateStageResponse -> UpdateStageResponse -> Bool # (/=) :: UpdateStageResponse -> UpdateStageResponse -> Bool #
type Rep UpdateStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.UpdateStage type Rep UpdateStageResponse = D1 ('MetaData "UpdateStageResponse" "Amazonka.ApiGatewayV2.UpdateStage" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "UpdateStageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: (S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastDeploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings))))) :: ((S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateStageResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateStageResponse'`
-> UpdateStageResponse

Create a value of UpdateStageResponse 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:

UpdateStage, updateStageResponse_accessLogSettings - Settings for logging access in this stage.

UpdateStageResponse, updateStageResponse_apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

UpdateStage, updateStageResponse_autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

UpdateStage, updateStageResponse_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

UpdateStageResponse, updateStageResponse_createdDate - The timestamp when the stage was created.

UpdateStage, updateStageResponse_defaultRouteSettings - Default route settings for the stage.

UpdateStage, updateStageResponse_deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

UpdateStage, updateStageResponse_description - The description of the stage.

UpdateStageResponse, updateStageResponse_lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

UpdateStageResponse, updateStageResponse_lastUpdatedDate - The timestamp when the stage was last updated.

UpdateStage, updateStageResponse_routeSettings - Route settings for the stage, by routeKey.

UpdateStage, updateStageResponse_stageName - The name of the stage.

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

UpdateStageResponse, updateStageResponse_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:httpStatus:UpdateStageResponse', updateStageResponse_httpStatus - The response's http status code.

Response Lenses

updateStageResponse_accessLogSettings :: Lens' UpdateStageResponse (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

updateStageResponse_apiGatewayManaged :: Lens' UpdateStageResponse (Maybe Bool) Source #

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

updateStageResponse_autoDeploy :: Lens' UpdateStageResponse (Maybe Bool) Source #

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

updateStageResponse_clientCertificateId :: Lens' UpdateStageResponse (Maybe Text) Source #

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

updateStageResponse_createdDate :: Lens' UpdateStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was created.

updateStageResponse_defaultRouteSettings :: Lens' UpdateStageResponse (Maybe RouteSettings) Source #

Default route settings for the stage.

updateStageResponse_deploymentId :: Lens' UpdateStageResponse (Maybe Text) Source #

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

updateStageResponse_description :: Lens' UpdateStageResponse (Maybe Text) Source #

The description of the stage.

updateStageResponse_lastDeploymentStatusMessage :: Lens' UpdateStageResponse (Maybe Text) Source #

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

updateStageResponse_lastUpdatedDate :: Lens' UpdateStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was last updated.

updateStageResponse_routeSettings :: Lens' UpdateStageResponse (Maybe (HashMap Text RouteSettings)) Source #

Route settings for the stage, by routeKey.

updateStageResponse_stageName :: Lens' UpdateStageResponse (Maybe Text) Source #

The name of the stage.

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

updateStageResponse_tags :: Lens' UpdateStageResponse (Maybe (HashMap Text Text)) Source #

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

updateStageResponse_httpStatus :: Lens' UpdateStageResponse Int Source #

The response's http status code.