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
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) of the resource.

nextTokenStringFalse

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

maxResultsStringFalse

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

Responses
Status codeResponse modelDescription
200ListAlertsResponse

Success.

OPTIONS

Enable CORS by returning the correct headers

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Response bodies

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

Properties

Alert

Alert configuration parameters.

PropertyTypeRequiredDescription
AlertCode

string

True

The code for the alert. For example, NOT_PROCESSED.

AlertMessage

string

True

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

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.

ResourceArn

string

True

The Amazon Resource Name (ARN) of the resource.

ListAlertsResponse

Lists the alerts for a given resource.

PropertyTypeRequiredDescription
Items

Array of type Alert

False

A list of alerts that are associated with this resource.

NextToken

string

False

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

See also

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

ListAlerts