/role-aliases/{roleAlias}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/role-aliases/'

Response Example

200 - Example 1

{
    "roleAliasDescription": {
        "roleAlias": "string",
        "roleAliasArn": "string",
        "roleArn": "string",
        "owner": "string",
        "credentialDurationSeconds": 0,
        "creationDate": "string",
        "lastModifiedDate": "string"
    }
}

Request

Path Params

roleAlias

string

required

The role alias to describe.

Responses

🟢200Success

application/json

Body

roleAliasDescription

object

optional

The role alias description.

roleAlias

string

optional

The role alias.

>= 1 characters<= 128 characters

Match pattern:

[\w=,@-]+

roleAliasArn

string

optional

The ARN of the role alias.

>= 1 characters<= 2048 characters

roleArn

string

optional

The role ARN.

>= 20 characters<= 2048 characters

owner

string

optional

The role alias owner.

>= 12 characters<= 12 characters

Match pattern:

[0-9]+

credentialDurationSeconds

integer

optional

The number of seconds for which the credential is valid.

>= 900<= 43200

creationDate

string <date-time>

optional

The UNIX timestamp of when the role alias was created.

lastModifiedDate

string <date-time>

optional

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

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

Modified at 2022-09-10 23:12:14

/role-aliases/{roleAlias}