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

Class: Aws::Textract::Types::NotificationChannel

Inherits:

Struct

Object
Struct
Aws::Textract::Types::NotificationChannel

show all

Defined in:: (unknown)

Overview

Note:

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

{
  sns_topic_arn: "SNSTopicArn", # required
  role_arn: "RoleArn", # required
}

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

Returned by:

Instance Attribute Summary collapse

#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
#sns_topic_arn ⇒ String
The Amazon SNS topic that Amazon Textract posts the completion status to.

Instance Attribute Details

#role_arn ⇒ `String`

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

Returns:

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

#sns_topic_arn ⇒ `String`

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