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

Description

Gets an Api resource.

Synopsis

Creating a Request

data GetApi Source #

See: newGetApi smart constructor.

Constructors

GetApi' 

Fields

Instances

Instances details
Eq GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

(==) :: GetApi -> GetApi -> Bool #

(/=) :: GetApi -> GetApi -> Bool #

Read GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

readsPrec :: Int -> ReadS GetApi #

readList :: ReadS [GetApi] #

readPrec :: ReadPrec GetApi #

readListPrec :: ReadPrec [GetApi] #

Show GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

showsPrec :: Int -> GetApi -> ShowS #

show :: GetApi -> String #

showList :: [GetApi] -> ShowS #

Generic GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Associated Types

type Rep GetApi :: Type -> Type #

Methods

from :: GetApi -> Rep GetApi x #

to :: Rep GetApi x -> GetApi #

NFData GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

rnf :: GetApi -> () #

Hashable GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

hashWithSalt :: Int -> GetApi -> Int #

hash :: GetApi -> Int #

AWSRequest GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Associated Types

type AWSResponse GetApi #

Methods

request :: GetApi -> Request GetApi #

response :: MonadResource m => Logger -> Service -> Proxy GetApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApi))) #

ToHeaders GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

toHeaders :: GetApi -> [Header] #

ToPath GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

toPath :: GetApi -> ByteString #

ToQuery GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

toQuery :: GetApi -> QueryString #

type Rep GetApi Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

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

Defined in Amazonka.ApiGatewayV2.GetApi

type AWSResponse GetApi = GetApiResponse

newGetApi Source #

Arguments

:: Text

$sel:apiId:GetApi'

-> GetApi 

Create a value of GetApi 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:GetApi', getApi_apiId - The API identifier.

Request Lenses

getApi_apiId :: Lens' GetApi Text Source #

The API identifier.

Destructuring the Response

data GetApiResponse Source #

See: newGetApiResponse smart constructor.

Constructors

GetApiResponse' 

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

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

(==) :: GetApiResponse -> GetApiResponse -> Bool #

(/=) :: GetApiResponse -> GetApiResponse -> Bool #

Read GetApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

readsPrec :: Int -> ReadS GetApiResponse #

readList :: ReadS [GetApiResponse] #

readPrec :: ReadPrec GetApiResponse #

readListPrec :: ReadPrec [GetApiResponse] #

Show GetApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

showsPrec :: Int -> GetApiResponse -> ShowS #

show :: GetApiResponse -> String #

showList :: [GetApiResponse] -> ShowS #

Generic GetApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Associated Types

type Rep GetApiResponse :: Type -> Type #

Methods

from :: GetApiResponse -> Rep GetApiResponse x #

to :: Rep GetApiResponse x -> GetApiResponse #

NFData GetApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

Methods

rnf :: GetApiResponse -> () #

type Rep GetApiResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetApi

type Rep GetApiResponse = D1 ('MetaData "GetApiResponse" "Amazonka.ApiGatewayV2.GetApi" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "GetApiResponse'" '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)))))))

newGetApiResponse Source #

Arguments

:: Int

$sel:httpStatus:GetApiResponse'

-> GetApiResponse 

Create a value of GetApiResponse 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:GetApi', getApiResponse_apiId - The API ID.

$sel:disableExecuteApiEndpoint:GetApiResponse', getApiResponse_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:GetApiResponse', getApiResponse_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:GetApiResponse', getApiResponse_warnings - The warning messages reported when failonwarnings is turned on during API import.

$sel:createdDate:GetApiResponse', getApiResponse_createdDate - The timestamp when the API was created.

$sel:name:GetApiResponse', getApiResponse_name - The name of the API.

$sel:version:GetApiResponse', getApiResponse_version - A version identifier for the API.

$sel:apiGatewayManaged:GetApiResponse', getApiResponse_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:GetApiResponse', getApiResponse_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

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

$sel:routeSelectionExpression:GetApiResponse', getApiResponse_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:GetApiResponse', getApiResponse_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:GetApiResponse', getApiResponse_disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

$sel:description:GetApiResponse', getApiResponse_description - The description of the API.

$sel:protocolType:GetApiResponse', getApiResponse_protocolType - The API protocol.

$sel:tags:GetApiResponse', getApiResponse_tags - A collection of tags associated with the API.

$sel:httpStatus:GetApiResponse', getApiResponse_httpStatus - The response's http status code.

Response Lenses

getApiResponse_apiId :: Lens' GetApiResponse (Maybe Text) Source #

The API ID.

getApiResponse_disableExecuteApiEndpoint :: Lens' GetApiResponse (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.

getApiResponse_apiEndpoint :: Lens' GetApiResponse (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.

getApiResponse_warnings :: Lens' GetApiResponse (Maybe [Text]) Source #

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

getApiResponse_createdDate :: Lens' GetApiResponse (Maybe UTCTime) Source #

The timestamp when the API was created.

getApiResponse_name :: Lens' GetApiResponse (Maybe Text) Source #

The name of the API.

getApiResponse_version :: Lens' GetApiResponse (Maybe Text) Source #

A version identifier for the API.

getApiResponse_apiGatewayManaged :: Lens' GetApiResponse (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.

getApiResponse_apiKeySelectionExpression :: Lens' GetApiResponse (Maybe Text) Source #

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

getApiResponse_corsConfiguration :: Lens' GetApiResponse (Maybe Cors) Source #

A CORS configuration. Supported only for HTTP APIs.

getApiResponse_routeSelectionExpression :: Lens' GetApiResponse (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.

getApiResponse_importInfo :: Lens' GetApiResponse (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.

getApiResponse_disableSchemaValidation :: Lens' GetApiResponse (Maybe Bool) Source #

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

getApiResponse_description :: Lens' GetApiResponse (Maybe Text) Source #

The description of the API.

getApiResponse_protocolType :: Lens' GetApiResponse (Maybe ProtocolType) Source #

The API protocol.

getApiResponse_tags :: Lens' GetApiResponse (Maybe (HashMap Text Text)) Source #

A collection of tags associated with the API.

getApiResponse_httpStatus :: Lens' GetApiResponse Int Source #

The response's http status code.