update_authorizer

update_authorizer(**kwargs)

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

See also: AWS API Documentation

Request Syntax

response = client.update_authorizer(
    authorizerName='string',
    authorizerFunctionArn='string',
    tokenKeyName='string',
    tokenSigningPublicKeys={
        'string': 'string'
    },
    status='ACTIVE'|'INACTIVE',
    enableCachingForHttp=True|False
)
Parameters
  • authorizerName (string) --

    [REQUIRED]

    The authorizer name.

  • authorizerFunctionArn (string) -- The ARN of the authorizer's Lambda function.
  • tokenKeyName (string) -- The key used to extract the token from the HTTP headers.
  • tokenSigningPublicKeys (dict) --

    The public keys used to verify the token signature.

    • (string) --
      • (string) --
  • status (string) -- The status of the update authorizer request.
  • enableCachingForHttp (boolean) -- When true , the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds . The cached result is used while the device reuses the same HTTP connection.
Return type

dict

Returns

Response Syntax

{
    'authorizerName': 'string',
    'authorizerArn': 'string'
}

Response Structure

  • (dict) --

    • authorizerName (string) --

      The authorizer name.

    • authorizerArn (string) --

      The authorizer ARN.

Exceptions

  • IoT.Client.exceptions.ResourceNotFoundException
  • IoT.Client.exceptions.InvalidRequestException
  • IoT.Client.exceptions.LimitExceededException
  • IoT.Client.exceptions.ThrottlingException
  • IoT.Client.exceptions.UnauthorizedException
  • IoT.Client.exceptions.ServiceUnavailableException
  • IoT.Client.exceptions.InternalFailureException