AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::DescribeEventSubscriptionsMessage

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

Overview

Note:

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

{
  subscription_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeEventSubscriptions.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3401

class DescribeEventSubscriptionsMessage < Struct.new(
  :subscription_name,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3401

class DescribeEventSubscriptionsMessage < Struct.new(
  :subscription_name,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3401

class DescribeEventSubscriptionsMessage < Struct.new(
  :subscription_name,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_nameString

The name of the Amazon DocumentDB event notification subscription that you want to describe.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3401

class DescribeEventSubscriptionsMessage < Struct.new(
  :subscription_name,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end