Class CreateOpportunityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest
software.amazon.awssdk.services.partnercentralselling.model.CreateOpportunityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateOpportunityRequest.Builder,CreateOpportunityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOpportunityRequest extends PartnerCentralSellingRequest implements ToCopyableBuilder<CreateOpportunityRequest.Builder,CreateOpportunityRequest>

  • Method Details

    • catalog

      public final String 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:
      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.

    • clientToken

      public final 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."

      Returns:
      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."

    • customer

      public final Customer customer()

      Specifies customer details associated with the Opportunity.

      Returns:
      Specifies customer details associated with the Opportunity.

    • lifeCycle

      public final LifeCycle lifeCycle()

      An object that contains lifecycle details for the Opportunity.

      Returns:
      An object that contains lifecycle details for the Opportunity.

    • marketing

      public final Marketing marketing()

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

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

    • nationalSecurity

      public final 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 .

      If the service returns an enum value that is not available in the current SDK version, nationalSecurity will return NationalSecurity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nationalSecurityAsString().

      Returns:
      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.
      See Also:

    • nationalSecurityAsString

      public final String nationalSecurityAsString()

      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 .

      If the service returns an enum value that is not available in the current SDK version, nationalSecurity will return NationalSecurity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nationalSecurityAsString().

      Returns:
      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.
      See Also:

    • hasOpportunityTeam

      public final boolean hasOpportunityTeam()
      For responses, this returns true if the service returned a value for the OpportunityTeam property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • opportunityTeam

      public final List<Contact> opportunityTeam()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOpportunityTeam() method.

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

    • opportunityType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, opportunityType will return OpportunityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from opportunityTypeAsString().

      Returns:
      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.

      See Also:

    • opportunityTypeAsString

      public final String opportunityTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, opportunityType will return OpportunityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from opportunityTypeAsString().

      Returns:
      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.

      See Also:

    • origin

      public final OpportunityOrigin 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.

      If the service returns an enum value that is not available in the current SDK version, origin will return OpportunityOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().

      Returns:
      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.
      See Also:

    • originAsString

      public final String originAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, origin will return OpportunityOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().

      Returns:
      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.
      See Also:

    • partnerOpportunityIdentifier

      public final 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.

      Returns:
      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.

    • primaryNeedsFromAws

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrimaryNeedsFromAws() method.

      Returns:
      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.

    • hasPrimaryNeedsFromAws

      public final boolean hasPrimaryNeedsFromAws()
      For responses, this returns true if the service returned a value for the PrimaryNeedsFromAws property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • primaryNeedsFromAwsAsStrings

      public final List<String> primaryNeedsFromAwsAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrimaryNeedsFromAws() method.

      Returns:
      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.

    • project

      public final Project project()

      An object that contains project details for the Opportunity.

      Returns:
      An object that contains project details for the Opportunity.

    • softwareRevenue

      public final SoftwareRevenue softwareRevenue()

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

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

    • toBuilder

      public CreateOpportunityRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateOpportunityRequest.Builder,CreateOpportunityRequest>
      Specified by:
      toBuilder in class PartnerCentralSellingRequest
      Returns:
      a builder for type T

    • builder

      public static CreateOpportunityRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOpportunityRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.