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

Description

Gets an IntegrationResponses.

Synopsis

Creating a Request

data GetIntegrationResponse Source #

See: newGetIntegrationResponse smart constructor.

Constructors

GetIntegrationResponse' 

Fields

Instances

Instances details
Eq GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Read GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Show GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Generic GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Associated Types

type Rep GetIntegrationResponse :: Type -> Type #

NFData GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Methods

rnf :: GetIntegrationResponse -> () #

Hashable GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

AWSRequest GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Associated Types

type AWSResponse GetIntegrationResponse #

ToHeaders GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

ToPath GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

ToQuery GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

type Rep GetIntegrationResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

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

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Request Lenses

Destructuring the Response

data GetIntegrationResponseResponse Source #

See: newGetIntegrationResponseResponse smart constructor.

Constructors

GetIntegrationResponseResponse' 

Fields

  • integrationResponseId :: Maybe Text

    The integration response ID.

  • integrationResponseKey :: Maybe Text

    The integration response key.

  • templateSelectionExpression :: Maybe Text

    The template selection expressions for the integration response.

  • contentHandlingStrategy :: Maybe ContentHandlingStrategy

    Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

  • responseTemplates :: Maybe (HashMap Text Text)

    The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

  • responseParameters :: Maybe (HashMap Text Text)

    A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Read GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Show GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Generic GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

Associated Types

type Rep GetIntegrationResponseResponse :: Type -> Type #

NFData GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

type Rep GetIntegrationResponseResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.GetIntegrationResponse

type Rep GetIntegrationResponseResponse = D1 ('MetaData "GetIntegrationResponseResponse" "Amazonka.ApiGatewayV2.GetIntegrationResponse" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "GetIntegrationResponseResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "integrationResponseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "integrationResponseKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "contentHandlingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :*: S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetIntegrationResponseResponse Source #

Create a value of GetIntegrationResponseResponse 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:integrationResponseId:GetIntegrationResponse', getIntegrationResponseResponse_integrationResponseId - The integration response ID.

$sel:integrationResponseKey:GetIntegrationResponseResponse', getIntegrationResponseResponse_integrationResponseKey - The integration response key.

$sel:templateSelectionExpression:GetIntegrationResponseResponse', getIntegrationResponseResponse_templateSelectionExpression - The template selection expressions for the integration response.

$sel:contentHandlingStrategy:GetIntegrationResponseResponse', getIntegrationResponseResponse_contentHandlingStrategy - Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

$sel:responseTemplates:GetIntegrationResponseResponse', getIntegrationResponseResponse_responseTemplates - The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:responseParameters:GetIntegrationResponseResponse', getIntegrationResponseResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

$sel:httpStatus:GetIntegrationResponseResponse', getIntegrationResponseResponse_httpStatus - The response's http status code.

Response Lenses

getIntegrationResponseResponse_templateSelectionExpression :: Lens' GetIntegrationResponseResponse (Maybe Text) Source #

The template selection expressions for the integration response.

getIntegrationResponseResponse_contentHandlingStrategy :: Lens' GetIntegrationResponseResponse (Maybe ContentHandlingStrategy) Source #

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

getIntegrationResponseResponse_responseTemplates :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

getIntegrationResponseResponse_responseParameters :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.