AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

DescribeAuthorizer

描述授权方。

https

请求语法:

GET /authorizer/authorizerName

URI 请求参数:

名称

类型

请求?

描述

authorizerName

AuthorizerName

要描述的授权方的名称。

响应语法:

Content-type: application/json { "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

响应正文参数:

名称

类型

请求?

描述

authorizerDescription

AuthorizerDescription

授权方的描述。

错误:

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

cli

摘要:

aws iot describe-authorizer \ --authorizer-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "authorizerName": "string" }

cli-input-json 字段:

名称

类型

描述

authorizerName

字符串

最大长度:128,最小长度:1

模式:[w=,@-]+

要描述的授权方的名称。

输出:

{ "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

cli 输出字段:

名称

类型

描述

authorizerDescription

AuthorizerDescription

授权方的描述。

authorizerName

字符串

最大长度:128,最小长度:1

模式:[w=,@-]+

授权方名称。

authorizerArn

字符串

授权方 ARN。

authorizerFunctionArn

字符串

授权方的 Lambda 函数 ARN。

tokenKeyName

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

用于从 HTTP 标头提取令牌的键。

tokenSigningPublicKeys

map

用于验证由自定义身份验证服务返回的令牌签名的公有密钥。

status

字符串

授权方的状态。

枚举:ACTIVE | INACTIVE

creationDate

timestamp

创建授权方的时间的 UNIX 时间戳。

lastModifiedDate

timestamp

上次更新授权方的时间的 UNIX 时间戳。

错误:

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。