5.0.0 • Published 5 years ago

@datafire/amazonaws_apigatewayv2 v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_apigatewayv2

Client library for AmazonApiGatewayV2

Installation and Usage

npm install --save @datafire/amazonaws_apigatewayv2
let amazonaws_apigatewayv2 = require('@datafire/amazonaws_apigatewayv2').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon API Gateway V2

Actions

GetApis

amazonaws_apigatewayv2.GetApis({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

CreateApi

amazonaws_apigatewayv2.CreateApi({
  "name": "",
  "protocolType": ""
}, context)

Input

  • input object
    • tags object: Represents a collection of tags associated with the resource.
    • apiKeySelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • corsConfiguration object: Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
    • credentialsArn string: Represents an Amazon Resource Name (ARN).
    • description string: A string with a length between 0-1024.
    • disableExecuteApiEndpoint boolean: 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.
    • disableSchemaValidation boolean: Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    • name required string: A string with a length between 1-128.
    • protocolType required string (values: WEBSOCKET, HTTP): Represents a protocol type.
    • routeKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • routeSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • target string: A string representation of a URI with a length between 1-2048.
    • version string: A string with a length between 1-64.

Output

Output schema unknown

ImportApi

amazonaws_apigatewayv2.ImportApi({
  "body": ""
}, context)

Input

  • input object
    • basepath string
    • failOnWarnings boolean
    • body required string: The OpenAPI definition. Supported only for HTTP APIs.

Output

Output schema unknown

DeleteApi

amazonaws_apigatewayv2.DeleteApi({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string

Output

Output schema unknown

GetApi

amazonaws_apigatewayv2.GetApi({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string

Output

UpdateApi

amazonaws_apigatewayv2.UpdateApi({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • apiKeySelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • corsConfiguration object: Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
    • credentialsArn string: Represents an Amazon Resource Name (ARN).
    • description string: A string with a length between 0-1024.
    • disableExecuteApiEndpoint boolean: 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.
    • disableSchemaValidation boolean: Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    • name string: A string with a length between 1-128.
    • routeKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • routeSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • target string: A string representation of a URI with a length between 1-2048.
    • version string: A string with a length between 1-64.

Output

ReimportApi

amazonaws_apigatewayv2.ReimportApi({
  "apiId": "",
  "body": ""
}, context)

Input

  • input object
    • apiId required string
    • basepath string
    • failOnWarnings boolean
    • body required string: The OpenAPI definition. Supported only for HTTP APIs.

Output

Output schema unknown

GetAuthorizers

amazonaws_apigatewayv2.GetAuthorizers({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateAuthorizer

amazonaws_apigatewayv2.CreateAuthorizer({
  "apiId": "",
  "authorizerType": "",
  "identitySource": [],
  "name": ""
}, context)

Input

  • input object
    • apiId required string
    • authorizerCredentialsArn string: Represents an Amazon Resource Name (ARN).
    • authorizerPayloadFormatVersion string: A string with a length between 1-64.
    • authorizerResultTtlInSeconds integer: An integer with a value between 0-3600.
    • authorizerType required string (values: REQUEST, JWT): The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
    • authorizerUri string: A string representation of a URI with a length between 1-2048.
    • enableSimpleResponses boolean: Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
    • identitySource required array: The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    • identityValidationExpression string: A string with a length between 0-1024.
    • jwtConfiguration object: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    • name required string: A string with a length between 1-128.

Output

Output schema unknown

DeleteAuthorizer

amazonaws_apigatewayv2.DeleteAuthorizer({
  "apiId": "",
  "authorizerId": ""
}, context)

Input

  • input object
    • apiId required string
    • authorizerId required string

Output

Output schema unknown

GetAuthorizer

amazonaws_apigatewayv2.GetAuthorizer({
  "apiId": "",
  "authorizerId": ""
}, context)

Input

  • input object
    • apiId required string
    • authorizerId required string

Output

UpdateAuthorizer

amazonaws_apigatewayv2.UpdateAuthorizer({
  "apiId": "",
  "authorizerId": ""
}, context)

Input

  • input object
    • apiId required string
    • authorizerId required string
    • authorizerCredentialsArn string: Represents an Amazon Resource Name (ARN).
    • authorizerPayloadFormatVersion string: A string with a length between 1-64.
    • authorizerResultTtlInSeconds integer: An integer with a value between 0-3600.
    • authorizerType string (values: REQUEST, JWT): The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
    • authorizerUri string: A string representation of a URI with a length between 1-2048.
    • enableSimpleResponses boolean: Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
    • identitySource array: The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    • identityValidationExpression string: A string with a length between 0-1024.
    • jwtConfiguration object: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    • name string: A string with a length between 1-128.

Output

DeleteCorsConfiguration

amazonaws_apigatewayv2.DeleteCorsConfiguration({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string

Output

Output schema unknown

GetDeployments

amazonaws_apigatewayv2.GetDeployments({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateDeployment

amazonaws_apigatewayv2.CreateDeployment({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • description string: A string with a length between 0-1024.
    • stageName string: A string with a length between 1-128.

Output

Output schema unknown

DeleteDeployment

amazonaws_apigatewayv2.DeleteDeployment({
  "apiId": "",
  "deploymentId": ""
}, context)

Input

  • input object
    • apiId required string
    • deploymentId required string

Output

Output schema unknown

GetDeployment

amazonaws_apigatewayv2.GetDeployment({
  "apiId": "",
  "deploymentId": ""
}, context)

Input

  • input object
    • apiId required string
    • deploymentId required string

Output

UpdateDeployment

amazonaws_apigatewayv2.UpdateDeployment({
  "apiId": "",
  "deploymentId": ""
}, context)

Input

  • input object
    • apiId required string
    • deploymentId required string
    • description string: A string with a length between 0-1024.

Output

ExportApi

amazonaws_apigatewayv2.ExportApi({
  "apiId": "",
  "outputType": "",
  "specification": ""
}, context)

Input

  • input object
    • apiId required string
    • exportVersion string
    • includeExtensions boolean
    • outputType required string
    • specification required string
    • stageName string

Output

GetIntegrations

amazonaws_apigatewayv2.GetIntegrations({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateIntegration

amazonaws_apigatewayv2.CreateIntegration({
  "apiId": "",
  "integrationType": ""
}, context)

Input

  • input object
    • apiId required string
    • connectionId string: A string with a length between 1-1024.
    • connectionType string (values: INTERNET, VPC_LINK): Represents a connection type.
    • contentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT): Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
    • credentialsArn string: Represents an Amazon Resource Name (ARN).
    • description string: A string with a length between 0-1024.
    • integrationMethod string: A string with a length between 1-64.
    • integrationSubtype string: A string with a length between 1-128.
    • integrationType required string (values: AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY): Represents an API method integration type.
    • integrationUri string: A string representation of a URI with a length between 1-2048.
    • passthroughBehavior string (values: WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES): Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
    • payloadFormatVersion string: A string with a length between 1-64.
    • requestParameters object: 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.
    • requestTemplates object: A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
    • templateSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • timeoutInMillis integer: An integer with a value between 50-30000.
    • tlsConfig object: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
      • ServerNameToVerify

Output

Output schema unknown

DeleteIntegration

amazonaws_apigatewayv2.DeleteIntegration({
  "apiId": "",
  "integrationId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string

Output

Output schema unknown

GetIntegration

amazonaws_apigatewayv2.GetIntegration({
  "apiId": "",
  "integrationId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string

Output

UpdateIntegration

amazonaws_apigatewayv2.UpdateIntegration({
  "apiId": "",
  "integrationId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • connectionId string: A string with a length between 1-1024.
    • connectionType string (values: INTERNET, VPC_LINK): Represents a connection type.
    • contentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT): Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
    • credentialsArn string: Represents an Amazon Resource Name (ARN).
    • description string: A string with a length between 0-1024.
    • integrationMethod string: A string with a length between 1-64.
    • integrationSubtype string: A string with a length between 1-128.
    • integrationType string (values: AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY): Represents an API method integration type.
    • integrationUri string: A string representation of a URI with a length between 1-2048.
    • passthroughBehavior string (values: WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES): Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
    • payloadFormatVersion string: A string with a length between 1-64.
    • requestParameters object: 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.
    • requestTemplates object: A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
    • templateSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • timeoutInMillis integer: An integer with a value between 50-30000.
    • tlsConfig object: The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
      • ServerNameToVerify

Output

GetIntegrationResponses

amazonaws_apigatewayv2.GetIntegrationResponses({
  "apiId": "",
  "integrationId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • maxResults string
    • nextToken string

Output

CreateIntegrationResponse

amazonaws_apigatewayv2.CreateIntegrationResponse({
  "apiId": "",
  "integrationId": "",
  "integrationResponseKey": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • contentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT): Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
    • integrationResponseKey required string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • responseParameters object: 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.
    • responseTemplates object: A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
    • templateSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.

Output

Output schema unknown

DeleteIntegrationResponse

amazonaws_apigatewayv2.DeleteIntegrationResponse({
  "apiId": "",
  "integrationId": "",
  "integrationResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • integrationResponseId required string

Output

Output schema unknown

GetIntegrationResponse

amazonaws_apigatewayv2.GetIntegrationResponse({
  "apiId": "",
  "integrationId": "",
  "integrationResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • integrationResponseId required string

Output

UpdateIntegrationResponse

amazonaws_apigatewayv2.UpdateIntegrationResponse({
  "apiId": "",
  "integrationId": "",
  "integrationResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • integrationId required string
    • integrationResponseId required string
    • contentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT): Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
    • integrationResponseKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • responseParameters object: 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.
    • responseTemplates object: A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
    • templateSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.

Output

GetModels

amazonaws_apigatewayv2.GetModels({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateModel

amazonaws_apigatewayv2.CreateModel({
  "apiId": "",
  "name": "",
  "schema": ""
}, context)

Input

  • input object
    • apiId required string
    • contentType string: A string with a length between 1-256.
    • description string: A string with a length between 0-1024.
    • name required string: A string with a length between 1-128.
    • schema required string: A string with a length between 0-32768.

Output

Output schema unknown

DeleteModel

amazonaws_apigatewayv2.DeleteModel({
  "apiId": "",
  "modelId": ""
}, context)

Input

  • input object
    • apiId required string
    • modelId required string

Output

Output schema unknown

GetModel

amazonaws_apigatewayv2.GetModel({
  "apiId": "",
  "modelId": ""
}, context)

Input

  • input object
    • apiId required string
    • modelId required string

Output

UpdateModel

amazonaws_apigatewayv2.UpdateModel({
  "apiId": "",
  "modelId": ""
}, context)

Input

  • input object
    • apiId required string
    • modelId required string
    • contentType string: A string with a length between 1-256.
    • description string: A string with a length between 0-1024.
    • name string: A string with a length between 1-128.
    • schema string: A string with a length between 0-32768.

Output

GetModelTemplate

amazonaws_apigatewayv2.GetModelTemplate({
  "apiId": "",
  "modelId": ""
}, context)

Input

  • input object
    • apiId required string
    • modelId required string

Output

GetRoutes

amazonaws_apigatewayv2.GetRoutes({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateRoute

amazonaws_apigatewayv2.CreateRoute({
  "apiId": "",
  "routeKey": ""
}, context)

Input

  • input object
    • apiId required string
    • apiKeyRequired boolean: Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
    • authorizationScopes array: A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    • authorizationType string (values: NONE, AWS_IAM, CUSTOM, JWT): The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
    • authorizerId string: The identifier.
    • modelSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • operationName string: A string with a length between 1-64.
    • requestModels object: The route models.
    • requestParameters object: The route parameters.
    • routeKey required string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • routeResponseSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • target string: A string with a length between 1-128.

Output

Output schema unknown

DeleteRoute

amazonaws_apigatewayv2.DeleteRoute({
  "apiId": "",
  "routeId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string

Output

Output schema unknown

GetRoute

amazonaws_apigatewayv2.GetRoute({
  "apiId": "",
  "routeId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string

Output

UpdateRoute

amazonaws_apigatewayv2.UpdateRoute({
  "apiId": "",
  "routeId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string
    • apiKeyRequired boolean: Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
    • authorizationScopes array: A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    • authorizationType string (values: NONE, AWS_IAM, CUSTOM, JWT): The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
    • authorizerId string: The identifier.
    • modelSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • operationName string: A string with a length between 1-64.
    • requestModels object: The route models.
    • requestParameters object: The route parameters.
    • routeKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • routeResponseSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • target string: A string with a length between 1-128.

Output

DeleteRouteRequestParameter

amazonaws_apigatewayv2.DeleteRouteRequestParameter({
  "apiId": "",
  "requestParameterKey": "",
  "routeId": ""
}, context)

Input

  • input object
    • apiId required string
    • requestParameterKey required string
    • routeId required string

Output

Output schema unknown

GetRouteResponses

amazonaws_apigatewayv2.GetRouteResponses({
  "apiId": "",
  "routeId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string
    • routeId required string

Output

CreateRouteResponse

amazonaws_apigatewayv2.CreateRouteResponse({
  "apiId": "",
  "routeId": "",
  "routeResponseKey": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string
    • modelSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • responseModels object: The route models.
    • responseParameters object: The route parameters.
    • routeResponseKey required string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Output

Output schema unknown

DeleteRouteResponse

amazonaws_apigatewayv2.DeleteRouteResponse({
  "apiId": "",
  "routeId": "",
  "routeResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string
    • routeResponseId required string

Output

Output schema unknown

GetRouteResponse

amazonaws_apigatewayv2.GetRouteResponse({
  "apiId": "",
  "routeId": "",
  "routeResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string
    • routeResponseId required string

Output

UpdateRouteResponse

amazonaws_apigatewayv2.UpdateRouteResponse({
  "apiId": "",
  "routeId": "",
  "routeResponseId": ""
}, context)

Input

  • input object
    • apiId required string
    • routeId required string
    • routeResponseId required string
    • modelSelectionExpression string: An expression used to extract information at runtime. See Selection Expressions for more information.
    • responseModels object: The route models.
    • responseParameters object: The route parameters.
    • routeResponseKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Output

GetStages

amazonaws_apigatewayv2.GetStages({
  "apiId": ""
}, context)

Input

  • input object
    • apiId required string
    • maxResults string
    • nextToken string

Output

CreateStage

amazonaws_apigatewayv2.CreateStage({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • tags object: Represents a collection of tags associated with the resource.
    • accessLogSettings object: Settings for logging access in a stage.
      • DestinationArn
      • Format
    • autoDeploy boolean: Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    • clientCertificateId string: The identifier.
    • defaultRouteSettings object: Represents a collection of route settings.
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • deploymentId string: The identifier.
    • description string: A string with a length between 0-1024.
    • routeSettings object: The route settings map.
    • stageName required string: A string with a length between 1-128.
    • stageVariables object: The stage variable map.

Output

Output schema unknown

DeleteStage

amazonaws_apigatewayv2.DeleteStage({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • stageName required string

Output

Output schema unknown

GetStage

amazonaws_apigatewayv2.GetStage({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • stageName required string

Output

UpdateStage

amazonaws_apigatewayv2.UpdateStage({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • stageName required string
    • accessLogSettings object: Settings for logging access in a stage.
      • DestinationArn
      • Format
    • autoDeploy boolean: Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    • clientCertificateId string: The identifier.
    • defaultRouteSettings object: Represents a collection of route settings.
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • deploymentId string: The identifier.
    • description string: A string with a length between 0-1024.
    • routeSettings object: The route settings map.
    • stageVariables object: The stage variable map.

Output

DeleteAccessLogSettings

amazonaws_apigatewayv2.DeleteAccessLogSettings({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • stageName required string

Output

Output schema unknown

ResetAuthorizersCache

amazonaws_apigatewayv2.ResetAuthorizersCache({
  "apiId": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • stageName required string

Output

Output schema unknown

DeleteRouteSettings

amazonaws_apigatewayv2.DeleteRouteSettings({
  "apiId": "",
  "routeKey": "",
  "stageName": ""
}, context)

Input

  • input object
    • apiId required string
    • routeKey required string
    • stageName required string

Output

Output schema unknown

GetDomainNames

amazonaws_apigatewayv2.GetDomainNames({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

CreateDomainName

amazonaws_apigatewayv2.CreateDomainName({
  "domainName": ""
}, context)

Input

  • input object
    • tags object: Represents a collection of tags associated with the resource.
    • domainName required string: A string with a length between 1-512.
    • domainNameConfigurations array: The domain name configurations.
    • mutualTlsAuthentication object: The mutual TLS authentication configuration for a custom domain name.
      • TruststoreUri
      • TruststoreVersion

Output

Output schema unknown

DeleteDomainName

amazonaws_apigatewayv2.DeleteDomainName({
  "domainName": ""
}, context)

Input

  • input object
    • domainName required string

Output

Output schema unknown

GetDomainName

amazonaws_apigatewayv2.GetDomainName({
  "domainName": ""
}, context)

Input

  • input object
    • domainName required string

Output

UpdateDomainName

amazonaws_apigatewayv2.UpdateDomainName({
  "domainName": ""
}, context)

Input

  • input object
    • domainName required string
    • domainNameConfigurations array: The domain name configurations.
    • mutualTlsAuthentication object: The mutual TLS authentication configuration for a custom domain name.
      • TruststoreUri
      • TruststoreVersion

Output

GetApiMappings

amazonaws_apigatewayv2.GetApiMappings({
  "domainName": ""
}, context)

Input

  • input object
    • domainName required string
    • maxResults string
    • nextToken string

Output

CreateApiMapping

amazonaws_apigatewayv2.CreateApiMapping({
  "domainName": "",
  "apiId": "",
  "stage": ""
}, context)

Input

  • input object
    • domainName required string
    • apiId required string: The identifier.
    • apiMappingKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • stage required string: A string with a length between 1-128.

Output

Output schema unknown

DeleteApiMapping

amazonaws_apigatewayv2.DeleteApiMapping({
  "apiMappingId": "",
  "domainName": ""
}, context)

Input

  • input object
    • apiMappingId required string
    • domainName required string

Output

Output schema unknown

GetApiMapping

amazonaws_apigatewayv2.GetApiMapping({
  "apiMappingId": "",
  "domainName": ""
}, context)

Input

  • input object
    • apiMappingId required string
    • domainName required string

Output

UpdateApiMapping

amazonaws_apigatewayv2.UpdateApiMapping({
  "apiMappingId": "",
  "domainName": "",
  "apiId": ""
}, context)

Input

  • input object
    • apiMappingId required string
    • domainName required string
    • apiId required string: The identifier.
    • apiMappingKey string: After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
    • stage string: A string with a length between 1-128.

Output

GetTags

amazonaws_apigatewayv2.GetTags({
  "resource-arn": ""
}, context)

Input

  • input object
    • resource-arn required string

Output

TagResource

amazonaws_apigatewayv2.TagResource({
  "resource-arn": ""
}, context)

Input

  • input object
    • resource-arn required string
    • tags object: Represents a collection of tags associated with the resource.

Output

Output schema unknown

UntagResource

amazonaws_apigatewayv2.UntagResource({
  "resource-arn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resource-arn required string
    • tagKeys required array

Output

Output schema unknown

GetVpcLinks

amazonaws_apigatewayv2.GetVpcLinks({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

CreateVpcLink

amazonaws_apigatewayv2.CreateVpcLink({
  "name": "",
  "subnetIds": []
}, context)

Input

  • input object
    • tags object: Represents a collection of tags associated with the resource.
    • name required string: A string with a length between 1-128.
    • securityGroupIds array: A list of security group IDs for the VPC link.
    • subnetIds required array: A list of subnet IDs to include in the VPC link.

Output

Output schema unknown

DeleteVpcLink

amazonaws_apigatewayv2.DeleteVpcLink({
  "vpcLinkId": ""
}, context)

Input

  • input object
    • vpcLinkId required string

Output

Output schema unknown

GetVpcLink

amazonaws_apigatewayv2.GetVpcLink({
  "vpcLinkId": ""
}, context)

Input

  • input object
    • vpcLinkId required string

Output

UpdateVpcLink

amazonaws_apigatewayv2.UpdateVpcLink({
  "vpcLinkId": ""
}, context)

Input

  • input object
    • vpcLinkId required string
    • name string: A string with a length between 1-128.

Output

Definitions

AccessDeniedException

AccessLogSettings

  • AccessLogSettings object: Settings for logging access in a stage.
    • DestinationArn
    • Format

Api

  • Api object: Represents an API.
    • ApiEndpoint
    • ApiGatewayManaged
    • ApiId
    • ApiKeySelectionExpression
    • CorsConfiguration
    • CreatedDate
    • Description
    • DisableExecuteApiEndpoint
    • DisableSchemaValidation
    • ImportInfo
    • Name required
    • ProtocolType required
    • RouteSelectionExpression required
    • Tags
    • Version
    • Warnings

ApiMapping

  • ApiMapping object: Represents an API mapping.
    • ApiId required
    • ApiMappingId
    • ApiMappingKey
    • Stage required

Arn

  • Arn string: Represents an Amazon Resource Name (ARN).

AuthorizationScopes

  • AuthorizationScopes array: A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

AuthorizationType

  • AuthorizationType string (values: NONE, AWS_IAM, CUSTOM, JWT): The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Authorizer

  • Authorizer object: Represents an authorizer.
    • AuthorizerCredentialsArn
    • AuthorizerId
    • AuthorizerPayloadFormatVersion
    • AuthorizerResultTtlInSeconds
    • AuthorizerType
    • AuthorizerUri
    • EnableSimpleResponses
    • IdentitySource
    • IdentityValidationExpression
    • JwtConfiguration
    • Name required

AuthorizerType

  • AuthorizerType string (values: REQUEST, JWT): The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

BadRequestException

ConflictException

ConnectionType

  • ConnectionType string (values: INTERNET, VPC_LINK): Represents a connection type.

ContentHandlingStrategy

  • ContentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT): Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

Cors

  • Cors object: Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

CorsHeaderList

  • CorsHeaderList array: Represents a collection of allowed headers. Supported only for HTTP APIs.

CorsMethodList

CorsOriginList

  • CorsOriginList array: Represents a collection of origins. Supported only for HTTP APIs.

CreateApiMappingRequest

  • CreateApiMappingRequest object: Creates a new ApiMapping resource to represent an API mapping.
    • ApiId required
    • ApiMappingKey
    • Stage required

CreateApiMappingResponse

  • CreateApiMappingResponse object
    • ApiId
    • ApiMappingId
    • ApiMappingKey
    • Stage

CreateApiRequest

  • CreateApiRequest object: Creates a new Api resource to represent an API.
    • ApiKeySelectionExpression
    • CorsConfiguration
    • CredentialsArn
    • Description
    • DisableExecuteApiEndpoint
    • DisableSchemaValidation
    • Name required
    • ProtocolType required
    • RouteKey
    • RouteSelectionExpression
    • Tags
    • Target
    • Version

CreateApiResponse

  • CreateApiResponse object
    • ApiEndpoint
    • ApiGatewayManaged
    • ApiId
    • ApiKeySelectionExpression
    • CorsConfiguration
    • CreatedDate
    • Description
    • DisableExecuteApiEndpoint
    • DisableSchemaValidation
    • ImportInfo
    • Name
    • ProtocolType
    • RouteSelectionExpression
    • Tags
    • Version
    • Warnings

CreateAuthorizerRequest

  • CreateAuthorizerRequest object: Creates a new Authorizer resource to represent an authorizer.
    • AuthorizerCredentialsArn
    • AuthorizerPayloadFormatVersion
    • AuthorizerResultTtlInSeconds
    • AuthorizerType required
    • AuthorizerUri
    • EnableSimpleResponses
    • IdentitySource required
    • IdentityValidationExpression
    • JwtConfiguration
    • Name required

CreateAuthorizerResponse

  • CreateAuthorizerResponse object
    • AuthorizerCredentialsArn
    • AuthorizerId
    • AuthorizerPayloadFormatVersion
    • AuthorizerResultTtlInSeconds
    • AuthorizerType
    • AuthorizerUri
    • EnableSimpleResponses
    • IdentitySource
    • IdentityValidationExpression
    • JwtConfiguration
    • Name

CreateDeploymentRequest

  • CreateDeploymentRequest object: Creates a new Deployment resource to represent a deployment.
    • Description
    • StageName

CreateDeploymentResponse

  • CreateDeploymentResponse object
    • AutoDeployed
    • CreatedDate
    • DeploymentId
    • DeploymentStatus
    • DeploymentStatusMessage
    • Description

CreateDomainNameRequest

  • CreateDomainNameRequest object: Creates a new DomainName resource to represent a domain name.
    • DomainName required
    • DomainNameConfigurations
    • MutualTlsAuthentication
      • TruststoreUri
      • TruststoreVersion
    • Tags

CreateDomainNameResponse

  • CreateDomainNameResponse object
    • ApiMappingSelectionExpression
    • DomainName
    • DomainNameConfigurations
    • MutualTlsAuthentication
      • TruststoreUri
      • TruststoreVersion
      • TruststoreWarnings
    • Tags

CreateIntegrationRequest

  • CreateIntegrationRequest object: Creates a new Integration resource to represent an integration.
    • ConnectionId
    • ConnectionType
    • ContentHandlingStrategy
    • CredentialsArn
    • Description
    • IntegrationMethod
    • IntegrationSubtype
    • IntegrationType required
    • IntegrationUri
    • PassthroughBehavior
    • PayloadFormatVersion
    • RequestParameters
    • RequestTemplates
    • TemplateSelectionExpression
    • TimeoutInMillis
    • TlsConfig
      • ServerNameToVerify

CreateIntegrationResponseRequest

  • CreateIntegrationResponseRequest object: Creates a new IntegrationResponse resource to represent an integration response.
    • ContentHandlingStrategy
    • IntegrationResponseKey required
    • ResponseParameters
    • ResponseTemplates
    • TemplateSelectionExpression

CreateIntegrationResponseResponse

  • CreateIntegrationResponseResponse object
    • ContentHandlingStrategy
    • IntegrationResponseId
    • IntegrationResponseKey
    • ResponseParameters
    • ResponseTemplates
    • TemplateSelectionExpression

CreateIntegrationResult

  • CreateIntegrationResult object
    • ApiGatewayManaged
    • ConnectionId
    • ConnectionType
    • ContentHandlingStrategy
    • CredentialsArn
    • Description
    • IntegrationId
    • IntegrationMethod
    • IntegrationResponseSelectionExpression
    • IntegrationSubtype
    • IntegrationType
    • IntegrationUri
    • PassthroughBehavior
    • PayloadFormatVersion
    • RequestParameters
    • RequestTemplates
    • TemplateSelectionExpression
    • TimeoutInMillis
    • TlsConfig
      • ServerNameToVerify

CreateModelRequest

  • CreateModelRequest object: Creates a new Model.
    • ContentType
    • Description
    • Name required
    • Schema required

CreateModelResponse

  • CreateModelResponse object
    • ContentType
    • Description
    • ModelId
    • Name
    • Schema

CreateRouteRequest

  • CreateRouteRequest object: Creates a new Route resource to represent a route.
    • ApiKeyRequired
    • AuthorizationScopes
    • AuthorizationType
    • AuthorizerId
    • ModelSelectionExpression
    • OperationName
    • RequestModels
    • RequestParameters
    • RouteKey required
    • RouteResponseSelectionExpression
    • Target

CreateRouteResponseRequest

  • CreateRouteResponseRequest object: Creates a new RouteResponse resource to represent a route response.
    • ModelSelectionExpression
    • ResponseModels
    • ResponseParameters
    • RouteResponseKey required

CreateRouteResponseResponse

  • CreateRouteResponseResponse object
    • ModelSelectionExpression
    • ResponseModels
    • ResponseParameters
    • RouteResponseId
    • RouteResponseKey

CreateRouteResult

  • CreateRouteResult object
    • ApiGatewayManaged
    • ApiKeyRequired
    • AuthorizationScopes
    • AuthorizationType
    • AuthorizerId
    • ModelSelectionExpression
    • OperationName
    • RequestModels
    • RequestParameters
    • RouteId
    • RouteKey
    • RouteResponseSelectionExpression
    • Target

CreateStageRequest

  • CreateStageRequest object: Creates a new Stage resource to represent a stage.
    • AccessLogSettings
      • DestinationArn
      • Format
    • AutoDeploy
    • ClientCertificateId
    • DefaultRouteSettings
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • DeploymentId
    • Description
    • RouteSettings
    • StageName required
    • StageVariables
    • Tags

CreateStageResponse

  • CreateStageResponse object
    • AccessLogSettings
      • DestinationArn
      • Format
    • ApiGatewayManaged
    • AutoDeploy
    • ClientCertificateId
    • CreatedDate
    • DefaultRouteSettings
      • DataTraceEnabled
      • DetailedMetricsEnabled
      • LoggingLevel
      • ThrottlingBurstLimit
      • ThrottlingRateLimit
    • DeploymentId
    • Description
    • LastDeploymentStatusMessage
    • LastUpdatedDate
    • RouteSettings
    • StageName
    • StageVariables
    • Tags

CreateVpcLinkRequest

  • CreateVpcLinkRequest object: Creates a VPC link

CreateVpcLinkResponse

  • CreateVpcLinkResponse object
    • CreatedDate
    • Name
    • SecurityGroupIds
    • SubnetIds
    • Tags
    • VpcLinkId
    • VpcLinkStatus
    • VpcLinkStatusMessage
    • VpcLinkVersion

DeleteAccessLogSettingsRequest

  • DeleteAccessLogSettingsRequest object

DeleteApiMappingRequest

  • DeleteApiMappingRequest object

DeleteApiRequest

  • DeleteApiRequest object

DeleteAuthorizerRequest

  • DeleteAuthorizerRequest object

DeleteCorsConfigurationRequest

  • DeleteCorsConfigurationRequest object

DeleteDeploymentRequest

  • DeleteDeploymentRequest object

DeleteDomainNameRequest

  • DeleteDomainNameRequest object

DeleteIntegrationRequest

  • DeleteIntegrationRequest object

DeleteIntegrationResponseRequest

  • DeleteIntegrationResponseRequest object

DeleteModelRequest

  • DeleteModelRequest object

DeleteRouteRequest

  • DeleteRouteRequest object

DeleteRouteRequestParameterRequest

  • DeleteRouteRequestParameterRequest object

DeleteRouteResponseRequest

  • DeleteRouteResponseRequest object

DeleteRouteSettingsRequest

  • DeleteRouteSettingsRequest object

DeleteStageRequest

  • DeleteStageRequest object

DeleteVpcLinkRequest

  • DeleteVpcLinkRequest object

DeleteVpcLinkResponse

  • DeleteVpcLinkResponse object

Deployment

  • Deployment object: An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
    • AutoDeployed
    • CreatedDate
    • DeploymentId
    • DeploymentStatus
    • DeploymentStatusMessage
    • Description

DeploymentStatus

  • DeploymentStatus string (values: PENDING, FAILED, DEPLOYED): Represents a deployment status.

DomainName

  • DomainName object: Represents a domain name.
    • ApiMappingSelectionExpression
    • DomainName required
    • DomainNameConfigurations
    • MutualTlsAuthentication
      • TruststoreUri
      • TruststoreVersion
      • TruststoreWarnings
    • Tags

DomainNameConfiguration

  • DomainNameConfiguration object: The domain name configuration.
    • ApiGatewayDomainName
    • CertificateArn
    • CertificateName
    • CertificateUploadDate
    • DomainNameStatus
    • DomainNameStatusMessage
    • EndpointType
    • HostedZoneId
    • SecurityPolicy

DomainNameConfigurations

DomainNameStatus

  • DomainNameStatus string (values: AVAILABLE, UPDATING): The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

EndpointType

  • EndpointType string (values: REGIONAL, EDGE): Represe
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago