ApiGatewayV2 / Client / create_route

create_route

ApiGatewayV2.Client.create_route(**kwargs)

Creates a Route for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_route(
    ApiId='string',
    ApiKeyRequired=True|False,
    AuthorizationScopes=[
        'string',
    ],
    AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
    AuthorizerId='string',
    ModelSelectionExpression='string',
    OperationName='string',
    RequestModels={
        'string': 'string'
    },
    RequestParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteKey='string',
    RouteResponseSelectionExpression='string',
    Target='string'
)

Parameters:

• ApiId (string) –

  [REQUIRED]

  The API identifier.

• ApiKeyRequired (boolean) – Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

• AuthorizationScopes (list) –

  The authorization scopes supported by this route.

  • (string) –

    A string with a length between [1-64].

• AuthorizationType (string) – The authorization type for the route. 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 of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

• ModelSelectionExpression (string) – The model selection expression for the route. Supported only for WebSocket APIs.

• OperationName (string) – The operation name for the route.

• RequestModels (dict) –

  The request models for the route. Supported only for WebSocket APIs.

  • (string) –

    • (string) –

      A string with a length between [1-128].

• RequestParameters (dict) –

  The request parameters for the route. Supported only for WebSocket APIs.

  • (string) –

    • (dict) –

      Validation constraints imposed on parameters of a request (path, query string, headers).

      • Required (boolean) –

        Whether or not the parameter is required.

• RouteKey (string) –

  [REQUIRED]

  The route key for the route.

• RouteResponseSelectionExpression (string) – The route response selection expression for the route. Supported only for WebSocket APIs.

• Target (string) – The target for the route.

Return type:

dict

Returns:

Response Syntax

{
    'ApiGatewayManaged': True|False,
    'ApiKeyRequired': True|False,
    'AuthorizationScopes': [
        'string',
    ],
    'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
    'AuthorizerId': 'string',
    'ModelSelectionExpression': 'string',
    'OperationName': 'string',
    'RequestModels': {
        'string': 'string'
    },
    'RequestParameters': {
        'string': {
            'Required': True|False
        }
    },
    'RouteId': 'string',
    'RouteKey': 'string',
    'RouteResponseSelectionExpression': 'string',
    'Target': 'string'
}

Response Structure

• (dict) –

  The request has succeeded and has resulted in the creation of a resource.

  • ApiGatewayManaged (boolean) –

    Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.

  • ApiKeyRequired (boolean) –

    Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

  • AuthorizationScopes (list) –

    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.

    • (string) –

      A string with a length between [1-64].

  • AuthorizationType (string) –

    The authorization type for the route. 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 of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

  • ModelSelectionExpression (string) –

    The model selection expression for the route. Supported only for WebSocket APIs.

  • OperationName (string) –

    The operation name for the route.

  • RequestModels (dict) –

    The request models for the route. Supported only for WebSocket APIs.

    • (string) –

      • (string) –

        A string with a length between [1-128].

  • RequestParameters (dict) –

    The request parameters for the route. Supported only for WebSocket APIs.

    • (string) –

      • (dict) –

        Validation constraints imposed on parameters of a request (path, query string, headers).

        • Required (boolean) –

          Whether or not the parameter is required.

  • RouteId (string) –

    The route ID.

  • RouteKey (string) –

    The route key for the route.

  • RouteResponseSelectionExpression (string) –

    The route response selection expression for the route. Supported only for WebSocket APIs.

  • Target (string) –

    The target for the route.

Exceptions

• ApiGatewayV2.Client.exceptions.NotFoundException

• ApiGatewayV2.Client.exceptions.TooManyRequestsException

• ApiGatewayV2.Client.exceptions.BadRequestException

• ApiGatewayV2.Client.exceptions.ConflictException