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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Puts an Api resource.

Synopsis

data ReimportApi = ReimportApi' {
- basepath :: Maybe Text
- failOnWarnings :: Maybe Bool
- apiId :: Text
- body :: Text
}
newReimportApi :: Text -> Text -> ReimportApi
reimportApi_basepath :: Lens' ReimportApi (Maybe Text)
reimportApi_failOnWarnings :: Lens' ReimportApi (Maybe Bool)
reimportApi_apiId :: Lens' ReimportApi Text
reimportApi_body :: Lens' ReimportApi Text
data ReimportApiResponse = ReimportApiResponse' {
- apiEndpoint :: Maybe Text
- apiGatewayManaged :: Maybe Bool
- apiId :: Maybe Text
- apiKeySelectionExpression :: Maybe Text
- corsConfiguration :: Maybe Cors
- createdDate :: Maybe ISO8601
- description :: Maybe Text
- disableExecuteApiEndpoint :: Maybe Bool
- disableSchemaValidation :: Maybe Bool
- importInfo :: Maybe [Text]
- name :: Maybe Text
- protocolType :: Maybe ProtocolType
- routeSelectionExpression :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- version :: Maybe Text
- warnings :: Maybe [Text]
- httpStatus :: Int
}
newReimportApiResponse :: Int -> ReimportApiResponse
reimportApiResponse_apiEndpoint :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_apiGatewayManaged :: Lens' ReimportApiResponse (Maybe Bool)
reimportApiResponse_apiId :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_apiKeySelectionExpression :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_corsConfiguration :: Lens' ReimportApiResponse (Maybe Cors)
reimportApiResponse_createdDate :: Lens' ReimportApiResponse (Maybe UTCTime)
reimportApiResponse_description :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_disableExecuteApiEndpoint :: Lens' ReimportApiResponse (Maybe Bool)
reimportApiResponse_disableSchemaValidation :: Lens' ReimportApiResponse (Maybe Bool)
reimportApiResponse_importInfo :: Lens' ReimportApiResponse (Maybe [Text])
reimportApiResponse_name :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_protocolType :: Lens' ReimportApiResponse (Maybe ProtocolType)
reimportApiResponse_routeSelectionExpression :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_tags :: Lens' ReimportApiResponse (Maybe (HashMap Text Text))
reimportApiResponse_version :: Lens' ReimportApiResponse (Maybe Text)
reimportApiResponse_warnings :: Lens' ReimportApiResponse (Maybe [Text])
reimportApiResponse_httpStatus :: Lens' ReimportApiResponse Int

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

ToJSON ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods toJSON :: ReimportApi -> Value # toEncoding :: ReimportApi -> Encoding # toJSONList :: [ReimportApi] -> Value # toEncodingList :: [ReimportApi] -> Encoding #
ToHeaders ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods toHeaders :: ReimportApi -> [Header] #
ToPath ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods toPath :: ReimportApi -> ByteString #
ToQuery ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods toQuery :: ReimportApi -> QueryString #
AWSRequest ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Associated Types type AWSResponse ReimportApi # Methods request :: (Service -> Service) -> ReimportApi -> Request ReimportApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReimportApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReimportApi))) #
Generic ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Associated Types type Rep ReimportApi :: Type -> Type # Methods from :: ReimportApi -> Rep ReimportApi x # to :: Rep ReimportApi x -> ReimportApi #
Read ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods readsPrec :: Int -> ReadS ReimportApi # readList :: ReadS [ReimportApi] # readPrec :: ReadPrec ReimportApi # readListPrec :: ReadPrec [ReimportApi] #
Show ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods showsPrec :: Int -> ReimportApi -> ShowS # show :: ReimportApi -> String # showList :: [ReimportApi] -> ShowS #
NFData ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods rnf :: ReimportApi -> () #
Eq ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods (==) :: ReimportApi -> ReimportApi -> Bool # (/=) :: ReimportApi -> ReimportApi -> Bool #
Hashable ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods hashWithSalt :: Int -> ReimportApi -> Int # hash :: ReimportApi -> Int #
type AWSResponse ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi type AWSResponse ReimportApi = ReimportApiResponse
type Rep ReimportApi Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi type Rep ReimportApi = D1 ('MetaData "ReimportApi" "Amazonka.ApiGatewayV2.ReimportApi" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" '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))))

