Themis

Table of Contents

• Themis

  • Client

Client

class Themis.Client

A client object representing ‘Themis’ Service:

import almdrlib

client = almdrlib.client('themis')

Available methods:

• get_role()

• get_roles()

• validate_credentials()

get_role(**kwargs)

Get Role

Request Syntax

response = client.get_role(
    account_id='string'
    platform_type='string'
    role_type='string'
    role_version='string'
)

Parameters

• account_id (string) – [REQUIRED]

• platform_type (string) – [REQUIRED]

• role_type (string) – [REQUIRED]

• role_version (string) – [REQUIRED]

Return type

dict

Returns

Response Syntax

{
    'aws_account_id': 'string',
    'cft': {
        's3_bucket': 'string',
        's3_key': 'string',
        's3_url': 'string'
    },
    'external_id': 'string',
    'platform_type': 'string',
    'policy_document': {},
    'type': 'string',
    'version': 'string'
}

Response Definitions

• aws_account_id (string) –

• cft (dict) – [REQUIRED]

  • s3_bucket (string) –

  • s3_key (string) –

  • s3_url (string) –

• external_id (string) –

• platform_type (string) –

• policy_document (dict) –

• type (string) –

• version (string) –

get_roles(**kwargs)

Get all latest roles matching query string parameters

Request Syntax

response = client.get_roles(
    account_id='string'
    platform_type='string'
)

Parameters

• account_id (string) – [REQUIRED]

• platform_type (string) –

Return type

list

Returns

Response Syntax

[
    {
        'aws_account_id': 'string',
        'cft': {
            's3_bucket': 'string',
            's3_key': 'string',
            's3_url': 'string'
        },
        'external_id': 'string',
        'platform_type': 'string',
        'policy_document': {},
        'type': 'string',
        'version': 'string'
    }
]

Response Definitions

• (dict) –

  • aws_account_id (string) –

  • cft (dict) – [REQUIRED]

    • s3_bucket (string) –

    • s3_key (string) –

    • s3_url (string) –

  • external_id (string) –

  • platform_type (string) –

  • policy_document (dict) –

  • type (string) –

  • version (string) –

validate_credentials(**kwargs)

Validate AWS IAM role provided by the customer across AlertLogic requirements

Request Syntax

response = client.validate_credentials(
    credential={
        'arn': 'string',
        'external_id': 'string',
        'platform_type': 'aws',
        'role_type': 'ci_manual'|'ci_full'|'cd_full'|'ci_x_account_ct'|'ci_essentials'|'ci_readonly',
        'role_version': 'string'
    }
    platform_type='aws'
    role_type='ci_manual'|'ci_full'|'cd_full'|'ci_x_account_ct'|'ci_essentials'|'ci_readonly'
)

Parameters

• credential (dict) –

  [REQUIRED]

  AWS Role Information

  • arn (string) –

    AWS IAM role ARN

  • external_id (string) –

    AWS IAM role external ID

  • platform_type (string) –

    The platform type

    Valid values: aws

  • role_type (string) –

    The role type for validation

    Valid values: ci_manual, ci_full, cd_full, ci_x_account_ct, ci_essentials, ci_readonly

  • role_version (string) –

    Expected role version, if not specified the latest role version is validated

• platform_type (string) –

  [REQUIRED]

  The platform type

  Valid values: aws

• role_type (string) –

  [REQUIRED]

  The role type for validation

  Valid values: ci_manual, ci_full, cd_full, ci_x_account_ct, ci_essentials, ci_readonly

Return type

dict

Returns

Response Syntax

{
    'message': 'string',
    'status': 'string',
    'version': 'string'
}

Response Definitions

• message (string) –

• status (string) –

• version (string) –