Amazonka.APIGateway.PutIntegrationResponse

Represents a put integration.

Creating a Request

data PutIntegrationResponse

Represents a put integration response request.

See: newPutIntegrationResponse smart constructor.

Constructors

PutIntegrationResponse'

Fields

• contentHandling :: Maybe ContentHandlingStrategy

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

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

• responseParameters :: Maybe (HashMap Text Text)

  A key-value map specifying response parameters that are passed to the method response from the back end. 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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

• responseTemplates :: Maybe (HashMap Text Text)

  Specifies a put integration response's templates.

• selectionPattern :: Maybe Text

  Specifies the selection pattern of a put integration response.

• restApiId :: Text

  The string identifier of the associated RestApi.

• resourceId :: Text

  Specifies a put integration response request's resource identifier.

• httpMethod :: Text

  Specifies a put integration response request's HTTP method.

• statusCode :: Text

  Specifies the status code that is used to map the integration response to an existing MethodResponse.

Instances

ToJSON PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

toJSON :: PutIntegrationResponse -> Value

toEncoding :: PutIntegrationResponse -> Encoding

toJSONList :: [PutIntegrationResponse] -> Value

toEncodingList :: [PutIntegrationResponse] -> Encoding

ToHeaders PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

toHeaders :: PutIntegrationResponse -> [Header]

ToPath PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

toPath :: PutIntegrationResponse -> ByteString

ToQuery PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

toQuery :: PutIntegrationResponse -> QueryString

AWSRequest PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Associated Types

type AWSResponse PutIntegrationResponse

Methods

request :: (Service -> Service) -> PutIntegrationResponse -> Request PutIntegrationResponse

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutIntegrationResponse)))

Generic PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Associated Types

type Rep PutIntegrationResponse :: Type -> Type

Methods

from :: PutIntegrationResponse -> Rep PutIntegrationResponse x

to :: Rep PutIntegrationResponse x -> PutIntegrationResponse

Read PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

readsPrec :: Int -> ReadS PutIntegrationResponse

readList :: ReadS [PutIntegrationResponse]

readPrec :: ReadPrec PutIntegrationResponse

readListPrec :: ReadPrec [PutIntegrationResponse]

Show PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

showsPrec :: Int -> PutIntegrationResponse -> ShowS

show :: PutIntegrationResponse -> String

showList :: [PutIntegrationResponse] -> ShowS

NFData PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

rnf :: PutIntegrationResponse -> ()

Eq PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

(==) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool

(/=) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool

Hashable PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

Methods

hashWithSalt :: Int -> PutIntegrationResponse -> Int

hash :: PutIntegrationResponse -> Int

type AWSResponse PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

type AWSResponse PutIntegrationResponse = IntegrationResponse

type Rep PutIntegrationResponse

Defined in Amazonka.APIGateway.PutIntegrationResponse

type Rep PutIntegrationResponse = D1 ('MetaData "PutIntegrationResponse" "Amazonka.APIGateway.PutIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutIntegrationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :*: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutIntegrationResponse

Arguments

:: Text

PutIntegrationResponse

-> Text

$sel:resourceId:PutIntegrationResponse'

-> Text

PutIntegrationResponse

-> Text

PutIntegrationResponse

-> PutIntegrationResponse

Create a value of PutIntegrationResponse 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:

PutIntegrationResponse, putIntegrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

PutIntegrationResponse, putIntegrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. 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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

PutIntegrationResponse, putIntegrationResponse_responseTemplates - Specifies a put integration response's templates.

PutIntegrationResponse, putIntegrationResponse_selectionPattern - Specifies the selection pattern of a put integration response.

PutIntegrationResponse, putIntegrationResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutIntegrationResponse', putIntegrationResponse_resourceId - Specifies a put integration response request's resource identifier.

PutIntegrationResponse, putIntegrationResponse_httpMethod - Specifies a put integration response request's HTTP method.

PutIntegrationResponse, putIntegrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

Request Lenses

putIntegrationResponse_contentHandling :: Lens' PutIntegrationResponse (Maybe ContentHandlingStrategy)

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

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

putIntegrationResponse_responseParameters :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))

A key-value map specifying response parameters that are passed to the method response from the back end. 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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

putIntegrationResponse_responseTemplates :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))

Specifies a put integration response's templates.

putIntegrationResponse_selectionPattern :: Lens' PutIntegrationResponse (Maybe Text)

Specifies the selection pattern of a put integration response.

putIntegrationResponse_restApiId :: Lens' PutIntegrationResponse Text

The string identifier of the associated RestApi.

putIntegrationResponse_resourceId :: Lens' PutIntegrationResponse Text

Specifies a put integration response request's resource identifier.

putIntegrationResponse_httpMethod :: Lens' PutIntegrationResponse Text

Specifies a put integration response request's HTTP method.

putIntegrationResponse_statusCode :: Lens' PutIntegrationResponse Text

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Destructuring the Response

data IntegrationResponse

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse'

Fields

• contentHandling :: Maybe ContentHandlingStrategy

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

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

• responseParameters :: Maybe (HashMap Text Text)

  A key-value map specifying response parameters that are passed to the method response from the back end. 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.

• responseTemplates :: Maybe (HashMap Text Text)

  Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

• selectionPattern :: Maybe Text

  Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

• statusCode :: Maybe Text

  Specifies the status code that is used to map the integration response to an existing MethodResponse.

Instances

FromJSON IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

parseJSON :: Value -> Parser IntegrationResponse

parseJSONList :: Value -> Parser [IntegrationResponse]

Generic IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Associated Types

type Rep IntegrationResponse :: Type -> Type

Methods

from :: IntegrationResponse -> Rep IntegrationResponse x

to :: Rep IntegrationResponse x -> IntegrationResponse

Read IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

readsPrec :: Int -> ReadS IntegrationResponse

readList :: ReadS [IntegrationResponse]

readPrec :: ReadPrec IntegrationResponse

readListPrec :: ReadPrec [IntegrationResponse]

Show IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

showsPrec :: Int -> IntegrationResponse -> ShowS

show :: IntegrationResponse -> String

showList :: [IntegrationResponse] -> ShowS

NFData IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

rnf :: IntegrationResponse -> ()

Eq IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

(==) :: IntegrationResponse -> IntegrationResponse -> Bool

(/=) :: IntegrationResponse -> IntegrationResponse -> Bool

Hashable IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

Methods

hashWithSalt :: Int -> IntegrationResponse -> Int

hash :: IntegrationResponse -> Int

type Rep IntegrationResponse

Defined in Amazonka.APIGateway.Types.IntegrationResponse

type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.APIGateway.Types.IntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :*: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntegrationResponse :: IntegrationResponse

Create a value of IntegrationResponse 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:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. 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:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

Response Lenses

integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)

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

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

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))

A key-value map specifying response parameters that are passed to the method response from the back end. 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.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text)

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text)

Specifies the status code that is used to map the integration response to an existing MethodResponse.