newReimportApi Source #

Arguments

:: Text	`ReimportApi`
-> Text	`$sel:body:ReimportApi'`
-> ReimportApi

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.

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_apiId :: Lens' ReimportApi Text Source #

The API identifier.

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

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.
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.
apiId :: Maybe Text
The API ID.
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.
createdDate :: Maybe ISO8601
The timestamp when the API was created.
description :: Maybe Text
The description of the API.
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.
disableSchemaValidation :: Maybe Bool
Avoid validating models when creating a deployment. Supported only 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.
name :: Maybe Text
The name of the API.
protocolType :: Maybe ProtocolType
The API protocol.
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.
tags :: Maybe (HashMap Text Text)
A collection of tags associated with the API.
version :: Maybe Text
A version identifier for the API.
warnings :: Maybe [Text]
The warning messages reported when failonwarnings is turned on during API import.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Associated Types type Rep ReimportApiResponse :: Type -> Type # Methods from :: ReimportApiResponse -> Rep ReimportApiResponse x # to :: Rep ReimportApiResponse x -> ReimportApiResponse #
Read ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods readsPrec :: Int -> ReadS ReimportApiResponse # readList :: ReadS [ReimportApiResponse] # readPrec :: ReadPrec ReimportApiResponse # readListPrec :: ReadPrec [ReimportApiResponse] #
Show ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods showsPrec :: Int -> ReimportApiResponse -> ShowS # show :: ReimportApiResponse -> String # showList :: [ReimportApiResponse] -> ShowS #
NFData ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods rnf :: ReimportApiResponse -> () #
Eq ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi Methods (==) :: ReimportApiResponse -> ReimportApiResponse -> Bool # (/=) :: ReimportApiResponse -> ReimportApiResponse -> Bool #
type Rep ReimportApiResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.ReimportApi type Rep ReimportApiResponse = D1 ('MetaData "ReimportApiResponse" "Amazonka.ApiGatewayV2.ReimportApi" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "ReimportApiResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "apiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiKeySelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "corsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cors)) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "disableSchemaValidation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "importInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "protocolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolType)))) :: ((S1 ('MetaSel ('Just "routeSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newReimportApiResponse Source #

Arguments

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

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:

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.

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.

ReimportApi, reimportApiResponse_apiId - The API ID.

ReimportApiResponse, reimportApiResponse_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

ReimportApiResponse, reimportApiResponse_corsConfiguration - A CORS configuration. Supported only for HTTP APIs.

ReimportApiResponse, reimportApiResponse_createdDate - The timestamp when the API was created.

ReimportApiResponse, reimportApiResponse_description - The description of the API.

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.

ReimportApiResponse, reimportApiResponse_disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

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.

ReimportApiResponse, reimportApiResponse_name - The name of the API.

ReimportApiResponse, reimportApiResponse_protocolType - The API protocol.

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.

ReimportApiResponse, reimportApiResponse_tags - A collection of tags associated with the API.

ReimportApiResponse, reimportApiResponse_version - A version identifier for the API.

ReimportApiResponse, reimportApiResponse_warnings - The warning messages reported when failonwarnings is turned on during API import.

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

Response Lenses

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_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_apiId :: Lens' ReimportApiResponse (Maybe Text) Source #

The API ID.

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

The timestamp when the API was created.

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

The description of the API.

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

Avoid validating models when creating a deployment. Supported only 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_name :: Lens' ReimportApiResponse (Maybe Text) Source #

The name of the API.

reimportApiResponse_protocolType :: Lens' ReimportApiResponse (Maybe ProtocolType) Source #

The API protocol.

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_tags :: Lens' ReimportApiResponse (Maybe (HashMap Text Text)) Source #

A collection of tags associated with the API.

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

A version identifier for the API.

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

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

reimportApiResponse_httpStatus :: Lens' ReimportApiResponse Int Source #

The response's http status code.