Class: Aws::PartnerCentralSelling::Types::ListEngagementFromOpportunityTasksRequest

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::ListEngagementFromOpportunityTasksRequest

Includes:

Structure

Defined in:

lib/aws-sdk-partnercentralselling/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  Specifies the catalog related to the request.

• #engagement_identifier ⇒ Array<String>

  Filters tasks by the identifiers of the engagements they created or are associated with.

• #max_results ⇒ Integer

  Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

• #next_token ⇒ String

  The token for requesting the next page of results.

• #opportunity_identifier ⇒ Array<String>

  The identifier of the original opportunity associated with this task.

• #sort ⇒ Types::ListTasksSortBase

  Specifies the sorting criteria for the returned results.

• #task_identifier ⇒ Array<String>

  Filters tasks by their unique identifiers.

• #task_status ⇒ Array<String>

  Filters the tasks based on their current status.

Instance Attribute Details

#catalog ⇒ String

Specifies the catalog related to the request. Valid values are:

• AWS: Retrieves the request from the production AWS environment.

• Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.

Returns:

• (String)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_identifier ⇒ Array<String>

Filters tasks by the identifiers of the engagements they created or are associated with.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

Returns:

• (Integer)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

Returns:

• (String)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#opportunity_identifier ⇒ Array<String>

The identifier of the original opportunity associated with this task.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::ListTasksSortBase

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

Returns:

• (Types::ListTasksSortBase)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#task_identifier ⇒ Array<String>

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#task_status ⇒ Array<String>

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-partnercentralselling/types.rb', line 3178

class ListEngagementFromOpportunityTasksRequest < Struct.new(
  :max_results,
  :next_token,
  :sort,
  :catalog,
  :task_status,
  :task_identifier,
  :opportunity_identifier,
  :engagement_identifier)
  SENSITIVE = []
  include Aws::Structure
end