POST

/role-aliases/{roleAlias}

http://iot.{region}.amazonaws.com/role-aliases/{roleAlias}

Creates a role alias. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateRoleAlias</a> action.

Access Token Required: API Key

Path Parameters

roleAliasstringrequired

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

Body Params

tagsarray

Metadata which can be used to manage the role alias. <note> For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." </note>

roleArnstringrequired

The role ARN.

credentialDurationSecondsinteger

How long (in seconds) the credentials will be valid. The default value is 3,600 seconds. This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iot.{region}.amazonaws.com/role-aliases/{roleAlias}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}