Menu
AWS IoT
Developer Guide

ListRoleAliases

Lists the role aliases registered in your account.

Request syntax:

GET /role-aliases?pageSize=pageSize&marker=marker&isAscendingOrder=ascendingOrder

URI Request Parameters:

Name

Type

Req?

Description

pageSize

PageSize

no

The maximum number of results to return at one time.

marker

Marker

no

A marker used to get the next set of results.

ascendingOrder

AscendingOrder

no

Return the list of role aliases in ascending alphabetical order.

Response syntax:

Content-type: application/json { "roleAliases": [ "string" ], "nextMarker": "string" }

Response Body Parameters:

Name

Type

Req?

Description

roleAliases

RoleAliases

no

The role aliases.

nextMarker

Marker

no

A marker used to get the next set of results.

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

CLI

Synopsis:

aws iot list-role-aliases \ [--page-size <value>] \ [--marker <value>] \ [--ascending-order | --no-ascending-order] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "pageSize": "integer", "marker": "string", "ascendingOrder": "boolean" }

cli-input-json fields:

Name

Type

Description

pageSize

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to return at one time.

marker

string

pattern: [A-Za-z0-9+/]+={0,2}

A marker used to get the next set of results.

ascendingOrder

boolean

Return the list of role aliases in ascending alphabetical order.

Output:

{ "roleAliases": [ "string" ], "nextMarker": "string" }

cli output fields:

Name

Type

Description

roleAliases

list

member: RoleAlias

java class: java.util.List

The role aliases.

RoleAlias

string

length max:128 min:1

pattern: [w=,@-]+

nextMarker

string

pattern: [A-Za-z0-9+/]+={0,2}

A marker used to get the next set of results.

On this page: