You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::UpdatePipelineNotificationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdatePipelineNotificationsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "Id", # required
  notifications: { # required
    progressing: "SnsTopic",
    completed: "SnsTopic",
    warning: "SnsTopic",
    error: "SnsTopic",
  },
}

The UpdatePipelineNotificationsRequest structure.

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The identifier of the pipeline for which you want to change notification settings.

Returns:

  • (String)

    The identifier of the pipeline for which you want to change notification settings.

#notificationsTypes::Notifications

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

Returns:

  • (Types::Notifications)

    The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.