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 |
Imports an API.
Synopsis
- data ImportApi = ImportApi' {}
- newImportApi :: Text -> ImportApi
- importApi_basepath :: Lens' ImportApi (Maybe Text)
- importApi_failOnWarnings :: Lens' ImportApi (Maybe Bool)
- importApi_body :: Lens' ImportApi Text
- data ImportApiResponse = ImportApiResponse' {
- 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
- newImportApiResponse :: Int -> ImportApiResponse
- importApiResponse_apiEndpoint :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_apiGatewayManaged :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_apiId :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_apiKeySelectionExpression :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_corsConfiguration :: Lens' ImportApiResponse (Maybe Cors)
- importApiResponse_createdDate :: Lens' ImportApiResponse (Maybe UTCTime)
- importApiResponse_description :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_disableExecuteApiEndpoint :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_disableSchemaValidation :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_importInfo :: Lens' ImportApiResponse (Maybe [Text])
- importApiResponse_name :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_protocolType :: Lens' ImportApiResponse (Maybe ProtocolType)
- importApiResponse_routeSelectionExpression :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_tags :: Lens' ImportApiResponse (Maybe (HashMap Text Text))
- importApiResponse_version :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_warnings :: Lens' ImportApiResponse (Maybe [Text])
- importApiResponse_httpStatus :: Lens' ImportApiResponse Int
Creating a Request
See: newImportApi
smart constructor.
ImportApi' | |
|
Instances
Create a value of ImportApi
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:ImportApi'
, importApi_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:ImportApi'
, importApi_failOnWarnings
- Specifies whether to rollback the API creation when a warning is
encountered. By default, API creation continues if a warning is
encountered.
$sel:body:ImportApi'
, importApi_body
- The OpenAPI definition. Supported only for HTTP APIs.
Request Lenses
importApi_basepath :: Lens' ImportApi (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.
importApi_failOnWarnings :: Lens' ImportApi (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.
importApi_body :: Lens' ImportApi Text Source #
The OpenAPI definition. Supported only for HTTP APIs.
Destructuring the Response
data ImportApiResponse Source #
See: newImportApiResponse
smart constructor.
ImportApiResponse' | |
|
Instances
Create a value of ImportApiResponse
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:
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_apiId
- The API ID.
ImportApiResponse
, importApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
ImportApiResponse
, importApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
ImportApiResponse
, importApiResponse_createdDate
- The timestamp when the API was created.
ImportApiResponse
, importApiResponse_description
- The description of the API.
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_name
- The name of the API.
ImportApiResponse
, importApiResponse_protocolType
- The API protocol.
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_tags
- A collection of tags associated with the API.
ImportApiResponse
, importApiResponse_version
- A version identifier for the API.
ImportApiResponse
, importApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:ImportApiResponse'
, importApiResponse_httpStatus
- The response's http status code.
Response Lenses
importApiResponse_apiEndpoint :: Lens' ImportApiResponse (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.
importApiResponse_apiGatewayManaged :: Lens' ImportApiResponse (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.
importApiResponse_apiId :: Lens' ImportApiResponse (Maybe Text) Source #
The API ID.
importApiResponse_apiKeySelectionExpression :: Lens' ImportApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
importApiResponse_corsConfiguration :: Lens' ImportApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
importApiResponse_createdDate :: Lens' ImportApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
importApiResponse_description :: Lens' ImportApiResponse (Maybe Text) Source #
The description of the API.
importApiResponse_disableExecuteApiEndpoint :: Lens' ImportApiResponse (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.
importApiResponse_disableSchemaValidation :: Lens' ImportApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
importApiResponse_importInfo :: Lens' ImportApiResponse (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.
importApiResponse_name :: Lens' ImportApiResponse (Maybe Text) Source #
The name of the API.
importApiResponse_protocolType :: Lens' ImportApiResponse (Maybe ProtocolType) Source #
The API protocol.
importApiResponse_routeSelectionExpression :: Lens' ImportApiResponse (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.
importApiResponse_tags :: Lens' ImportApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
importApiResponse_version :: Lens' ImportApiResponse (Maybe Text) Source #
A version identifier for the API.
importApiResponse_warnings :: Lens' ImportApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
importApiResponse_httpStatus :: Lens' ImportApiResponse Int Source #
The response's http status code.