IoT / Client / update_command

update_command#

IoT.Client.update_command(**kwargs)#

Update information about a command or mark a command for deprecation.

See also: AWS API Documentation

Request Syntax

response = client.update_command(
    commandId='string',
    displayName='string',
    description='string',
    deprecated=True|False
)
Parameters:

  • commandId (string) –

    [REQUIRED]

    The unique identifier of the command to be updated.

  • displayName (string) – The new user-friendly name to use in the console for the command.

  • description (string) – A short text description of the command.

  • deprecated (boolean) – A boolean that you can use to specify whether to deprecate a command.

Return type:

dict

Returns:

Response Syntax

{
    'commandId': 'string',
    'displayName': 'string',
    'description': 'string',
    'deprecated': True|False,
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • commandId (string) –

      The unique identifier of the command.

    • displayName (string) –

      The updated user-friendly display name in the console for the command.

    • description (string) –

      The updated text description of the command.

    • deprecated (boolean) –

      The boolean that indicates whether the command was deprecated.

    • lastUpdatedAt (datetime) –

      The date and time (epoch timestamp in seconds) when the command was last updated.

Exceptions

  • IoT.Client.exceptions.ValidationException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.ConflictException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalServerException