IoT / Client / update_dimension

update_dimension#

IoT.Client.update_dimension(**kwargs)#

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

See also: AWS API Documentation

Request Syntax

response = client.update_dimension(
    name='string',
    stringValues=[
        'string',
    ]
)
Parameters:

  • name (string) –

    [REQUIRED]

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

  • stringValues (list) –

    [REQUIRED]

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, “admin/#”).

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'type': 'TOPIC_FILTER',
    'stringValues': [
        'string',
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • name (string) –

      A unique identifier for the dimension.

    • arn (string) –

      The Amazon Resource Name (ARN)of the created dimension.

    • type (string) –

      The type of the dimension.

    • stringValues (list) –

      The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

      • (string) –

    • creationDate (datetime) –

      The date and time, in milliseconds since epoch, when the dimension was initially created.

    • lastModifiedDate (datetime) –

      The date and time, in milliseconds since epoch, when the dimension was most recently updated.

Exceptions