describe_role_alias

IoT.Client.describe_role_alias(**kwargs)

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

See also: AWS API Documentation

Request Syntax

response = client.describe_role_alias(
    roleAlias='string'
)

Parameters

roleAlias (string) --

[REQUIRED]

The role alias to describe.

Return type

dict

Returns

Response Syntax

{
    'roleAliasDescription': {
        'roleAlias': 'string',
        'roleAliasArn': 'string',
        'roleArn': 'string',
        'owner': 'string',
        'credentialDurationSeconds': 123,
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --
  • roleAliasDescription (dict) --

    The role alias description.

    • roleAlias (string) --

      The role alias.

    • roleAliasArn (string) --

      The ARN of the role alias.

    • roleArn (string) --

      The role ARN.

    • owner (string) --

      The role alias owner.

    • credentialDurationSeconds (integer) --

      The number of seconds for which the credential is valid.

    • creationDate (datetime) --

      The UNIX timestamp of when the role alias was created.

    • lastModifiedDate (datetime) --

      The UNIX timestamp of when the role alias was last modified.

Exceptions

• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.ResourceNotFoundException