Interface CreateOpportunityRequest.Builder

  • Method Details

    • catalog

      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 opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

      Parameters:
      catalog - 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 opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

      CreateOpportunityRequest.Builder clientToken(String clientToken)

      Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

      Default: None

      Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."

      Parameters:
      clientToken - Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

      Default: None

      Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customer

      Specifies customer details associated with the Opportunity.

      Parameters:
      customer - Specifies customer details associated with the Opportunity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customer

      Specifies customer details associated with the Opportunity.

      This is a convenience method that creates an instance of the Customer.Builder avoiding the need to create one manually via Customer.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customer(Customer).

      Parameters:
      customer - a consumer that will call methods on Customer.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lifeCycle

      An object that contains lifecycle details for the Opportunity.

      Parameters:
      lifeCycle - An object that contains lifecycle details for the Opportunity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lifeCycle

      An object that contains lifecycle details for the Opportunity.

      This is a convenience method that creates an instance of the LifeCycle.Builder avoiding the need to create one manually via LifeCycle.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifeCycle(LifeCycle).

      Parameters:
      lifeCycle - a consumer that will call methods on LifeCycle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • marketing

      This object contains marketing details and is optional for an opportunity.

      Parameters:
      marketing - This object contains marketing details and is optional for an opportunity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • marketing

      This object contains marketing details and is optional for an opportunity.

      This is a convenience method that creates an instance of the Marketing.Builder avoiding the need to create one manually via Marketing.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to marketing(Marketing).

      Parameters:
      marketing - a consumer that will call methods on Marketing.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nationalSecurity

      CreateOpportunityRequest.Builder nationalSecurity(String nationalSecurity)

      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

      Parameters:
      nationalSecurity - Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nationalSecurity

      CreateOpportunityRequest.Builder nationalSecurity(NationalSecurity nationalSecurity)

      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

      Parameters:
      nationalSecurity - Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • opportunityTeam

      CreateOpportunityRequest.Builder opportunityTeam(Collection<Contact> opportunityTeam)

      Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

      Parameters:
      opportunityTeam - Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • opportunityTeam

      CreateOpportunityRequest.Builder opportunityTeam(Contact... opportunityTeam)

      Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

      Parameters:
      opportunityTeam - Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • opportunityTeam

      CreateOpportunityRequest.Builder opportunityTeam(Consumer<Contact.Builder>... opportunityTeam)

      Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

      This is a convenience method that creates an instance of the Contact.Builder avoiding the need to create one manually via Contact.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to opportunityTeam(List<Contact>).

      Parameters:
      opportunityTeam - a consumer that will call methods on Contact.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • opportunityType

      CreateOpportunityRequest.Builder opportunityType(String opportunityType)

      Specifies the opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      Parameters:
      opportunityType - Specifies the opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • opportunityType

      CreateOpportunityRequest.Builder opportunityType(OpportunityType opportunityType)

      Specifies the opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      Parameters:
      opportunityType - Specifies the opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • origin

      Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

      Parameters:
      origin - Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • origin

      Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

      Parameters:
      origin - Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • partnerOpportunityIdentifier

      CreateOpportunityRequest.Builder partnerOpportunityIdentifier(String partnerOpportunityIdentifier)

      Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

      This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

      Parameters:
      partnerOpportunityIdentifier - Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

      This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryNeedsFromAwsWithStrings

      CreateOpportunityRequest.Builder primaryNeedsFromAwsWithStrings(Collection<String> primaryNeedsFromAws)

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Parameters:
      primaryNeedsFromAws - Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryNeedsFromAwsWithStrings

      CreateOpportunityRequest.Builder primaryNeedsFromAwsWithStrings(String... primaryNeedsFromAws)

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Parameters:
      primaryNeedsFromAws - Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryNeedsFromAws

      CreateOpportunityRequest.Builder primaryNeedsFromAws(Collection<PrimaryNeedFromAws> primaryNeedsFromAws)

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Parameters:
      primaryNeedsFromAws - Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • primaryNeedsFromAws

      CreateOpportunityRequest.Builder primaryNeedsFromAws(PrimaryNeedFromAws... primaryNeedsFromAws)

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Parameters:
      primaryNeedsFromAws - Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • project

      An object that contains project details for the Opportunity.

      Parameters:
      project - An object that contains project details for the Opportunity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • project

      An object that contains project details for the Opportunity.

      This is a convenience method that creates an instance of the Project.Builder avoiding the need to create one manually via Project.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to project(Project).

      Parameters:
      project - a consumer that will call methods on Project.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • softwareRevenue

      CreateOpportunityRequest.Builder softwareRevenue(SoftwareRevenue softwareRevenue)

      Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

      Parameters:
      softwareRevenue - Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • softwareRevenue

      default CreateOpportunityRequest.Builder softwareRevenue(Consumer<SoftwareRevenue.Builder> softwareRevenue)

      Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

      This is a convenience method that creates an instance of the SoftwareRevenue.Builder avoiding the need to create one manually via SoftwareRevenue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to softwareRevenue(SoftwareRevenue).

      Parameters:
      softwareRevenue - a consumer that will call methods on SoftwareRevenue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateOpportunityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.