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

Class: Aws::DirectoryService::Types::DescribeEventTopicsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventTopicsRequest data as a hash:

{
  directory_id: "DirectoryId",
  topic_names: ["TopicName"],
}

Describes event topics.

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

Returns:

  • (String)


1104
1105
1106
1107
1108
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1104

class DescribeEventTopicsRequest < Struct.new(
  :directory_id,
  :topic_names)
  include Aws::Structure
end

#topic_namesArray<String>

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

Returns:

  • (Array<String>)


1104
1105
1106
1107
1108
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1104

class DescribeEventTopicsRequest < Struct.new(
  :directory_id,
  :topic_names)
  include Aws::Structure
end