amazonka-elastictranscoder-2.0: Amazon Elastic Transcoder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Description

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

Synopsis

Creating a Request

data UpdatePipelineNotifications Source #

The UpdatePipelineNotificationsRequest structure.

See: newUpdatePipelineNotifications smart constructor.

Constructors

UpdatePipelineNotifications' 

Fields

  • id :: Text

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

  • notifications :: 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.
    • Complete: 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.

Instances

Instances details
ToJSON UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

ToHeaders UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

ToPath UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

ToQuery UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

AWSRequest UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Generic UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Associated Types

type Rep UpdatePipelineNotifications :: Type -> Type #

Read UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Show UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

NFData UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Eq UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Hashable UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

type AWSResponse UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

type Rep UpdatePipelineNotifications Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

type Rep UpdatePipelineNotifications = D1 ('MetaData "UpdatePipelineNotifications" "Amazonka.ElasticTranscoder.UpdatePipelineNotifications" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "UpdatePipelineNotifications'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "notifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Notifications)))

newUpdatePipelineNotifications Source #

Create a value of UpdatePipelineNotifications with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdatePipelineNotifications, updatePipelineNotifications_id - The identifier of the pipeline for which you want to change notification settings.

UpdatePipelineNotifications, updatePipelineNotifications_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.
  • Complete: 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.

Request Lenses

updatePipelineNotifications_id :: Lens' UpdatePipelineNotifications Text Source #

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

updatePipelineNotifications_notifications :: Lens' UpdatePipelineNotifications Notifications Source #

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.
  • Complete: 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.

Destructuring the Response

data UpdatePipelineNotificationsResponse Source #

The UpdatePipelineNotificationsResponse structure.

See: newUpdatePipelineNotificationsResponse smart constructor.

Constructors

UpdatePipelineNotificationsResponse' 

Fields

  • pipeline :: Maybe Pipeline

    A section of the response body that provides information about the pipeline associated with this notification.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Read UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Show UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

NFData UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

Eq UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

type Rep UpdatePipelineNotificationsResponse Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.UpdatePipelineNotifications

type Rep UpdatePipelineNotificationsResponse = D1 ('MetaData "UpdatePipelineNotificationsResponse" "Amazonka.ElasticTranscoder.UpdatePipelineNotifications" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "UpdatePipelineNotificationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Pipeline)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdatePipelineNotificationsResponse Source #

Create a value of UpdatePipelineNotificationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pipeline:UpdatePipelineNotificationsResponse', updatePipelineNotificationsResponse_pipeline - A section of the response body that provides information about the pipeline associated with this notification.

$sel:httpStatus:UpdatePipelineNotificationsResponse', updatePipelineNotificationsResponse_httpStatus - The response's http status code.

Response Lenses

updatePipelineNotificationsResponse_pipeline :: Lens' UpdatePipelineNotificationsResponse (Maybe Pipeline) Source #

A section of the response body that provides information about the pipeline associated with this notification.