[ 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>]
[--enable-caching-for-http | --no-enable-caching-for-http]
[--cli-input-json | --cli-input-yaml]
[--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

--enable-caching-for-http | --no-enable-caching-for-http (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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.