Amazonka.Textract.Types.NotificationChannel

Documentation

data NotificationChannel

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

See: newNotificationChannel smart constructor.

Constructors

NotificationChannel'

Fields

• sNSTopicArn :: Text

  The Amazon SNS topic that Amazon Textract posts the completion status to.

• roleArn :: Text

  The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

Instances

ToJSON NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

toJSON :: NotificationChannel -> Value

toEncoding :: NotificationChannel -> Encoding

toJSONList :: [NotificationChannel] -> Value

toEncodingList :: [NotificationChannel] -> Encoding

Generic NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Associated Types

type Rep NotificationChannel :: Type -> Type

Methods

from :: NotificationChannel -> Rep NotificationChannel x

to :: Rep NotificationChannel x -> NotificationChannel

Read NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

readsPrec :: Int -> ReadS NotificationChannel

readList :: ReadS [NotificationChannel]

readPrec :: ReadPrec NotificationChannel

readListPrec :: ReadPrec [NotificationChannel]

Show NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

showsPrec :: Int -> NotificationChannel -> ShowS

show :: NotificationChannel -> String

showList :: [NotificationChannel] -> ShowS

NFData NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

rnf :: NotificationChannel -> ()

Eq NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

(==) :: NotificationChannel -> NotificationChannel -> Bool

(/=) :: NotificationChannel -> NotificationChannel -> Bool

Hashable NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

Methods

hashWithSalt :: Int -> NotificationChannel -> Int

hash :: NotificationChannel -> Int

type Rep NotificationChannel

Defined in Amazonka.Textract.Types.NotificationChannel

type Rep NotificationChannel = D1 ('MetaData "NotificationChannel" "Amazonka.Textract.Types.NotificationChannel" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "NotificationChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sNSTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newNotificationChannel

Arguments

:: Text

$sel:sNSTopicArn:NotificationChannel'

-> Text

$sel:roleArn:NotificationChannel'

-> NotificationChannel

Create a value of NotificationChannel 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:sNSTopicArn:NotificationChannel', notificationChannel_sNSTopicArn - The Amazon SNS topic that Amazon Textract posts the completion status to.

$sel:roleArn:NotificationChannel', notificationChannel_roleArn - The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

notificationChannel_sNSTopicArn :: Lens' NotificationChannel Text

The Amazon SNS topic that Amazon Textract posts the completion status to.

notificationChannel_roleArn :: Lens' NotificationChannel Text

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.