Class: Aws::PartnerCentralSelling::Types::ListOpportunitiesRequest

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::ListOpportunitiesRequest

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 associated with the request.

• #customer_company_name ⇒ Array<String>

  Filters the opportunities based on the customer’s company name.

• #identifier ⇒ Array<String>

  Filters the opportunities based on the opportunity identifier.

• #last_modified_date ⇒ Types::LastModifiedDate

  Filters the opportunities based on their last modified date.

• #life_cycle_review_status ⇒ Array<String>

  Filters the opportunities based on their current lifecycle approval status.

• #life_cycle_stage ⇒ Array<String>

  Filters the opportunities based on their lifecycle stage.

• #max_results ⇒ Integer

  Specifies the maximum number of results to return in a single call.

• #next_token ⇒ String

  A pagination token used to retrieve the next set of results in subsequent calls.

• #sort ⇒ Types::OpportunitySort

  An object that specifies how the response is sorted.

Instance Attribute Details

#catalog ⇒ String

Specifies the catalog associated with the request. This field takes a string value from a predefined list: ‘AWS` or `Sandbox`. The catalog determines which environment the opportunities are listed in. Use `AWS` for listing real opportunities in the Amazon Web Services catalog, and `Sandbox` for testing in secure, isolated environments.

Returns:

• (String)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#customer_company_name ⇒ Array<String>

Filters the opportunities based on the customer’s company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

Returns:

• (Array<String>)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ Array<String>

Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

Returns:

• (Array<String>)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Types::LastModifiedDate

Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

Returns:

• (Types::LastModifiedDate)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_review_status ⇒ Array<String>

Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as ‘Pending Submission`, `In Review`, `Action Required`, or `Approved`.

Returns:

• (Array<String>)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_stage ⇒ Array<String>

Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as ‘Qualified`, `Technical Validation`, `Business Validation`, or `Closed Won`.

Returns:

• (Array<String>)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

Returns:

• (Integer)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

Returns:

• (String)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::OpportunitySort

An object that specifies how the response is sorted. The default ‘Sort.SortBy` value is `LastModifiedDate`.

Returns:

• (Types::OpportunitySort)

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

class ListOpportunitiesRequest < Struct.new(
  :catalog,
  :max_results,
  :next_token,
  :sort,
  :last_modified_date,
  :identifier,
  :life_cycle_stage,
  :life_cycle_review_status,
  :customer_company_name)
  SENSITIVE = []
  include Aws::Structure
end