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.GetStage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a Stage.

Synopsis

data GetStage = GetStage' {
- stageName :: Text
- apiId :: Text
}
newGetStage :: Text -> Text -> GetStage
getStage_stageName :: Lens' GetStage Text
getStage_apiId :: Lens' GetStage Text
data GetStageResponse = GetStageResponse' {
- 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
}
newGetStageResponse :: Int -> GetStageResponse
getStageResponse_accessLogSettings :: Lens' GetStageResponse (Maybe AccessLogSettings)
getStageResponse_apiGatewayManaged :: Lens' GetStageResponse (Maybe Bool)
getStageResponse_autoDeploy :: Lens' GetStageResponse (Maybe Bool)
getStageResponse_clientCertificateId :: Lens' GetStageResponse (Maybe Text)
getStageResponse_createdDate :: Lens' GetStageResponse (Maybe UTCTime)
getStageResponse_defaultRouteSettings :: Lens' GetStageResponse (Maybe RouteSettings)
getStageResponse_deploymentId :: Lens' GetStageResponse (Maybe Text)
getStageResponse_description :: Lens' GetStageResponse (Maybe Text)
getStageResponse_lastDeploymentStatusMessage :: Lens' GetStageResponse (Maybe Text)
getStageResponse_lastUpdatedDate :: Lens' GetStageResponse (Maybe UTCTime)
getStageResponse_routeSettings :: Lens' GetStageResponse (Maybe (HashMap Text RouteSettings))
getStageResponse_stageName :: Lens' GetStageResponse (Maybe Text)
getStageResponse_stageVariables :: Lens' GetStageResponse (Maybe (HashMap Text Text))
getStageResponse_tags :: Lens' GetStageResponse (Maybe (HashMap Text Text))
getStageResponse_httpStatus :: Lens' GetStageResponse Int

Creating a Request

data GetStage Source #

See: newGetStage smart constructor.

Constructors

GetStage'
Fields stageName :: Text The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. apiId :: Text The API identifier.

Instances

Instances details

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

newGetStage Source #

Arguments

:: Text	`GetStage`
-> Text	`GetStage`
-> GetStage

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

GetStage, getStage_stageName - The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

GetStage, getStage_apiId - The API identifier.

Request Lenses

getStage_stageName :: Lens' GetStage Text Source #

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

getStage_apiId :: Lens' GetStage Text Source #

The API identifier.

Destructuring the Response

data GetStageResponse Source #

See: newGetStageResponse smart constructor.

Constructors

GetStageResponse'

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 GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage Associated Types type Rep GetStageResponse :: Type -> Type # Methods from :: GetStageResponse -> Rep GetStageResponse x # to :: Rep GetStageResponse x -> GetStageResponse #
Read GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage Methods readsPrec :: Int -> ReadS GetStageResponse # readList :: ReadS [GetStageResponse] # readPrec :: ReadPrec GetStageResponse # readListPrec :: ReadPrec [GetStageResponse] #
Show GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage Methods showsPrec :: Int -> GetStageResponse -> ShowS # show :: GetStageResponse -> String # showList :: [GetStageResponse] -> ShowS #
NFData GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage Methods rnf :: GetStageResponse -> () #
Eq GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage Methods (==) :: GetStageResponse -> GetStageResponse -> Bool # (/=) :: GetStageResponse -> GetStageResponse -> Bool #
type Rep GetStageResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStage type Rep GetStageResponse = D1 ('MetaData "GetStageResponse" "Amazonka.ApiGatewayV2.GetStage" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "GetStageResponse'" '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))))))

newGetStageResponse Source #

Arguments

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

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

GetStageResponse, getStageResponse_accessLogSettings - Settings for logging access in this stage.

GetStageResponse, getStageResponse_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.

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

GetStageResponse, getStageResponse_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

GetStageResponse, getStageResponse_createdDate - The timestamp when the stage was created.

GetStageResponse, getStageResponse_defaultRouteSettings - Default route settings for the stage.

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

GetStageResponse, getStageResponse_description - The description of the stage.

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

GetStageResponse, getStageResponse_lastUpdatedDate - The timestamp when the stage was last updated.

GetStageResponse, getStageResponse_routeSettings - Route settings for the stage, by routeKey.

GetStage, getStageResponse_stageName - The name of the stage.

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

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

$sel:httpStatus:GetStageResponse', getStageResponse_httpStatus - The response's http status code.

Response Lenses

getStageResponse_accessLogSettings :: Lens' GetStageResponse (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

getStageResponse_apiGatewayManaged :: Lens' GetStageResponse (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.

getStageResponse_autoDeploy :: Lens' GetStageResponse (Maybe Bool) Source #

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

getStageResponse_clientCertificateId :: Lens' GetStageResponse (Maybe Text) Source #

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

getStageResponse_createdDate :: Lens' GetStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was created.

getStageResponse_defaultRouteSettings :: Lens' GetStageResponse (Maybe RouteSettings) Source #

Default route settings for the stage.

getStageResponse_deploymentId :: Lens' GetStageResponse (Maybe Text) Source #

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

getStageResponse_description :: Lens' GetStageResponse (Maybe Text) Source #

The description of the stage.

getStageResponse_lastDeploymentStatusMessage :: Lens' GetStageResponse (Maybe Text) Source #

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

getStageResponse_lastUpdatedDate :: Lens' GetStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was last updated.

getStageResponse_routeSettings :: Lens' GetStageResponse (Maybe (HashMap Text RouteSettings)) Source #

Route settings for the stage, by routeKey.

getStageResponse_stageName :: Lens' GetStageResponse (Maybe Text) Source #

The name of the stage.

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

getStageResponse_tags :: Lens' GetStageResponse (Maybe (HashMap Text Text)) Source #

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

getStageResponse_httpStatus :: Lens' GetStageResponse Int Source #

The response's http status code.