Class: Aws::Redshift::Types::DescribeDataSharesForConsumerMessage

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

Overview

Note:

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

{
  consumer_arn: "String",
  status: "ACTIVE", # accepts ACTIVE, AVAILABLE
  max_records: 1,
  marker: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_arnString

The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

Returns:

  • (String)


4651
4652
4653
4654
4655
4656
4657
4658
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4651

class DescribeDataSharesForConsumerMessage < Struct.new(
  :consumer_arn,
  :status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (String)


4651
4652
4653
4654
4655
4656
4657
4658
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4651

class DescribeDataSharesForConsumerMessage < Struct.new(
  :consumer_arn,
  :status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Returns:

  • (Integer)


4651
4652
4653
4654
4655
4656
4657
4658
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4651

class DescribeDataSharesForConsumerMessage < Struct.new(
  :consumer_arn,
  :status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

Returns:

  • (String)


4651
4652
4653
4654
4655
4656
4657
4658
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4651

class DescribeDataSharesForConsumerMessage < Struct.new(
  :consumer_arn,
  :status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end