list-schedule-actions¶

Description¶

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.

Synopsis¶

  list-schedule-actions
--id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--id (string) [required]

The ID of the feed that you want to query.

Constraints:

pattern: [a-z0-9]{19}

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

scheduleActions -> (list)

A list of the schedule actions on the feed.

Constraints:

min: 0

max: 100

(structure)

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) [required]

The name of the schedule action. The name is unique within the feed.

Constraints:

pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

startConfiguration -> (tagged union structure) [required]

Specifies when the action runs.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: fixedModeScheduleActionStartSettings.

fixedModeScheduleActionStartSettings -> (structure)

The start settings type for an action that runs once, at a fixed time.

scheduledAt -> (timestamp) [required]

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) [required]

The configuration changes that the action makes to the feed.

Constraints:

min: 1

max: 10

(tagged union structure)

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 can be set: updateOutputStatus, updateClippingDataSourceConfiguration, removeClippingDataSourceConfiguration.

updateOutputStatus -> (structure)

The operation type that enables or disables an output.

outputName -> (string) [required]

The name of the output that you want to enable or disable. The output must exist in the feed when you create the action.

Constraints:

pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

status -> (string) [required]

Specifies whether the output is enabled or disabled after the action runs.

Possible values:

ENABLED

DISABLED

updateClippingDataSourceConfiguration -> (structure)

The operation type that attaches a game to an event clipping output.

outputName -> (string) [required]

The name of the output that you want to attach the game to.

Constraints:

pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

dataSourceConfiguration -> (structure) [required]

The game that you want to attach to the output.

fixtureId -> (string) [required]

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.

Constraints:

min: 1

max: 128

removeClippingDataSourceConfiguration -> (structure)

The operation type that removes the game from an event clipping output.

outputName -> (string) [required]

The name of the output that you want to remove the game from.

Constraints:

pattern: [a-zA-Z0-9]([a-zA-Z0-9-_]{0,126}[a-zA-Z0-9])?

status -> (string) [required]

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.

Possible values:

PENDING

COMPLETED

FAILED

error -> (structure)

A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

errorCode -> (string) [required]

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.

Possible values:

INVALID_ACTION_TARGET

INTERNAL_ERROR

errorMessage -> (string) [required]

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.

Table of Contents

Feedback

User Guide