Skip to main content

AWSAPIGatewayWebSocketAPIIntegration

No description

type AWSAPIGatewayWebSocketAPIIntegration {
  apiGatewayManaged: Boolean!
  contentHandlingStrategy: AWSAPIGatewayIntegrationContentHandlingStrategyType!
  credentialsArn: String!
  description: String!
  id: String!
  method: String!
  responseSelectionExpression: String!
  type: AWSAPIGatewayIntegrationType!
  uri: String!
  passthroughBehavior: AWSAPIGatewayV2IntegrationPassthroughBehaviorType!
  requestParameters: [AWSTag!]!
  requestTemplates: [AWSTag!]!
  templateSelectionExpression: String!
  timeoutInMillis: Int!
}

Fields​

AWSAPIGatewayWebSocketAPIIntegration.apiGatewayManaged ● Boolean! non-null scalar​

Indicates whether the integration is managed by API Gateway

AWSAPIGatewayWebSocketAPIIntegration.contentHandlingStrategy ● AWSAPIGatewayIntegrationContentHandlingStrategyType! non-null enum​

Indicates how to handle response payload content type conversions

AWSAPIGatewayWebSocketAPIIntegration.credentialsArn ● String! non-null scalar​

The credentials required for the integration, if any

AWSAPIGatewayWebSocketAPIIntegration.description ● String! non-null scalar​

The description of the integration

AWSAPIGatewayWebSocketAPIIntegration.id ● String! non-null scalar​

The identifier of the integration

AWSAPIGatewayWebSocketAPIIntegration.method ● String! non-null scalar​

The integration's HTTP method type

AWSAPIGatewayWebSocketAPIIntegration.responseSelectionExpression ● String! non-null scalar​

The integration response selection expression for the integration

AWSAPIGatewayWebSocketAPIIntegration.type ● AWSAPIGatewayIntegrationType! non-null enum​

The integration type of an integration

AWSAPIGatewayWebSocketAPIIntegration.uri ● String! non-null scalar​

The URI of the integration endpoint

AWSAPIGatewayWebSocketAPIIntegration.passthroughBehavior ● AWSAPIGatewayV2IntegrationPassthroughBehaviorType! non-null enum​

the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource

AWSAPIGatewayWebSocketAPIIntegration.requestParameters ● [AWSTag!]! non-null object​

a key-value map specifying request parameters

AWSAPIGatewayWebSocketAPIIntegration.requestTemplates ● [AWSTag!]! non-null object​

A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client

AWSAPIGatewayWebSocketAPIIntegration.templateSelectionExpression ● String! non-null scalar​

The template selection expression for the integration

AWSAPIGatewayWebSocketAPIIntegration.timeoutInMillis ● Int! non-null scalar​

Custom timeout The range for WebSocket APIs: 50 and 29,000 milliseconds The range for HTTP APIs: 50 and 30,000 milliseconds The default timeout for WebSocket APIs is 29 seconds The default timeout for HTTP APIs is 30 seconds

Member of​

AWSAPIGatewayWebSocketAPI object