DevOpsAgentService / Paginator / ListTriggers

ListTriggers

class DevOpsAgentService.Paginator.ListTriggers

paginator = client.get_paginator('list_triggers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_triggers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    status='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier for the agent space whose Triggers should be listed

• status (string) – Filter results to Triggers in this status

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'triggerId': 'string',
            'agentSpaceId': 'string',
            'type': 'string',
            'condition': {
                'schedule': {
                    'expression': 'string',
                    'spec': {
                        'cron': {
                            'expression': 'string'
                        },
                        'timeRange': {
                            'startAfter': 'string',
                            'startBefore': 'string',
                            'recurrence': {
                                'daily': {},
                                'weekly': {
                                    'dayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
                                },
                                'monthly': {
                                    'dayOfMonth': 123
                                }
                            }
                        }
                    }
                }
            },
            'action': {...}|[...]|123|123.4|'string'|True|None,
            'status': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for listing Triggers

  • items (list) –

    The list of Triggers

    • (dict) –

      A Trigger fires on a schedule and invokes an agent

      • triggerId (string) –

        The unique identifier for this Trigger

      • agentSpaceId (string) –

        The agent space this Trigger belongs to

      • type (string) –

        How this Trigger fires

      • condition (dict) –

        The condition that fires this Trigger

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: schedule. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • schedule (dict) –

          Schedule-based firing condition. On CreateTrigger supply exactly one of the schedule condition’s expression or spec.

          • expression (string) –

            EventBridge cron or rate expression. Required for existing request and response compatibility. For a structured schedule response, this is the expression derived by Backlog.

          • spec (dict) –

            Structured schedule source of truth (cron | timeRange). On CreateTrigger supply exactly one of spec or expression. Present in responses together with the derived expression for structured triggers.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: cron, timeRange. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • cron (dict) –

              Runs on an EventBridge cron or rate cadence

              • expression (string) –

                EventBridge cron or rate expression that anchors the flexible window

            • timeRange (dict) –

              Runs within a recurring time-of-day window

              • startAfter (string) –

                Earliest time of day the trigger may fire

              • startBefore (string) –

                Latest time of day the trigger may fire

              • recurrence (dict) –

                How the window recurs

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: daily, weekly, monthly. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
                

                • daily (dict) –

                  The window recurs every day

                • weekly (dict) –

                  The window recurs once per week

                  • dayOfWeek (string) –

                    Day of week the window recurs on

                • monthly (dict) –

                  The window recurs once per month

                  • dayOfMonth (integer) –

                    Day of month the window recurs on

      • action (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) –

    A token to resume pagination.