AmazonApiGatewayV2

2020/09/08 - AmazonApiGatewayV2 - 1 new4 updated api methods

Changes  Update apigatewayv2 client to latest version

ResetAuthorizersCache (new) Link ¶

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

See also: AWS API Documentation

Request Syntax

client.reset_authorizers_cache(
    ApiId='string',
    StageName='string'
)
type ApiId:

string

param ApiId:

[REQUIRED]

The API identifier.

type StageName:

string

param StageName:

[REQUIRED]

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

returns:

None

CreateAuthorizer (updated) Link ¶
Changes (both) 
{'AuthorizerPayloadFormatVersion': 'string', 'EnableSimpleResponses': 'boolean'}

Creates an Authorizer for an API.

See also: AWS API Documentation

Request Syntax

client.create_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerPayloadFormatVersion='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST'|'JWT',
    AuthorizerUri='string',
    EnableSimpleResponses=True|False,
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    JwtConfiguration={
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    Name='string'
)
type ApiId:

string

param ApiId:

[REQUIRED]

The API identifier.

type AuthorizerCredentialsArn:

string

param AuthorizerCredentialsArn:

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

type AuthorizerPayloadFormatVersion:

string

param AuthorizerPayloadFormatVersion:

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

type AuthorizerResultTtlInSeconds:

integer

param AuthorizerResultTtlInSeconds:

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

type AuthorizerType:

string

param AuthorizerType:

[REQUIRED]

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).

type AuthorizerUri:

string

param AuthorizerUri:
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

type EnableSimpleResponses:

boolean

param EnableSimpleResponses:

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

type IdentitySource:

list

param IdentitySource:

[REQUIRED]

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

  • (string) --

type IdentityValidationExpression:

string

param IdentityValidationExpression:

This parameter is not used.

type JwtConfiguration:

dict

param JwtConfiguration:

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • Audience (list) --

    A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

    • (string) --

  • Issuer (string) --

    The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

    . Required for the JWT authorizer type. Supported only for HTTP APIs.

type Name:

string

param Name:

[REQUIRED]

The name of the authorizer.

rtype:

dict

returns:

Response Syntax

{
    'AuthorizerCredentialsArn': 'string',
    'AuthorizerId': 'string',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

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

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      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) --

      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

      , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. 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 (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      • (string) --

    • IdentityValidationExpression (string) --

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

        • (string) --

      • Issuer (string) --

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

        . Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.

GetAuthorizer (updated) Link ¶
Changes (response) 
{'AuthorizerPayloadFormatVersion': 'string', 'EnableSimpleResponses': 'boolean'}

Gets an Authorizer.

See also: AWS API Documentation

Request Syntax

client.get_authorizer(
    ApiId='string',
    AuthorizerId='string'
)
type ApiId:

string

param ApiId:

[REQUIRED]

The API identifier.

type AuthorizerId:

string

param AuthorizerId:

[REQUIRED]

The authorizer identifier.

rtype:

dict

returns:

Response Syntax

{
    'AuthorizerCredentialsArn': 'string',
    'AuthorizerId': 'string',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

    Success

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      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) --

      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

      , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. 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 (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      • (string) --

    • IdentityValidationExpression (string) --

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

        • (string) --

      • Issuer (string) --

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

        . Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.

GetAuthorizers (updated) Link ¶
Changes (response) 
{'Items': {'AuthorizerPayloadFormatVersion': 'string',
           'EnableSimpleResponses': 'boolean'}}

Gets the Authorizers for an API.

See also: AWS API Documentation

Request Syntax

client.get_authorizers(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
type ApiId:

string

param ApiId:

[REQUIRED]

The API identifier.

type MaxResults:

string

param MaxResults:

The maximum number of elements to be returned for this resource.

type NextToken:

string

param NextToken:

The next page of elements from this collection. Not valid for the last element of the collection.

rtype:

dict

returns:

Response Syntax

{
    'Items': [
        {
            'AuthorizerCredentialsArn': 'string',
            'AuthorizerId': 'string',
            'AuthorizerPayloadFormatVersion': 'string',
            'AuthorizerResultTtlInSeconds': 123,
            'AuthorizerType': 'REQUEST'|'JWT',
            'AuthorizerUri': 'string',
            'EnableSimpleResponses': True|False,
            'IdentitySource': [
                'string',
            ],
            'IdentityValidationExpression': 'string',
            'JwtConfiguration': {
                'Audience': [
                    'string',
                ],
                'Issuer': 'string'
            },
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an authorizer.

        • AuthorizerCredentialsArn (string) --

          Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

        • AuthorizerId (string) --

          The authorizer identifier.

        • AuthorizerPayloadFormatVersion (string) --

          Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

        • AuthorizerResultTtlInSeconds (integer) --

          The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

        • AuthorizerType (string) --

          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) --

          The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

          , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

        • EnableSimpleResponses (boolean) --

          Specifies whether a Lambda authorizer returns a response in a simple format. 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 (list) --

          The identity source for which authorization is requested.

          For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

          For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

          • (string) --

        • IdentityValidationExpression (string) --

          The validation expression does not apply to the REQUEST authorizer.

        • JwtConfiguration (dict) --

          Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

          • Audience (list) --

            A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

            • (string) --

          • Issuer (string) --

            The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

            . Required for the JWT authorizer type. Supported only for HTTP APIs.

        • Name (string) --

          The name of the authorizer.

    • NextToken (string) --

      The next page of elements from this collection. Not valid for the last element of the collection.

UpdateAuthorizer (updated) Link ¶
Changes (both) 
{'AuthorizerPayloadFormatVersion': 'string', 'EnableSimpleResponses': 'boolean'}

Updates an Authorizer.

See also: AWS API Documentation

Request Syntax

client.update_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerId='string',
    AuthorizerPayloadFormatVersion='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST'|'JWT',
    AuthorizerUri='string',
    EnableSimpleResponses=True|False,
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    JwtConfiguration={
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    Name='string'
)
type ApiId:

string

param ApiId:

[REQUIRED]

The API identifier.

type AuthorizerCredentialsArn:

string

param AuthorizerCredentialsArn:

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.

type AuthorizerId:

string

param AuthorizerId:

[REQUIRED]

The authorizer identifier.

type AuthorizerPayloadFormatVersion:

string

param AuthorizerPayloadFormatVersion:

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

type AuthorizerResultTtlInSeconds:

integer

param AuthorizerResultTtlInSeconds:

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

type AuthorizerType:

string

param AuthorizerType:

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).

type AuthorizerUri:

string

param AuthorizerUri:
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

type EnableSimpleResponses:

boolean

param EnableSimpleResponses:

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

type IdentitySource:

list

param IdentitySource:

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

  • (string) --

type IdentityValidationExpression:

string

param IdentityValidationExpression:

This parameter is not used.

type JwtConfiguration:

dict

param JwtConfiguration:

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • Audience (list) --

    A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

    • (string) --

  • Issuer (string) --

    The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

    . Required for the JWT authorizer type. Supported only for HTTP APIs.

type Name:

string

param Name:

The name of the authorizer.

rtype:

dict

returns:

Response Syntax

{
    'AuthorizerCredentialsArn': 'string',
    'AuthorizerId': 'string',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

    Success

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      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) --

      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}

      , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. 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 (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

      • (string) --

    • IdentityValidationExpression (string) --

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

        • (string) --

      • Issuer (string) --

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}

        . Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.