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

Description

Puts an Api resource.

Synopsis

Creating a Request

data ReimportApi Source #

See: newReimportApi smart constructor.

Constructors

ReimportApi' 

Fields

  • basepath :: Maybe Text

    Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

  • failOnWarnings :: Maybe Bool

    Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

  • apiId :: Text

    The API identifier.

  • body :: Text

    The OpenAPI definition. Supported only for HTTP APIs.

Instances

Instances details
Eq ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Read ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Show ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Generic ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Associated Types

type Rep ReimportApi :: Type -> Type #

NFData ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Methods

rnf :: ReimportApi -> () #

Hashable ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

ToJSON ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

AWSRequest ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Associated Types

type AWSResponse ReimportApi #

ToHeaders ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Methods

toHeaders :: ReimportApi -> [Header] #

ToPath ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

ToQuery ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

type Rep ReimportApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

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

Defined in Amazonka.ApiGatewayV2.ReimportApi

newReimportApi Source #

Create a value of ReimportApi 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:basepath:ReimportApi', reimportApi_basepath - Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

$sel:failOnWarnings:ReimportApi', reimportApi_failOnWarnings - Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

$sel:apiId:ReimportApi', reimportApi_apiId - The API identifier.

$sel:body:ReimportApi', reimportApi_body - The OpenAPI definition. Supported only for HTTP APIs.

Request Lenses

reimportApi_basepath :: Lens' ReimportApi (Maybe Text) Source #

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

reimportApi_failOnWarnings :: Lens' ReimportApi (Maybe Bool) Source #

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

reimportApi_body :: Lens' ReimportApi Text Source #

The OpenAPI definition. Supported only for HTTP APIs.

Destructuring the Response

data ReimportApiResponse Source #

See: newReimportApiResponse smart constructor.

Constructors

ReimportApiResponse' 

Fields

  • apiId :: Maybe Text

    The API ID.

  • disableExecuteApiEndpoint :: Maybe Bool

    Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

  • apiEndpoint :: Maybe Text

    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

  • warnings :: Maybe [Text]

    The warning messages reported when failonwarnings is turned on during API import.

  • createdDate :: Maybe POSIX

    The timestamp when the API was created.

  • name :: Maybe Text

    The name of the API.

  • version :: Maybe Text

    A version identifier for the API.

  • apiGatewayManaged :: Maybe Bool

    Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

  • apiKeySelectionExpression :: Maybe Text

    An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

  • corsConfiguration :: Maybe Cors

    A CORS configuration. Supported only for HTTP APIs.

  • routeSelectionExpression :: Maybe Text

    The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

  • importInfo :: Maybe [Text]

    The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

  • disableSchemaValidation :: Maybe Bool

    Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

  • description :: Maybe Text

    The description of the API.

  • protocolType :: Maybe ProtocolType

    The API protocol.

  • tags :: Maybe (HashMap Text Text)

    A collection of tags associated with the API.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Read ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Show ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Generic ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Associated Types

type Rep ReimportApiResponse :: Type -> Type #

NFData ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

Methods

rnf :: ReimportApiResponse -> () #

type Rep ReimportApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.ReimportApi

type Rep ReimportApiResponse = D1 ('MetaData "ReimportApiResponse" "Amazonka.ApiGatewayV2.ReimportApi" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "ReimportApiResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "apiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "apiKeySelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "corsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cors))) :*: (S1 ('MetaSel ('Just "routeSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "importInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "disableSchemaValidation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "protocolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolType)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newReimportApiResponse Source #

Create a value of ReimportApiResponse 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:apiId:ReimportApi', reimportApiResponse_apiId - The API ID.

$sel:disableExecuteApiEndpoint:ReimportApiResponse', reimportApiResponse_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:apiEndpoint:ReimportApiResponse', reimportApiResponse_apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

$sel:warnings:ReimportApiResponse', reimportApiResponse_warnings - The warning messages reported when failonwarnings is turned on during API import.

$sel:createdDate:ReimportApiResponse', reimportApiResponse_createdDate - The timestamp when the API was created.

$sel:name:ReimportApiResponse', reimportApiResponse_name - The name of the API.

$sel:version:ReimportApiResponse', reimportApiResponse_version - A version identifier for the API.

$sel:apiGatewayManaged:ReimportApiResponse', reimportApiResponse_apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

$sel:apiKeySelectionExpression:ReimportApiResponse', reimportApiResponse_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

$sel:corsConfiguration:ReimportApiResponse', reimportApiResponse_corsConfiguration - A CORS configuration. Supported only for HTTP APIs.

$sel:routeSelectionExpression:ReimportApiResponse', reimportApiResponse_routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

$sel:importInfo:ReimportApiResponse', reimportApiResponse_importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

$sel:disableSchemaValidation:ReimportApiResponse', reimportApiResponse_disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

$sel:description:ReimportApiResponse', reimportApiResponse_description - The description of the API.

$sel:protocolType:ReimportApiResponse', reimportApiResponse_protocolType - The API protocol.

$sel:tags:ReimportApiResponse', reimportApiResponse_tags - A collection of tags associated with the API.

$sel:httpStatus:ReimportApiResponse', reimportApiResponse_httpStatus - The response's http status code.

Response Lenses

reimportApiResponse_disableExecuteApiEndpoint :: Lens' ReimportApiResponse (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

reimportApiResponse_apiEndpoint :: Lens' ReimportApiResponse (Maybe Text) Source #

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

reimportApiResponse_warnings :: Lens' ReimportApiResponse (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

reimportApiResponse_createdDate :: Lens' ReimportApiResponse (Maybe UTCTime) Source #

The timestamp when the API was created.

reimportApiResponse_apiGatewayManaged :: Lens' ReimportApiResponse (Maybe Bool) Source #

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

reimportApiResponse_apiKeySelectionExpression :: Lens' ReimportApiResponse (Maybe Text) Source #

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

reimportApiResponse_corsConfiguration :: Lens' ReimportApiResponse (Maybe Cors) Source #

A CORS configuration. Supported only for HTTP APIs.

reimportApiResponse_routeSelectionExpression :: Lens' ReimportApiResponse (Maybe Text) Source #

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

reimportApiResponse_importInfo :: Lens' ReimportApiResponse (Maybe [Text]) Source #

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

reimportApiResponse_disableSchemaValidation :: Lens' ReimportApiResponse (Maybe Bool) Source #

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

reimportApiResponse_tags :: Lens' ReimportApiResponse (Maybe (HashMap Text Text)) Source #

A collection of tags associated with the API.