Menu
AWS IoT
API Reference

CreateRoleAlias

Creates a role alias.

Request Syntax

POST /role-aliases/roleAlias HTTP/1.1 Content-type: application/json { "credentialDurationSeconds": number, "roleArn": "string" }

URI Request Parameters

The request requires the following URI parameters.

roleAlias

The role alias that points to a role ARN. This allows you to change the role without having to update the device.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w=,@-]+

Request Body

The request accepts the following data in JSON format.

credentialDurationSeconds

How long (in seconds) the credentials will be valid.

Type: Integer

Valid Range: Minimum value of 900. Maximum value of 3600.

Required: No

roleArn

The role ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "roleAlias": "string", "roleAliasArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

roleAlias

The role alias.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w=,@-]+

roleAliasArn

The role alias ARN.

Type: String

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The number of attached entities exceeds the limit.

HTTP Status Code: 410

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: