[ aws . iot ]

describe-role-alias

Description

Describes a role alias.

Requires permission to access the DescribeRoleAlias action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-role-alias
--role-alias <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--role-alias (string)

The role alias to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about an AWS IoT role alias

The following describe-role-alias example displays details for the specified role alias.

aws iot describe-role-alias \
    --role-alias LightBulbRole

Output:

{
    "roleAliasDescription": {
        "roleAlias": "LightBulbRole",
        "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole",
        "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001",
        "owner": "123456789012",
        "credentialDurationSeconds": 3600,
        "creationDate": 1570558643.221,
        "lastModifiedDate": 1570558643.221
    }
}

For more information, see DescribeRoleAlias in the AWS IoT API Reference.

Output

roleAliasDescription -> (structure)

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 -> (timestamp)

The UNIX timestamp of when the role alias was created.

lastModifiedDate -> (timestamp)

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