Menu
AWS IoT
Developer Guide

DescribeRoleAlias

Describes a role alias.

Request syntax:

GET /role-aliases/roleAlias

URI Request Parameters:

Name

Type

Req?

Description

roleAlias

RoleAlias

yes

The role alias to describe.

Response syntax:

Content-type: application/json { "roleAliasDescription": { "roleAlias": "string", "roleArn": "string", "owner": "string", "credentialDurationSeconds": "integer", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

Response Body Parameters:

Name

Type

Req?

Description

roleAliasDescription

RoleAliasDescription

no

The role alias description.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

CLI

Synopsis:

aws iot describe-role-alias \ --role-alias <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "roleAlias": "string" }

cli-input-json fields:

Name

Type

Description

roleAlias

string

length max:128 min:1

pattern: [w=,@-]+

The role alias to describe.

Output:

{ "roleAliasDescription": { "roleAlias": "string", "roleArn": "string", "owner": "string", "credentialDurationSeconds": "integer", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

cli output fields:

Name

Type

Description

roleAliasDescription

RoleAliasDescription

The role alias description.

roleAlias

string

length max:128 min:1

pattern: [w=,@-]+

The role alias.

roleArn

string

length max:2048 min:20

The role ARN.

owner

string

pattern: [0-9]{12}

The role alias owner.

credentialDurationSeconds

integer

java class: java.lang.Integer

range- max:3600 min:900

The number of seconds for which the credential is valid.

creationDate

timestamp

The UNIX timestamp of when the role alias was created.

lastModifiedDate

timestamp

The UNIX timestamp of when the role alias was last modified.

On this page: