Network.AWS.APIGateway.PutIntegration

Represents a put integration.

Creating a Request

putIntegration

Arguments

:: Text

pRestAPIId

-> Text

pResourceId

-> Text

pHttpMethod

-> IntegrationType

pType

-> PutIntegration

Creates a value of PutIntegration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pRequestTemplates
• pCredentials
• pRequestParameters
• pUri
• pCacheNamespace
• pIntegrationHTTPMethod
• pCacheKeyParameters
• pRestAPIId
• pResourceId
• pHttpMethod
• pType

data PutIntegration

Represents a put integration request.

See: putIntegration smart constructor.

Instances

Eq PutIntegration

Data PutIntegration

Read PutIntegration

Show PutIntegration

Generic PutIntegration

ToJSON PutIntegration

Hashable PutIntegration

AWSRequest PutIntegration

ToPath PutIntegration

ToHeaders PutIntegration

ToQuery PutIntegration

type Rep PutIntegration

type Rs PutIntegration = Integration

Request Lenses

pRequestTemplates :: Lens' PutIntegration (HashMap Text Text)

Specifies the templates used to transform the method request body. Request templates are represented as a key/value map, with a content-type as the key and a template as the value.

pCredentials :: Lens' PutIntegration (Maybe Text)

Specifies whether credentials are required for a put integration.

pRequestParameters :: Lens' PutIntegration (HashMap Text Text)

Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern 'integration.request.{location}.{name}', where location is either querystring, path, or header. name must be a valid, unique parameter name.

pUri :: Lens' PutIntegration (Maybe Text)

Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required.

pCacheNamespace :: Lens' PutIntegration (Maybe Text)

Specifies a put integration input's cache namespace.

pIntegrationHTTPMethod :: Lens' PutIntegration (Maybe Text)

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

pCacheKeyParameters :: Lens' PutIntegration [Text]

Specifies a put integration input's cache key parameters.

pRestAPIId :: Lens' PutIntegration Text

Specifies a put integration request's API identifier.

pResourceId :: Lens' PutIntegration Text

Specifies a put integration request's resource ID.

pHttpMethod :: Lens' PutIntegration Text

Specifies a put integration request's HTTP method.

pType :: Lens' PutIntegration IntegrationType

Specifies a put integration input's type.

Destructuring the Response

integration :: Integration

Creates a value of Integration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iHttpMethod
• iRequestTemplates
• iCredentials
• iRequestParameters
• iUri
• iIntegrationResponses
• iCacheNamespace
• iType
• iCacheKeyParameters

data Integration

Represents a HTTP, AWS, or Mock integration.

See: integration smart constructor.

Instances

Eq Integration

Data Integration

Read Integration

Show Integration

Generic Integration

FromJSON Integration

Hashable Integration

type Rep Integration

Response Lenses

iHttpMethod :: Lens' Integration (Maybe Text)

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text)

Specifies the integration's request templates.

iCredentials :: Lens' Integration (Maybe Text)

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string 'arn:aws:iam::\\*:user\/\\*'. To use resource-based permissions on supported AWS services, specify null.

iRequestParameters :: Lens' Integration (HashMap Text Text)

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern 'integration.request.{location}.{name}', where location is either querystring, path, or header. name must be a valid, unique parameter name.

iUri :: Lens' Integration (Maybe Text)

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form 'arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}'. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the 'Action=' query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial \/.

iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)

Specifies the integration's responses.

iCacheNamespace :: Lens' Integration (Maybe Text)

Specifies the integration's cache namespace.

iType :: Lens' Integration (Maybe IntegrationType)

Specifies the integration's type.

iCacheKeyParameters :: Lens' Integration [Text]

Specifies the integration's cache key parameters.