Otis ¶

Table of Contents

Otis
- Client

Client ¶

class Otis.Client¶

A client object representing ‘Otis’ Service:

import almdrlib

client = almdrlib.client('otis')

Available methods:

create_option()
delete_option()
get_option()
list_cross_protected_networks()
list_cross_protecting_networks()
list_options()
update_option()

create_option(**kwargs)¶

Create option.

Request Syntax

response = client.create_option(
    account_id='string'
    option='dict'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
option (dict) –

Return type

dict

Returns

Response Syntax

'dict'

Response Definitions

delete_option(**kwargs)¶

Delete option by id.

Request Syntax

response = client.delete_option(
    account_id='string'
    option_id='string'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
option_id (string) –
[REQUIRED]

UUID of an option item stored in the database

Returns: None

get_option(**kwargs)¶

Get option by id.

Request Syntax

response = client.get_option(
    account_id='string'
    option_id='string'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
option_id (string) –
[REQUIRED]

UUID of an option item stored in the database

Return type

dict

Returns

Response Syntax

'dict'

Response Definitions

list_cross_protected_networks(**kwargs)¶

List protected networks

Request Syntax

response = client.list_cross_protected_networks(
    account_id='string'
    deployment_id='string'
    option_id='string'
    vpc_key='string'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
deployment_id (string) –
option_id (string) – UUID of an option item stored in the database
vpc_key (string) –

Return type

list

Returns

Response Syntax

[
    {
        'account_id': 'string',
        'deployment_id': 'string',
        'option_id': 'string',
        'protecting_network': {
            'account_id': 'string',
            'deployment_id': 'string',
            'vpc_key': 'string'
        },
        'vpc_key': 'string'
    }
]

Response Definitions

(dict) –

account_id (string) –

deployment_id (string) –

option_id (string) –

UUID of an option item stored in the database

protecting_network (dict) –

account_id (string) –

deployment_id (string) –

vpc_key (string) –

vpc_key (string) –

list_cross_protecting_networks(**kwargs)¶

List protecting networks

Request Syntax

response = client.list_cross_protecting_networks(
    account_id='string'
    deployment_id='string'
    option_id='string'
    vpc_key='string'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
deployment_id (string) –
option_id (string) – UUID of an option item stored in the database
vpc_key (string) –

Return type

list

Returns

Response Syntax

[
    {
        'account_id': 'string',
        'deployment_id': 'string',
        'option_id': 'string',
        'protected_network': {
            'account_id': 'string',
            'deployment_id': 'string',
            'vpc_key': 'string'
        },
        'vpc_key': 'string'
    }
]

Response Definitions

(dict) –

account_id (string) –

deployment_id (string) –

option_id (string) –

UUID of an option item stored in the database

protected_network (dict) –

account_id (string) –

deployment_id (string) –

vpc_key (string) –

vpc_key (string) –

list_options(**kwargs)¶

List options.

Request Syntax

response = client.list_options(
    account_id='string'
)

Parameters

account_id (string) –

[REQUIRED]

Alert Logic account ID

Return type

list

Returns

Response Syntax

[
    'dict'
]

Response Definitions

(dict) –

update_option(**kwargs)¶

Update option value

Request Syntax

response = client.update_option(
    account_id='string'
    data='dict'
    option_id='string'
)

Parameters

account_id (string) –
[REQUIRED]

Alert Logic account ID
data (dict) –
option_id (string) –
[REQUIRED]

UUID of an option item stored in the database

Return type

dict

Returns

Response Syntax

{
    'value': 'string'
}

Response Definitions

value (string) –

Otis¶

Client¶

Otis ¶

Client ¶