Aetag

Table of Contents

Client

class Aetag.Client

A client object representing ‘Aetag’ Service:

import almdrlib

client = almdrlib.client('aetag')

Available methods:

create_definition(**kwargs)

Creates a new tagset definition. Definitions must be in place before a tagset can be created using the same path.

Request Syntax

response = client.create_definition(
    $schema='string'
    default={}
    desc='string'
    direction='string'
    display_name='string'
    expiration='string'
    git_revision='string'
    inherit='string'
    name='string'
    path='string'
    type='string'
    unique='False|True'
    validation={}
)
Parameters

  • $schema (string) –

  • default (dict) –

  • desc (string) – [REQUIRED]

  • direction (string) – [REQUIRED]

  • display_name (string) – [REQUIRED]

  • expiration (string) – [REQUIRED]

  • git_revision (string) –

  • inherit (string) – [REQUIRED]

  • name (string) – [REQUIRED]

  • path (string) –

    [REQUIRED]

    tagset object path

  • type (string) – [REQUIRED]

  • unique (boolean) – [REQUIRED]

  • validation (dict) –

Return type

dict

Returns

Response Syntax

{
    'stored': 'string'
}

Response Definitions

  • stored (string) –

create_global_tagset(**kwargs)

Create new or update existing tagset

Request Syntax

response = client.create_global_tagset(
    path='string'
    tagset={}
)
Parameters

  • path (string) –

    [REQUIRED]

    tagset object path

  • tagset (dict) – JSON Object with key/values to set the tag set to.

Return type

dict

Returns

Response Syntax

{
    'stored': 'string'
}

Response Definitions

  • stored (string) –

create_global_tuning_tagset(**kwargs)

Create or update (overwrite) a tuning tagset. A tuning tag set is used by a trigger definition. This endpoint is intended for internal use only.

Request Syntax

response = client.create_global_tuning_tagset(
    path='string'
    tagset={}
)
Parameters

  • path (string) – Trigger Path

  • tagset (dict) –

    [REQUIRED]

    JSON Object with key/values to set the tag set to.

Return type

dict

Returns

Response Syntax

{
    'stored': 'string'
}

Response Definitions

  • stored (string) –

create_tagset(**kwargs)

Create or update (overwrite) a tagset. A tagset is an instance of a previously stored definition.

Request Syntax

