libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2
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.ApiGatewayV2.GetStage

Description

Gets a Stage.

Synopsis

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
Eq GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Read GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Show GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.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 #

NFData GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Methods

rnf :: GetStage -> () #

Hashable GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Methods

hashWithSalt :: Int -> GetStage -> Int #

hash :: GetStage -> Int #

AWSRequest GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Associated Types

type AWSResponse GetStage #

ToHeaders GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Methods

toHeaders :: GetStage -> [Header] #

ToPath GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

ToQuery GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

type Rep GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

type Rep GetStage = D1 ('MetaData "GetStage" "Amazonka.ApiGatewayV2.GetStage" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "GetStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

newGetStage Source #

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:

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

$sel:apiId: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

Instances

Instances details
Eq GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Read GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Show GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Generic GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Associated Types

type Rep GetStageResponse :: Type -> Type #

NFData GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

Methods

rnf :: GetStageResponse -> () #

type Rep GetStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetStage

type Rep GetStageResponse = D1 ('MetaData "GetStageResponse" "Amazonka.ApiGatewayV2.GetStage" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "GetStageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastDeploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings))))) :*: ((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :*: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings))) :*: (S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetStageResponse Source #

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:

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

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

$sel:routeSettings:GetStageResponse', getStageResponse_routeSettings - Route settings for the stage, by routeKey.

$sel:accessLogSettings:GetStageResponse', getStageResponse_accessLogSettings - Settings for logging access in this stage.

$sel:clientCertificateId:GetStageResponse', getStageResponse_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

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

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

$sel:createdDate:GetStageResponse', getStageResponse_createdDate - The timestamp when the stage was created.

$sel:defaultRouteSettings:GetStageResponse', getStageResponse_defaultRouteSettings - Default route settings for the stage.

$sel:apiGatewayManaged: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.

$sel:stageName:GetStage', getStageResponse_stageName - The name of the stage.

$sel:lastUpdatedDate:GetStageResponse', getStageResponse_lastUpdatedDate - The timestamp when the stage was last updated.

$sel:description:GetStageResponse', getStageResponse_description - The description of the stage.

$sel:tags: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_lastDeploymentStatusMessage :: Lens' GetStageResponse (Maybe Text) Source #

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

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_clientCertificateId :: Lens' GetStageResponse (Maybe Text) Source #

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

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_autoDeploy :: Lens' GetStageResponse (Maybe Bool) Source #

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

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

The timestamp when the stage was created.

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_lastUpdatedDate :: Lens' GetStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was last updated.

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.