ElementalInference / Client / list_schedule_actions

list_schedule_actions¶

ElementalInference.Client.list_schedule_actions(**kwargs)¶

Displays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed.

Elemental Inference keeps an action whose status is COMPLETED or FAILED for about 48 hours after its scheduled time, and then deletes it automatically.

Request Syntax

response = client.list_schedule_actions(
    id='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

id (string) –
[REQUIRED]

The ID of the feed that you want to query.
maxResults (integer) – The maximum number of results to return for each API request. If you don’t specify MaxResults, Elemental Inference returns a maximum of 10 results for each page.
nextToken (string) – The token that identifies the batch of results that you want to see. To see the next batch, submit the request a second time and specify the NextToken value that Elemental Inference returned.

Return type:

dict

Returns:

Response Syntax

{
    'scheduleActions': [
        {
            'actionName': 'string',
            'startConfiguration': {
                'fixedModeScheduleActionStartSettings': {
                    'scheduledAt': datetime(2015, 1, 1)
                }
            },
            'operations': [
                {
                    'updateOutputStatus': {
                        'outputName': 'string',
                        'status': 'ENABLED'|'DISABLED'
                    },
                    'updateClippingDataSourceConfiguration': {
                        'outputName': 'string',
                        'dataSourceConfiguration': {
                            'fixtureId': 'string'
                        }
                    },
                    'removeClippingDataSourceConfiguration': {
                        'outputName': 'string'
                    }
                },
            ],
            'status': 'PENDING'|'COMPLETED'|'FAILED',
            'error': {
                'errorCode': 'INVALID_ACTION_TARGET'|'INTERNAL_ERROR',
                'errorMessage': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- scheduleActions (list) –
  
  A list of the schedule actions on the feed.
  - (dict) –
    
    Describes one schedule action on a feed, including the changes it makes and whether it has run yet. Elemental Inference returns this structure in the ListScheduleActions operation.
    - actionName (string) –
      
      The name of the schedule action. The name is unique within the feed.
    - startConfiguration (dict) –
      
      Specifies when the action runs.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: fixedModeScheduleActionStartSettings. 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'}
      - fixedModeScheduleActionStartSettings (dict) –
        
        The start settings type for an action that runs once, at a fixed time.
        
        scheduledAt (datetime) –
        
        The UTC time at which the action runs. Specify the time in whole seconds. For the range of times that you can specify, see the AWS Elemental Inference User Guide.
        
        This time is approximate. The change can take a few minutes to take effect on the media that the feed is processing.
    - operations (list) –
      
      The configuration changes that the action makes to the feed.
      - (dict) –
        
        Holds one typed configuration change that a schedule action makes to a feed. Each operation must contain exactly one property.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: updateOutputStatus, updateClippingDataSourceConfiguration, removeClippingDataSourceConfiguration. 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'}
        
        updateOutputStatus (dict) –
        
        The operation type that enables or disables an output.
        
        outputName (string) –
        
        The name of the output that you want to enable or disable. The output must exist in the feed when you create the action.
        
        status (string) –
        
        Specifies whether the output is enabled or disabled after the action runs.
        
        updateClippingDataSourceConfiguration (dict) –
        
        The operation type that attaches a game to an event clipping output.
        
        outputName (string) –
        
        The name of the output that you want to attach the game to.
        
        dataSourceConfiguration (dict) –
        
        The game that you want to attach to the output.
        
        fixtureId (string) –
        
        The ID of the fixture whose event data you want Elemental Inference to map onto this clipping output. The fixture should be the sports event in the source media that the feed is processing.
        
        To obtain this ID, use the SearchFixtures operation to find the fixture, then use the fixtureId from the matching FixtureSummary.
        
        removeClippingDataSourceConfiguration (dict) –
        
        The operation type that removes the game from an event clipping output.
        
        outputName (string) –
        
        The name of the output that you want to remove the game from.
    - status (string) –
      
      The status of the action. Valid values are the following:
      
      PENDING
      
      The action is waiting for its scheduled time.
      
      COMPLETED
      
      Elemental Inference applied all the action’s operations to the feed.
      
      FAILED
      
      Elemental Inference couldn’t apply the action.
    - error (dict) –
      
      A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.
      - errorCode (string) –
        
        The type of failure. Valid values are the following:
        
        INVALID_ACTION_TARGET
        
        The action referred to something that didn’t exist or wasn’t valid at the scheduled time, for example an output that you deleted.
        
        INTERNAL_ERROR
        
        An unexpected error prevented the action from completing.
      - errorMessage (string) –
        
        A description of the failure.
- nextToken (string) –
  
  The token that identifies the next batch of results. Elemental Inference returns it only when more results are available.