CreateRoleAliasCommand

Suggest an Edit

Creates a role alias.

Requires permission to access the CreateRoleAlias  action.

The value of credentialDurationSeconds   must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API)  from the Amazon Web Services Identity and Access Management User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, CreateRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, CreateRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // CreateRoleAliasRequest
  roleAlias: "STRING_VALUE", // required
  roleArn: "STRING_VALUE", // required
  credentialDurationSeconds: Number("int"),
  tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateRoleAliasCommand(input);
const response = await client.send(command);
// { // CreateRoleAliasResponse
//   roleAlias: "STRING_VALUE",
//   roleAliasArn: "STRING_VALUE",
// };

CreateRoleAliasCommand Input

See CreateRoleAliasCommandInput for more details

Parameter
Type
Description
roleAlias
Required
string | undefined

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

roleArn
Required
string | undefined

The role ARN.

credentialDurationSeconds
number | undefined

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.

tags
Tag[] | undefined

Metadata which can be used to manage the role alias.

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..."

CreateRoleAliasCommand Output

See CreateRoleAliasCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
roleAlias
string | undefined

The role alias.

roleAliasArn
string | undefined

The role alias ARN.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

LimitExceededException
client

A limit has been exceeded.

ResourceAlreadyExistsException
client

The resource already exists.

ServiceUnavailableException
server

The service is temporarily unavailable.

ThrottlingException
client

The rate exceeds the limit.

UnauthorizedException
client

You are not authorized to perform this operation.

IoTServiceException
Base exception class for all service exceptions from IoT service.