response = client.create_tagset(
    account_id='string'
    path='string'
    tagset={}
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • path (string) –

    [REQUIRED]

    Tagset Definition Name/Path

  • tagset (dict) –

    [REQUIRED]

    JSON Object with key/values to set the tag set to.

Return type

dict

Returns

Response Syntax

{
    'stored': 'string'
}

Response Definitions

  • stored (string) –

create_tuning_tagset(**kwargs)

Create or update (overwrite) customer’s tuning tagset. A tuning tagset is used by a trigger definition. This endpoint is intended for internal use only.

Request Syntax

response = client.create_tuning_tagset(
    account_id='string'
    path='string'
    tagset={}
)
Parameters

  • account_id (string) – [REQUIRED]

  • path (string) –

    [REQUIRED]

    Trigger Path

  • tagset (dict) –

    [REQUIRED]

    JSON Object with key/values to set the tag set to.

Return type

dict

Returns

Response Syntax

{
    'stored': 'string'
}

Response Definitions

  • stored (string) –

crud_global_tagset_keys_by_path(**kwargs)

Specific operations to be performed are specified through the call body. This body is of one or more objects executed sequentially. Each objects have at least an “operation” key, which has a value being one of “read”, “write”, “delete”, “add”, or “subtract”:

  • read: returns the tuning tagset key identified in the object’s key “key”

  • write: replaces the tuning tagset key identified in the object’s key “key” with the object’s key “value”; may take an optional “expiration_ts” key

  • delete: removes the tuning tagset key identified in the object’s key “key”

  • add: if the tuning tagset key identified in the object’s key “key” is a list, adds the object’s key “value” provided it is not already in the list; may take an optional “expiration_ts” key

  • subtract: if the tuning tagset key identified in the object’s key “key” is a list, removes all occurrences of the object’s key “value”

Operations are performed in the order they are specified.

Specifying an “expiration_ts” key (where allowed) causes the tagset key to expire at a given time. The value of the key is an integer representing the expiration time as a Unix epoch.

Tags requested for a specific customer id are composed tuning tagset which uses the definition to decide from where, what and how to merge tagsets together. The ‘etag’ header is set and may be used to cache the response by the caller. Global tags are not composed.

Request Syntax

response = client.crud_global_tagset_keys_by_path(
    audit='string'
    crud_list=[
        'dict'
    ]
    path='string'
)
Parameters

  • audit (string) –

    [REQUIRED]

    base64 encoded map of extra audit information

  • crud_list (list) –

    • (dict) –

  • path (string) –

    [REQUIRED]

    url-encoded path

Returns

None

crud_global_tuning_keys_by_path(**kwargs)

Specific operations to be performed are specified through the call body. This body is of one or more objects executed sequentially. Each objects have at least an “operation” key, which has a value being one of “read”, “write”, “delete”, “add”, or “subtract”:

  • read: returns the tuning tagset key identified in the object’s key “key”

  • write: replaces the tuning tagset key identified in the object’s key “key” with the object’s key “value”; may take an optional “expiration_ts” key

  • delete: removes the tuning tagset key identified in the object’s key “key”

  • add: if the tuning tagset key identified in the object’s key “key” is a list, adds the object’s key “value” provided it is not already in the list; may take an optional “expiration_ts” key

  • subtract: if the tuning tagset key identified in the object’s key “key” is a list, removes all occurrences of the object’s key “value”

Operations are performed in the order they are specified.

Specifying an “expiration_ts” key (where allowed) causes the tagset key to expire at a given time. The value of the key is an integer representing the expiration time as a Unix epoch.

Tags requested for a specific customer id are composed tuning tagset which uses the definition to decide from where, what and how to merge tagsets together. The ‘etag’ header is set and may be used to cache the response by the caller. Global tags are not composed.

Request Syntax

response = client.crud_global_tuning_keys_by_path(
    crud_list=[
        'dict'
    ]
    path='string'
)
Parameters

  • crud_list (list) –

    • (dict) –

  • path (string) –

    [REQUIRED]

    url-encoded path

Returns

None

crud_tagset_keys_by_path(**kwargs)

Specific operations to be performed are specified through the call body. This body is of one or more objects executed sequentially. Each objects have at least an “operation” key, which has a value being one of “read”, “write”, “delete”, “add”, or “subtract”:

  • read: returns the tuning tagset key identified in the object’s key “key”

  • write: replaces the tuning tagset key identified in the object’s key “key” with the object’s key “value”; may take an optional “expiration_ts” key

  • delete: removes the tuning tagset key identified in the object’s key “key”

  • add: if the tuning tagset key identified in the object’s key “key” is a list, adds the object’s key “value” provided it is not already in the list; may take an optional “expiration_ts” key and optional “exclude” key.

  • subtract: if the tuning tagset key identified in the object’s key “key” is a list, removes all occurrences of the object’s key “value”

Operations are performed in the order they are specified.

Specifying an “expiration_ts” key (where allowed) causes the tagset key to expire at a given time. The value of the key is an integer representing the expiration time as a Unix epoch.

Specifying an “exclude” key for “add” operation causes the list value is marked to be removed after the tagset composition. The value of the key is an boolean representing if the value should be exclude or not during tagset composition.

Tags requested for a specific customer id are composed tuning tagset which uses the definition to decide from where, what and how to merge tagsets together. The ‘etag’ header is set and may be used to cache the response by the caller. Global tags are not composed.

Request Syntax

response = client.crud_tagset_keys_by_path(
    account_id='string'
    audit='string'
    crud_list=[
        'dict'
    ]
    path='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • audit (string) –

    [REQUIRED]

    optional audit information when updating a tagset

  • crud_list (list) –

    • (dict) –

  • path (string) –

    [REQUIRED]

    url-encoded path

Returns

None

crud_tuning_keys_by_path(**kwargs)

Specific operations to be performed are specified through the call body. This body is of one or more objects executed sequentially. Each objects have at least an “operation” key, which has a value being one of “read”, “write”, “delete”, “add”, or “subtract”:

  • read: returns the tuning tagset key identified in the object’s key “key”

  • write: replaces the tuning tagset key identified in the object’s key “key” with the object’s key “value”; may take an optional “expiration_ts” key

  • delete: removes the tuning tagset key identified in the object’s key “key”

  • add: if the tuning tagset key identified in the object’s key “key” is a list, adds the object’s key “value” provided it is not already in the list; may take an optional “expiration_ts” key and optional “exclude” key.

  • subtract: if the tuning tagset key identified in the object’s key “key” is a list, removes all occurrences of the object’s key “value”

Operations are performed in the order they are specified.

Specifying an “expiration_ts” key (where allowed) causes the tagset key to expire at a given time. The value of the key is an integer representing the expiration time as a Unix epoch. Specifying an “exclude” key for “add” operation causes the list value is marked to be removed after the tagset composition. The value of the key is an boolean representing if the value should be exclude or not during tagset composition. Tags requested for a specific customer id are composed tuning tagset which uses the definition to decide from where, what and how to merge tagsets together. The ‘etag’ header is set and may be used to cache the response by the caller. Global tags are not composed.

Request Syntax

response = client.crud_tuning_keys_by_path(
    account_id='string'
    audit='string'
    crud_list=[
        'dict'
    ]
    path='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • audit (string) –

    [REQUIRED]

    base64 encoded map of extra audit information

  • crud_list (list) –

    • (dict) –

  • path (string) –

    [REQUIRED]

    url-encoded path

Returns

None

delete_definition(**kwargs)

Delete a definition.

Request Syntax

response = client.delete_definition(
    path='string'
)
Parameters

path (string) –

[REQUIRED]

url-encoded path

Return type

dict

Returns

Response Syntax

{
    'deleted': 'string'
}

Response Definitions

  • deleted (string) –

delete_global_tagset(**kwargs)

Delete a global tagset.

Request Syntax

response = client.delete_global_tagset(
    path='string'
)
Parameters

path (string) –

[REQUIRED]

url-encoded path

Return type

dict

Returns

Response Syntax

{
    'deleted': 'string'
}

Response Definitions

  • deleted (string) –

delete_tagset(**kwargs)

Delete a tagset.

Request Syntax

response = client.delete_tagset(
    account_id='string'
    path='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • path (string) –

    [REQUIRED]

    url-encoded path

Return type

dict

Returns

Response Syntax

{
    'deleted': 'string'
}

Response Definitions

  • deleted (string) –

expire_definition(**kwargs)

Set a definition’s expiration timestamp.

Note that setting expiration is effective immediately, just like if it was set up at the definition’s creation time. This means that queries for the definition having an associated timestamp posterior to the expiration time will suddenly not receive the definition. This is by design and is intended as a way to prevent bad definitions from being used by the ae system as soon as possible.

If the content_id being expired is not the first version of the definition that was posted, the definition will NOT revert to its previous content_id; it will simply disappear (it IS expired) until the next version of the definition is posted. If you find yourself in need of expiring a bad content_id and have a good copy of the definition on hand, you can post it as early as possible: expiring an earlier content_id does not affect newer ones. As to what happens to data that would have been processed with an expired definition, depending they are processed before or after the expiration is propagated through the AE system, it will see the expired definition or not.

Note that because expiration done after the fact is done outside of regular content updates and because of caching, it may take a few minutes for the expiration to propagate throughout the AE system.

Request Syntax

response = client.expire_definition(
    data='integer'
    id='string'
)
Parameters

  • data (integer) –

  • id (string) –

    [REQUIRED]

    Definition ID

Return type

dict

Returns

Response Syntax

{
    'updated': 'string'
}

Response Definitions

  • updated (string) –

expire_tagset(**kwargs)

Set a tagset’s expiration timestamp

Request Syntax

response = client.expire_tagset(
    data='integer'
    id='string'
)
Parameters

  • data (integer) –

  • id (string) –

    [REQUIRED]

    Tagset ID

Return type

dict

Returns

Response Syntax

{
    'updated': 'string'
}

Response Definitions

  • updated (string) –

expire_tuning_tagset(**kwargs)

Set a tuning’s expiration timestamp

Request Syntax

response = client.expire_tuning_tagset(
    data='integer'
    id='string'
)
Parameters

  • data (integer) –

  • id (string) –

    [REQUIRED]

    Tuning ID

Return type

dict

Returns

Response Syntax

{
    'updated': 'string'
}

Response Definitions

  • updated (string) –

get_aetag_audit(**kwargs)

Return the set of active content items at the give timestamp (or at current time if no timestamp given). For each item, metadata is provided (about upload user & upload channel; creation, deletion, expiration times; content id, path & type) as well as the content itself. Providing a data_type parameter narrows the audit to the given data type.

Request Syntax

response = client.get_aetag_audit(
    data_type='string'
    ts='string'
)
Parameters

  • data_type (string) –

    Which data type to return in the audit. Choices: ‘definition’, ‘tagset’

    Default: all

  • ts (string) –

    A unix epoch timestamp

    Default: now

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_aetag_audit_by_path(**kwargs)

Return the audit event for tuning a customer specific tagset.

Request Syntax

response = client.get_aetag_audit_by_path(
    account_id='string'
    limit='integer'
    path='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    Account ID to return information for

  • limit (integer) –

    Limit for the number of audit records returned

    Default: 8

  • path (string) –

    [REQUIRED]

    Path to the tagset to return information for

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_definition_by_id(**kwargs)

Return a definition by its specific UUID identifier

Request Syntax

response = client.get_definition_by_id(
    id='string'
)
Parameters

id (string) – [REQUIRED]

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_definition_by_path(**kwargs)

Return a specific definition by its path

Request Syntax

response = client.get_definition_by_path(
    epoch='number'
    path='string'
    ts='string'
)
Parameters

  • epoch (number) – A positive integer representing an epoch

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (string) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_definitions(**kwargs)

Return all definitions

Request Syntax

response = client.get_definitions(
    epoch='integer'
    ts='integer'
)
Parameters

  • epoch (integer) – A positive integer representing an epoch

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_definitions_by_paths(**kwargs)

Return definitions for a specific set of paths. The set of paths to return is specified in the body as a json list of strings. The format of the output is a json object of the requested definition keyed by path. If a path is not found, it is silently not returned. The ‘etag’ header is set and may be used to cache the response by the caller. Definitions are retrieved from storage and not modified in any way.

Request Syntax

response = client.get_definitions_by_paths(
    data=[
        'string'
    ]
    echo='integer'
    ts='integer'
)
Parameters

  • data (list) –

    • (string) –

  • echo (integer) – A positive integer representing an epoch

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_defintion_expiration(**kwargs)

Return a definition’s expiration timestamp

Request Syntax

response = client.get_defintion_expiration(
    id='string'
)
Parameters

id (string) –

[REQUIRED]

Definition ID

Return type

integer

Returns

Response Syntax

'integer'

Response Definitions

get_global_tagset_by_path(**kwargs)

Return a specific tagset. Global tags are not composed.

Request Syntax

response = client.get_global_tagset_by_path(
    path='string'
    ts='integer'
)
Parameters

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_global_tagsets(**kwargs)

Return a list of tags.

When global tags are requested from this endpoint, they are simply retrieved from storage; they are not composed.

Request Syntax

response = client.get_global_tagsets(
    ts='integer'
)
Parameters

ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_global_tagsets_by_paths(**kwargs)

Return tags at the specified list of paths. When global tags are requested, they are simply retrieved from storage; they are not composed. The ‘etag’ header is set and may be used to cache the response by the caller.

Request Syntax

response = client.get_global_tagsets_by_paths(
    data=[
        'string'
    ]
    ts='integer'
)
Parameters

  • data (list) –

    • (string) –

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_global_tuning_tagset_by_path(**kwargs)

Get Global Tuning Tagset by Path

Request Syntax

response = client.get_global_tuning_tagset_by_path(
    path='string'
    ts='integer'
)
Parameters

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_tagset_by_id(**kwargs)

Get tagset by id

Request Syntax

response = client.get_tagset_by_id(
    id='string'
    include_extended='False|True'
)
Parameters

  • id (string) – [REQUIRED]

  • include_extended (boolean) –

Returns

None

get_tagset_by_path(**kwargs)

Return a specific tagset. Tags requested for a specific customer id are composed tagset which uses the definition to decide from where, what and how to merge tagsets together. The ‘etag’ header is set and may be used to cache the response by the caller. Global tags are not composed.

Request Syntax

response = client.get_tagset_by_path(
    account_id='string'
    compose='False|True'
    path='string'
    ts='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • compose (boolean) –

    Determine if the tags are retrieve with composition or not, by default it is true.

    Default: true

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (string) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_tagset_expiration(**kwargs)

Return a tagset’s expiration timestamp

Note that setting expiration is effective immediately, just like if it was set up at the tag’s creation time. This means that queries for the tag having an associated timestamp posterior to the expiration time will suddenly not receive the tag. This is by design and is intended as a way to prevent bad tags from being used by the ae system as soon as possible.

If the content_id being expired is not the first version of the tag that was posted, the tag will NOT revert to its previous content_id; it will simply disappear (it IS expired) until the next version of the tag is posted. If you find yourself in need of expiring a bad content_id and have a good copy of the tag on hand, you can post it as early as possible: expiring an earlier content_id does not affect newer ones. As to what happens to data that would have been tagged by an expired tag, depending they are processed before or after the expiration is propagated through the AE system, it will see the expired tag or not.

Note that because expiration done after the fact is done outside of regular content updates and because of caching, it may take a few minutes for the expiration to propagate throughout the AE system.

Request Syntax

response = client.get_tagset_expiration(
    id='string'
)
Parameters

id (string) –

[REQUIRED]

Tagset ID

Return type

integer

Returns

Response Syntax

'integer'

Response Definitions

get_tagsets(**kwargs)

Return a list of tags. Tags requested for a specific customer id are composed, including all relevant tuning, global, and/or parent tag sets. The precise “recipe” of composition is determined by a given tag set’s definition.

Request Syntax

response = client.get_tagsets(
    account_id='string'
    compose='False|True'
    ts='integer'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • compose (boolean) –

    Determine if the tags are retrieve with composition or not, by default it is true.

    Default: true

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_tagsets_by_paths(**kwargs)

Return tags at the specified list of paths. Tags requested for a specific customer id are composed, including all relevant tuning, global, and/or parent tag sets. The precise “recipe” of composition is determined by a given tag set’s definition.

Request Syntax

response = client.get_tagsets_by_paths(
    account_id='string'
    data=[
        'string'
    ]
    ts='integer'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • data (list) –

    • (string) –

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_tuning_for_account_id(**kwargs)

Returns tunings tagsets for a given account_id, including the keys in the tagset contain a value for the user.

Request Syntax

response = client.get_tuning_for_account_id(
    account_id='string'
    return_values='False|True'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • return_values (boolean) –

    [REQUIRED]

    Returns tagset values

Returns

None

get_tuning_for_account_ids(**kwargs)

Returns paths for tuned tagsets for all users

Request Syntax

response = client.get_tuning_for_account_ids(
    return_values='False|True'
)
Parameters

return_values (boolean) –

[REQUIRED]

Returns tagset values

Returns

None

get_tuning_for_analytic(**kwargs)

Returns all the users that have a tuning for the analytic; inclues the tagset that are tuned and the keys that have a value for each user.

Request Syntax

response = client.get_tuning_for_analytic(
    exclude='string'
    filter='False|True'
    observation_path='string'
    path='string'
    return_values='False|True'
)
Parameters

  • exclude (string) –

    [REQUIRED]

    Comma seperated list of path prefixes to exclude e.g., tuning/Global

  • filter (boolean) –

    [REQUIRED]

    Filter output CIDs where observation_path is not included in the tagets, defaults to true.

  • observation_path (string) –

    [REQUIRED]

    Path of observation generated by analytic

  • path (string) –

    [REQUIRED]

    Path

  • return_values (boolean) –

    [REQUIRED]

    Returns tagset values

Returns

None

get_tuning_for_tagset(**kwargs)

Returns all the account_ids that have a tuning value for the tiven tagset; includes the keys in the tagset that have a value for the user

Request Syntax

response = client.get_tuning_for_tagset(
    path='string'
    return_values='False|True'
)
Parameters

  • path (string) –

    [REQUIRED]

    Name of the tagset

  • return_values (boolean) –

    [REQUIRED]

    Returns tagset values

Returns

None

get_tuning_tagset_by_path(**kwargs)

Return a specific tuning. The ‘etag’ header is set and may be used to cache the response by the caller. Tuning tagsets are not composed; they are simply retrieved from storage.

Request Syntax

response = client.get_tuning_tagset_by_path(
    account_id='string'
    path='string'
    ts='string'
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (string) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

get_tuning_tagset_expiration(**kwargs)

Return a tuning’s expiration timestamp

Note that setting expiration is effective immediately, just like if it was set up at the tuning’s creation time. This means that queries for the tuning having an associated timestamp posterior to the expiration time will suddenly not receive the tuning. This is by design and is intended as a way to prevent bad tunings from being used by the ae system as soon as possible.

If the content_id being expired is not the first version of the tuning that was posted, the tuning will NOT revert to its previous content_id; it will simply disappear (it IS expired) until the next version of the tuning is posted. If you find yourself in need of expiring a bad content_id and have a good copy of the tuning on hand, you can post it as early as possible: expiring an earlier content_id does not affect newer ones. As to what happens to data that would have been processed with an expired tuning, depending they are processed before or after the expiration is propagated through the AE system, it will see the expired tuning or not.

Note that because expiration done after the fact is done outside of regular content updates and because of caching, it may take a few minutes for the expiration to propagate throughout the AE system.

Request Syntax

response = client.get_tuning_tagset_expiration(
    id='string'
)
Parameters

id (string) –

[REQUIRED]

Tuning ID

Return type

integer

Returns

Response Syntax

'integer'

Response Definitions

lookup_tagset(**kwargs)

Looks up specific keys and values in specified tagsets

Request Syntax

response = client.lookup_tagset(
    account_id='string'
    compose='False|True'
    keys=[
        'string'
    ]
    lookup='and'|'or'
    paths=[
        'string'
    ]
    values=[
        'number|string'
    ]
)
Parameters

  • account_id (string) –

    [REQUIRED]

    AIMS Account ID

  • compose (boolean) –

    Determine if the tags are retrieve with composition or not, by default it is true.

    Default: true

  • keys (list) –

    [REQUIRED]

    • (string) –

  • lookup (string) – Valid values: and, or

  • paths (list) –

    [REQUIRED]

    • (string) –

  • values (list) –

    • (dict) –

Return type

dict

Returns

Response Syntax

{
    'matched': 'False|True'
}

Response Definitions

  • matched (boolean) –

review_path_overwrites(**kwargs)

Return the path overwrites for all account ids

Request Syntax

response = client.review_path_overwrites(
    epoch='integer'
    path='string'
    ts='integer'
)
Parameters

  • epoch (integer) – A positive integer representing an epoch

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

review_path_overwrites_by_cids(**kwargs)

Return the path overwrites for given account ids

Request Syntax

response = client.review_path_overwrites_by_cids(
    data=[
        'number'
    ]
    epoch='integer'
    path='string'
    ts='integer'
)
Parameters

  • data (list) –

    • (number) –

  • epoch (integer) – A positive integer representing an epoch

  • path (string) –

    [REQUIRED]

    url-encoded path

  • ts (integer) – A unix epoch timestamp

Return type

dict

Returns

Response Syntax

{}

Response Definitions

validate_definition(**kwargs)

Validate a definition object.

Request Syntax

response = client.validate_definition(
    $schema='string'
    default={}
    desc='string'
    direction='string'
    display_name='string'
    expiration='string'
    git_revision='string'
    inherit='string'
    name='string'
    path='string'
    type='string'
    unique='False|True'
    validation={}
)
Parameters

  • $schema (string) –

  • default (dict) –

  • desc (string) – [REQUIRED]

  • direction (string) – [REQUIRED]

  • display_name (string) – [REQUIRED]

  • expiration (string) – [REQUIRED]

  • git_revision (string) –

  • inherit (string) – [REQUIRED]

  • name (string) – [REQUIRED]

  • path (string) – Path of the tagset definition to validate against

  • type (string) – [REQUIRED]

  • unique (boolean) – [REQUIRED]

  • validation (dict) –

Returns

None

validate_tagset(**kwargs)

Validate a tagset object.

Request Syntax

response = client.validate_tagset(
    path='string'
    tagset={}
)
Parameters

  • path (string) – Path of the tagset definition to validate against

  • tagset (dict) –

Returns

None

validate_tuning_tagset(**kwargs)

Validate a tuning tagset object.

Request Syntax

response = client.validate_tuning_tagset(
    tagset={}
)
Parameters

tagset (dict) –

Returns

None