ListAlerts - AWS Elemental MediaTailor

ListAlerts

Lists the alerts that are associated with a MediaTailor channel assembly resource.

URI

/v1/alerts

HTTP methods

GET

Operation ID: ListAlerts

Returns a list of alerts for the given resource.

Query parameters
Name Type Required Description
resourceArn String True

The Amazon Resource Name (ARN) of the resource.

nextToken String False

Pagination token from the GET list request. Use the token to fetch the next page of results.

maxResults String False

Upper bound on number of records to return. The maximum number of results is 100.

Responses
Status code Response model Description
200 ListAlertsResponse

Success.

Schemas

Response bodies

{ "NextToken": "string", "Items": [ { "ResourceArn": "string", "AlertCode": "string", "LastModifiedTime": integer, "RelatedResourceArns": [ "string" ], "AlertMessage": "string" } ] }

Properties

Alert

Alert configuration parameters.

Property Type Required Description
ResourceArn

string

True

The Amazon Resource Name (ARN) of the resource.

AlertCode

string

True

The code for the alert. For example, NOT_PROCESSED.

LastModifiedTime

integer

Format: date-time

True

The timestamp when the alert was last modified.

RelatedResourceArns

Array of type string

True

The Amazon Resource Names (ARNs) related to this alert.

AlertMessage

string

True

If an alert is generated for a resource, an explanation of the reason for the alert.

ListAlertsResponse

Lists the alerts for a given resource.

Property Type Required Description
NextToken

string

False

Pagination token from the list request. Use the token to fetch the next page of results.

Items

Array of type Alert

False

An array of alerts that are associated with this resource.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListAlerts