Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

update-authorizer

Description

Updates an authorizer.

Requires permission to access the UpdateAuthorizer action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-authorizer
--authorizer-name <value>
[--authorizer-function-arn <value>]
[--token-key-name <value>]
[--token-signing-public-keys <value>]
[--status <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--authorizer-name (string)

The authorizer name.

--authorizer-function-arn (string)

The ARN of the authorizer's Lambda function.

--token-key-name (string)

The key used to extract the token from the HTTP headers.

--token-signing-public-keys (map)

The public keys used to verify the token signature.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--status (string)

The status of the update authorizer request.

Possible values:

• ACTIVE
• INACTIVE

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update a custom authorizer

The following update-authorizer example he state of CustomAuthorizer2 to INACTIVE.

aws iot update-authorizer \
    --authorizer-name CustomAuthorizer2 \
    --status INACTIVE

Output:

{
    "authorizerName": "CustomAuthorizer2",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2"
}

For more information, see UpdateAuthorizer in the AWS IoT API Reference.

Output

authorizerName -> (string)

The authorizer name.

authorizerArn -> (string)

The authorizer ARN.