CreateRoleAlias
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
Important
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 (AWS API) from the AWS Identity and Access Management User Guide.
Request Syntax
POST /role-aliases/roleAlias HTTP/1.1
Content-type: application/json
{
"credentialDurationSeconds": number,
"roleArn": "string",
"tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request uses 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=,@-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- credentialDurationSeconds
-
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.
Type: Integer
Valid Range: Minimum value of 900. Maximum value of 43200.
Required: No
- roleArn
-
The role ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
-
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..."
Type: Array of Tag objects
Required: No
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
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit has been exceeded.
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: 400
- 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:
