IoT / Client / create_dynamic_thing_group

create_dynamic_thing_group#

IoT.Client.create_dynamic_thing_group(**kwargs)#

Creates a dynamic thing group.

Requires permission to access the CreateDynamicThingGroup action.

See also: AWS API Documentation

Request Syntax

response = client.create_dynamic_thing_group(
    thingGroupName='string',
    thingGroupProperties={
        'thingGroupDescription': 'string',
        'attributePayload': {
            'attributes': {
                'string': 'string'
            },
            'merge': True|False
        }
    },
    indexName='string',
    queryString='string',
    queryVersion='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • thingGroupName (string) –

    [REQUIRED]

    The dynamic thing group name to create.

  • thingGroupProperties (dict) –

    The dynamic thing group properties.

    • thingGroupDescription (string) –

      The thing group description.

    • attributePayload (dict) –

      The thing group attributes in JSON format.

      • attributes (dict) –

        A JSON string containing up to three key-value pair in JSON format. For example:

        {\"attributes\":{\"string1\":\"string2\"}}

        • (string) –

          • (string) –

      • merge (boolean) –

        Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

        To remove an attribute, call UpdateThing with an empty attribute value.

        Note

        The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

  • indexName (string) –

    The dynamic thing group index name.

    Note

    Currently one index is supported: AWS_Things.

  • queryString (string) –

    [REQUIRED]

    The dynamic thing group search query string.

    See Query Syntax for information about query string syntax.

  • queryVersion (string) –

    The dynamic thing group query version.

    Note

    Currently one query version is supported: “2017-09-30”. If not specified, the query version defaults to this value.

  • tags (list) –

    Metadata which can be used to manage the dynamic thing group.

    • (dict) –

      A set of key/value pairs that are used to manage the resource.

      • Key (string) – [REQUIRED]

        The tag’s key.

      • Value (string) –

        The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'thingGroupName': 'string',
    'thingGroupArn': 'string',
    'thingGroupId': 'string',
    'indexName': 'string',
    'queryString': 'string',
    'queryVersion': 'string'
}

Response Structure

  • (dict) –

    • thingGroupName (string) –

      The dynamic thing group name.

    • thingGroupArn (string) –

      The dynamic thing group ARN.

    • thingGroupId (string) –

      The dynamic thing group ID.

    • indexName (string) –

      The dynamic thing group index name.

    • queryString (string) –

      The dynamic thing group search query string.

    • queryVersion (string) –

      The dynamic thing group query version.

Exceptions