Class: Aws::DataZone::Types::ListSubscriptionsInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::ListSubscriptionsInput

Includes:

Structure

Defined in:

lib/aws-sdk-datazone/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #approver_project_id ⇒ String

  The identifier of the project for the subscription’s approver.

• #domain_identifier ⇒ String

  The identifier of the Amazon DataZone domain.

• #max_results ⇒ Integer

  The maximum number of subscriptions to return in a single call to ‘ListSubscriptions`.

• #next_token ⇒ String

  When the number of subscriptions is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscriptions, the response includes a pagination token named `NextToken`.

• #owning_project_id ⇒ String

  The identifier of the owning project.

• #sort_by ⇒ String

  Specifies the way in which the results of this action are to be sorted.

• #sort_order ⇒ String

  Specifies the sort order for the results of this action.

• #status ⇒ String

  The status of the subscriptions that you want to list.

• #subscribed_listing_id ⇒ String

  The identifier of the subscribed listing for the subscriptions that you want to list.

• #subscription_request_identifier ⇒ String

  The identifier of the subscription request for the subscriptions that you want to list.

Instance Attribute Details

#approver_project_id ⇒ String

The identifier of the project for the subscription’s approver.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#domain_identifier ⇒ String

The identifier of the Amazon DataZone domain.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of subscriptions to return in a single call to ‘ListSubscriptions`. When the number of subscriptions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptions` to list the next set of Subscriptions.

Returns:

• (Integer)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

When the number of subscriptions is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscriptions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptions` to list the next set of subscriptions.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#owning_project_id ⇒ String

The identifier of the owning project.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

Specifies the way in which the results of this action are to be sorted.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

Specifies the sort order for the results of this action.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the subscriptions that you want to list.

<note markdown=“1”> This is not a required parameter, but if not provided, by default, Amazon DataZone returns only ‘APPROVED` subscriptions.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#subscribed_listing_id ⇒ String

The identifier of the subscribed listing for the subscriptions that you want to list.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_request_identifier ⇒ String

The identifier of the subscription request for the subscriptions that you want to list.

Returns:

• (String)

# File 'lib/aws-sdk-datazone/types.rb', line 13456

class ListSubscriptionsInput < Struct.new(
  :approver_project_id,
  :domain_identifier,
  :max_results,
  :next_token,
  :owning_project_id,
  :sort_by,
  :sort_order,
  :status,
  :subscribed_listing_id,
  :subscription_request_identifier)
  SENSITIVE = []
  include Aws::Structure
end