The Role Aliases API from Amazon IoT Core — 2 operation(s) for role aliases.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-iot-core-role-aliases-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT Role Aliases API
description: 'IoT
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Role Aliases
paths:
/role-aliases/{roleAlias}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateRoleAlias
description: 'Creates a role alias.
Requires permission to access the CreateRoleAlias action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRoleAliasResponse'
'480':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'486':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: roleAlias
in: path
required: true
description: The role alias that points to a role ARN. This allows you to change the role without having to update the device.
schema:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- roleArn
properties:
roleArn:
description: The role ARN.
type: string
minLength: 20
maxLength: 2048
credentialDurationSeconds:
description: <p>How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.</p> <p>This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.</p>
type: integer
minimum: 900
maximum: 43200
tags:
description: '<p>Metadata which can be used to manage the role alias.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>'
type: array
items:
$ref: '#/components/schemas/Tag'
summary: Amazon IoT Core Create Role Alias
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Role Aliases
delete:
operationId: DeleteRoleAlias
description: 'Deletes a role alias
Requires permission to access the DeleteRoleAlias action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRoleAliasResponse'
'480':
description: DeleteConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConflictException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'485':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'486':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: roleAlias
in: path
required: true
description: The role alias to delete.
schema:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
summary: Amazon IoT Core Delete Role Alias
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Role Aliases
get:
operationId: DescribeRoleAlias
description: 'Describes a role alias.
Requires permission to access the DescribeRoleAlias action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRoleAliasResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: roleAlias
in: path
required: true
description: The role alias to describe.
schema:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
summary: Amazon IoT Core Describe Role Alias
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Role Aliases
put:
operationId: UpdateRoleAlias
description: 'Updates a role alias.
Requires permission to access the UpdateRoleAlias action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRoleAliasResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'485':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: roleAlias
in: path
required: true
description: The role alias to update.
schema:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
roleArn:
description: The role ARN.
type: string
minLength: 20
maxLength: 2048
credentialDurationSeconds:
description: <p>The number of seconds the credential will be valid.</p> <p>This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.</p>
type: integer
minimum: 900
maximum: 43200
summary: Amazon IoT Core Update Role Alias
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Role Aliases
/role-aliases:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListRoleAliases
description: 'Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListRoleAliasesResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: pageSize
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
- name: marker
in: query
required: false
description: A marker used to get the next set of results.
schema:
type: string
pattern: '[A-Za-z0-9+/]+={0,2}'
maxLength: 1024
- name: isAscendingOrder
in: query
required: false
description: Return the list of role aliases in ascending alphabetical order.
schema:
type: boolean
summary: Amazon IoT Core List Role Aliases
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Role Aliases
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
schemas:
RoleAliases:
type: array
items:
$ref: '#/components/schemas/RoleAlias'
ServiceUnavailableException: {}
UpdateRoleAliasResponse:
type: object
properties:
roleAlias:
allOf:
- $ref: '#/components/schemas/RoleAlias'
- description: The role alias.
roleAliasArn:
allOf:
- $ref: '#/components/schemas/RoleAliasArn'
- description: The role alias ARN.
ResourceNotFoundException: {}
InternalFailureException: {}
DescribeRoleAliasResponse:
type: object
properties:
roleAliasDescription:
allOf:
- $ref: '#/components/schemas/RoleAliasDescription'
- description: The role alias description.
RoleAlias:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
ResourceAlreadyExistsException: {}
UnauthorizedException: {}
RoleAliasDescription:
type: object
properties:
roleAlias:
allOf:
- $ref: '#/components/schemas/RoleAlias'
- description: The role alias.
roleAliasArn:
allOf:
- $ref: '#/components/schemas/RoleAliasArn'
- description: The ARN of the role alias.
roleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The role ARN.
owner:
allOf:
- $ref: '#/components/schemas/AwsAccountId'
- description: The role alias owner.
credentialDurationSeconds:
allOf:
- $ref: '#/components/schemas/CredentialDurationSeconds'
- description: The number of seconds for which the credential is valid.
creationDate:
allOf:
- $ref: '#/components/schemas/DateType'
- description: The UNIX timestamp of when the role alias was created.
lastModifiedDate:
allOf:
- $ref: '#/components/schemas/DateType'
- description: The UNIX timestamp of when the role alias was last modified.
description: Role alias description.
DeleteConflictException: {}
RoleArn:
type: string
minLength: 20
maxLength: 2048
ThrottlingException: {}
InvalidRequestException: {}
CredentialDurationSeconds:
type: integer
minimum: 900
maximum: 43200
ListRoleAliasesResponse:
type: object
properties:
roleAliases:
allOf:
- $ref: '#/components/schemas/RoleAliases'
- description: The role aliases.
nextMarker:
allOf:
- $ref: '#/components/schemas/Marker'
- description: A marker used to get the next set of results.
Tag:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag's key.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag's value.
description: A set of key/value pairs that are used to manage the resource.
CreateRoleAliasResponse:
type: object
properties:
roleAlias:
allOf:
- $ref: '#/components/schemas/RoleAlias'
- description: The role alias.
roleAliasArn:
allOf:
- $ref: '#/components/schemas/RoleAliasArn'
- description: The role alias ARN.
Marker:
type: string
pattern: '[A-Za-z0-9+/]+={0,2}'
maxLength: 1024
TagKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
DateType:
type: string
format: date-time
TagValue:
type: string
minLength: 0
maxLength: 256
LimitExceededException: {}
RoleAliasArn:
type: string
minLength: 1
maxLength: 2048
AwsAccountId:
type: string
pattern: '[0-9]+'
minLength: 12
maxLength: 12
DeleteRoleAliasResponse:
type: object
properties: {}
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/iot/
x-hasEquivalentPaths: true