IoT / Client / update_role_alias

update_role_alias#

IoT.Client.update_role_alias(**kwargs)#

Updates a role alias.

Requires permission to access the UpdateRoleAlias action.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.update_role_alias(
    roleAlias='string',
    roleArn='string',
    credentialDurationSeconds=123
)
Parameters:

  • roleAlias (string) –

    [REQUIRED]

    The role alias to update.

  • roleArn (string) – The role ARN.

  • credentialDurationSeconds (integer) –

    The number of seconds the credential will be valid.

    This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

Return type:

dict

Returns:

Response Syntax

{
    'roleAlias': 'string',
    'roleAliasArn': 'string'
}

Response Structure

  • (dict) –

    • roleAlias (string) –

      The role alias.

    • roleAliasArn (string) –

      The role alias ARN.

Exceptions