AWS DevOps Agent Service

Deletes a Trigger from the specified agent space

See also: AWS API Documentation

Request Syntax

client.delete_trigger(
    agentSpaceId='string',
    triggerId='string'
)

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

type triggerId:

string

param triggerId:

[REQUIRED]

Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates the status of an existing Trigger

See also: AWS API Documentation

Request Syntax

client.update_trigger(
    agentSpaceId='string',
    triggerId='string',
    status='string',
    clientToken='string'
)

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

type triggerId:

string

param triggerId:

[REQUIRED]

Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

type status:

string

param status:

The new status for the Trigger

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier used for idempotent Trigger update

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'trigger': {
        'triggerId': 'string',
        'agentSpaceId': 'string',
        'type': 'string',
        'condition': {
            'schedule': {
                'expression': 'string'
            }
        },
        'action': {...}|[...]|123|123.4|'string'|True|None,
        'status': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • trigger (dict) --

    The Trigger object

    • triggerId (string) --

      Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

    • agentSpaceId (string) --

      Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

    • type (string) --

      How this Trigger fires

    • condition (dict) --

      The condition that fires this Trigger

      • schedule (dict) --

        Time-based firing condition

        • expression (string) --

          The schedule expression

    • action (:ref:`document<document>`) --

      The action this Trigger performs when it fires

    • status (string) --

      The status of this Trigger

    • createdAt (datetime) --

      Timestamp when this Trigger was created

    • updatedAt (datetime) --

      Timestamp when this Trigger was last updated

Creates a new Trigger in the specified agent space

See also: AWS API Documentation

Request Syntax

client.create_trigger(
    agentSpaceId='string',
    type='string',
    condition={
        'schedule': {
            'expression': 'string'
        }
    },
    action={...}|[...]|123|123.4|'string'|True|None,
    status='string',
    clientToken='string'
)

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

type type:

string

param type:

[REQUIRED]

How the new Trigger fires

type condition:

dict

param condition:

[REQUIRED]

The condition that fires the new Trigger

• schedule (dict) --

  Time-based firing condition

  • expression (string) -- [REQUIRED]

    The schedule expression

type action:

:ref:`document<document>`

param action:

[REQUIRED]

The action the new Trigger performs when it fires

type status:

string

param status:

The initial status of the Trigger

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier used for idempotent Trigger creation

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'trigger': {
        'triggerId': 'string',
        'agentSpaceId': 'string',
        'type': 'string',
        'condition': {
            'schedule': {
                'expression': 'string'
            }
        },
        'action': {...}|[...]|123|123.4|'string'|True|None,
        'status': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • trigger (dict) --

    The Trigger object

    • triggerId (string) --

      Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

    • agentSpaceId (string) --

      Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

    • type (string) --

      How this Trigger fires

    • condition (dict) --

      The condition that fires this Trigger

      • schedule (dict) --

        Time-based firing condition

        • expression (string) --

          The schedule expression

    • action (:ref:`document<document>`) --

      The action this Trigger performs when it fires

    • status (string) --

      The status of this Trigger

    • createdAt (datetime) --

      Timestamp when this Trigger was created

    • updatedAt (datetime) --

      Timestamp when this Trigger was last updated

Gets a Trigger from the specified agent space

See also: AWS API Documentation

Request Syntax

client.get_trigger(
    agentSpaceId='string',
    triggerId='string'
)

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

type triggerId:

string

param triggerId:

[REQUIRED]

Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

rtype:

dict

returns:

Response Syntax

{
    'trigger': {
        'triggerId': 'string',
        'agentSpaceId': 'string',
        'type': 'string',
        'condition': {
            'schedule': {
                'expression': 'string'
            }
        },
        'action': {...}|[...]|123|123.4|'string'|True|None,
        'status': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • trigger (dict) --

    The Trigger object

    • triggerId (string) --

      Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

    • agentSpaceId (string) --

      Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

    • type (string) --

      How this Trigger fires

    • condition (dict) --

      The condition that fires this Trigger

      • schedule (dict) --

        Time-based firing condition

        • expression (string) --

          The schedule expression

    • action (:ref:`document<document>`) --

      The action this Trigger performs when it fires

    • status (string) --

      The status of this Trigger

    • createdAt (datetime) --

      Timestamp when this Trigger was created

    • updatedAt (datetime) --

      Timestamp when this Trigger was last updated

Lists Triggers in the specified agent space

See also: AWS API Documentation

Request Syntax

client.list_triggers(
    agentSpaceId='string',
    status='string',
    nextToken='string',
    maxResults=123
)

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

type status:

string

param status:

Filter results to Triggers in this status

type nextToken:

string

param nextToken:

Pagination token from a previous response to retrieve the next page of results

type maxResults:

integer

param maxResults:

The maximum number of results to return in a single response

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'triggerId': 'string',
            'agentSpaceId': 'string',
            'type': 'string',
            'condition': {
                'schedule': {
                    'expression': 'string'
                }
            },
            'action': {...}|[...]|123|123.4|'string'|True|None,
            'status': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    The list of Triggers

    • (dict) --

      A Trigger fires on a schedule and invokes an agent

      • triggerId (string) --

        Generic resource identifier (allows alphanumeric characters, hyphens, and underscores; 1-128 characters)

      • agentSpaceId (string) --

        Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

      • type (string) --

        How this Trigger fires

      • condition (dict) --

        The condition that fires this Trigger

        • schedule (dict) --

          Time-based firing condition

          • expression (string) --

            The schedule expression

      • action (:ref:`document<document>`) --

        The action this Trigger performs when it fires

      • status (string) --

        The status of this Trigger

      • createdAt (datetime) --

        Timestamp when this Trigger was created

      • updatedAt (datetime) --

        Timestamp when this Trigger was last updated

  • nextToken (string) --

    Pagination token for list operations (1-2048 characters)