Partner Central Selling API

Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.

See also: AWS API Documentation

Request Syntax

client.get_aws_opportunity_summary(
    Catalog='string',
    RelatedOpportunityIdentifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

type RelatedOpportunityIdentifier:

string

param RelatedOpportunityIdentifier:

[REQUIRED]

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity in your CRM system.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'Customer': {
        'Contacts': [
            {
                'BusinessTitle': 'string',
                'Email': 'string',
                'FirstName': 'string',
                'LastName': 'string',
                'Phone': 'string'
            },
        ]
    },
    'Insights': {
        'EngagementScore': 'High'|'Medium'|'Low',
        'NextBestActions': 'string'
    },
    'InvolvementType': 'For Visibility Only'|'Co-Sell',
    'InvolvementTypeChangeReason': 'Expansion Opportunity'|'Change in Deal Information'|'Customer Requested'|'Technical Complexity'|'Risk Mitigation',
    'LifeCycle': {
        'ClosedLostReason': 'Administrative'|'Business Associate Agreement'|'Company Acquired/Dissolved'|'Competitive Offering'|'Customer Data Requirement'|'Customer Deficiency'|'Customer Experience'|'Delay / Cancellation of Project'|'Duplicate'|'Duplicate Opportunity'|'Executive Blocker'|'Failed Vetting'|'Feature Limitation'|'Financial/Commercial'|'Insufficient Amazon Value'|'Insufficient AWS Value'|'International Constraints'|'Legal / Tax / Regulatory'|'Legal Terms and Conditions'|'Lost to Competitor'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - Other'|'Lost to Competitor - Rackspace'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'No Customer Reference'|'No Integration Resources'|'No Opportunity'|'No Perceived Value of MP'|'No Response'|'Not Committed to AWS'|'No Update'|'On Premises Deployment'|'Other'|'Other (Details in Description)'|'Partner Gap'|'Past Due'|'People/Relationship/Governance'|'Platform Technology Limitation'|'Preference for Competitor'|'Price'|'Product/Technology'|'Product Not on AWS'|'Security / Compliance'|'Self-Service'|'Technical Limitations'|'Term Sheet Impasse',
        'NextSteps': 'string',
        'NextStepsHistory': [
            {
                'Time': datetime(2015, 1, 1),
                'Value': 'string'
            },
        ],
        'Stage': 'Not Started'|'In Progress'|'Prospect'|'Engaged'|'Identified'|'Qualify'|'Research'|'Seller Engaged'|'Evaluating'|'Seller Registered'|'Term Sheet Negotiation'|'Contract Negotiation'|'Onboarding'|'Building Integration'|'Qualified'|'On-hold'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Deferred to Partner'|'Closed Lost'|'Completed'|'Closed Incomplete',
        'TargetCloseDate': 'string'
    },
    'OpportunityTeam': [
        {
            'BusinessTitle': 'AWSSalesRep'|'AWSAccountOwner'|'WWPSPDM'|'PDM'|'PSM'|'ISVSM',
            'Email': 'string',
            'FirstName': 'string',
            'LastName': 'string'
        },
    ],
    'Origin': 'AWS Referral'|'Partner Referral',
    'Project': {
        'ExpectedCustomerSpend': [
            {
                'Amount': 'string',
                'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                'Frequency': 'Monthly',
                'TargetCompany': 'string'
            },
        ]
    },
    'RelatedEntityIds': {
        'AwsProducts': [
            'string',
        ],
        'Solutions': [
            'string',
        ]
    },
    'RelatedOpportunityId': 'string',
    'Visibility': 'Full'|'Limited'
}

Response Structure

• (dict) --

  • Catalog (string) --

    Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

  • Customer (dict) --

    Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other key customer data. These details help partners understand the business context of the opportunity.

    • Contacts (list) --

      Provides a list of customer contacts involved in the opportunity. These contacts may include decision-makers, influencers, and other key stakeholders within the customer's organization.

      • (dict) --

        An object that contains a Customer Partner's contact details.

        • BusinessTitle (string) --

          The partner contact's title (job title or role) associated with the Opportunity.

        • Email (string) --

          The contact's email address associated with the Opportunity.

        • FirstName (string) --

          The contact's first name associated with the Opportunity.

        • LastName (string) --

          The contact's last name associated with the Opportunity.

        • Phone (string) --

          The contact's phone number associated with the Opportunity.

  • Insights (dict) --

    Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

    • EngagementScore (string) --

      Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.

    • NextBestActions (string) --

      Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.

  • InvolvementType (string) --

    Specifies the type of involvement AWS has in the opportunity, such as direct co-sell or advisory support. This field helps partners understand the role AWS will play in advancing the opportunity.

  • InvolvementTypeChangeReason (string) --

    Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

  • LifeCycle (dict) --

    Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

    • ClosedLostReason (string) --

      Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.

    • NextSteps (string) --

      Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS's guidance and the current stage of the opportunity.

    • NextStepsHistory (list) --

      Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.

      • (dict) --

        Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.

        • Time (datetime) --

          Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.

        • Value (string) --

          Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.

    • Stage (string) --

      Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.

    • TargetCloseDate (string) --

      Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.

  • OpportunityTeam (list) --

    Details the AWS Opportunity team, including key members involved in the opportunity. This information helps partners know who from AWS is engaged and their roles in the opportunity.

    • (dict) --

      Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.

      • BusinessTitle (string) --

        Specifies the Amazon Web Services team member's business title and indicates their organizational role.

      • Email (string) --

        Provides the Amazon Web Services team member's email address.

      • FirstName (string) --

        Provides the Amazon Web Services team member's first name.

      • LastName (string) --

        Provides the Amazon Web Services team member's last name.

  • Origin (string) --

    Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

  • Project (dict) --

    Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

    • ExpectedCustomerSpend (list) --

      Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.

      • (dict) --

        Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

        • Amount (string) --

          Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

        • CurrencyCode (string) --

          Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

        • Frequency (string) --

          Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

        • TargetCompany (string) --

          Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

  • RelatedEntityIds (dict) --

    Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

    • AwsProducts (list) --

      Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.

      • (string) --

    • Solutions (list) --

      Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.

      • (string) --

  • RelatedOpportunityId (string) --

    Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

  • Visibility (string) --

    Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes key aspects such as the customer, project details, and lifecycle information related to the engagement.

See also: AWS API Documentation

Request Syntax

client.get_engagement_invitation(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

type Identifier:

string

param Identifier:

[REQUIRED]

Specifies the unique identifier for the engagement invitation being retrieved.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Catalog': 'string',
    'EngagementTitle': 'string',
    'ExpirationDate': datetime(2015, 1, 1),
    'Id': 'string',
    'InvitationDate': datetime(2015, 1, 1),
    'Payload': {
        'OpportunityInvitation': {
            'Customer': {
                'CompanyName': 'string',
                'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
                'WebsiteUrl': 'string'
            },
            'Project': {
                'BusinessProblem': 'string',
                'ExpectedCustomerSpend': [
                    {
                        'Amount': 'string',
                        'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                        'Frequency': 'Monthly',
                        'TargetCompany': 'string'
                    },
                ],
                'TargetCompletionDate': 'string',
                'Title': 'string'
            },
            'ReceiverResponsibilities': [
                'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
            ],
            'SenderContacts': [
                {
                    'BusinessTitle': 'string',
                    'Email': 'string',
                    'FirstName': 'string',
                    'LastName': 'string',
                    'Phone': 'string'
                },
            ]
        }
    },
    'PayloadType': 'OpportunityInvitation',
    'Receiver': {
        'Account': {
            'Alias': 'string',
            'AwsAccountId': 'string'
        }
    },
    'RejectionReason': 'string',
    'SenderAwsAccountId': 'string',
    'SenderCompanyName': 'string',
    'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED'
}

Response Structure

• (dict) --

  • Arn (string) --

    The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.

  • Catalog (string) --

    Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

  • EngagementTitle (string) --

    The title of the engagement invitation, summarizing the purpose or key objectives of the opportunity shared by AWS.

  • ExpirationDate (datetime) --

    Indicates the date on which the engagement invitation will expire if not accepted by the partner.

  • Id (string) --

    Unique identifier assigned to the engagement invitation being retrieved.

  • InvitationDate (datetime) --

    The date when the engagement invitation was sent to the partner.

  • Payload (dict) --

    Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

    • OpportunityInvitation (dict) --

      Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.

      • Customer (dict) --

        Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.

        • CompanyName (string) --

          Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.

        • CountryCode (string) --

          Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.

        • Industry (string) --

          Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.

        • WebsiteUrl (string) --

          Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.

      • Project (dict) --

        Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.

        • BusinessProblem (string) --

          Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.

        • ExpectedCustomerSpend (list) --

          Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.

          • (dict) --

            Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

            • Amount (string) --

              Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

            • CurrencyCode (string) --

              Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

            • Frequency (string) --

              Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

            • TargetCompany (string) --

              Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

        • TargetCompletionDate (string) --

          Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.

        • Title (string) --

          Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.

      • ReceiverResponsibilities (list) --

        Outlines the responsibilities or expectations of the receiver in the context of the invitation.

        • (string) --

      • SenderContacts (list) --

        Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are key stakeholders for the opportunity.

        • (dict) --

          An object that contains the details of the sender-provided contact person for the EngagementInvitation.

          • BusinessTitle (string) --

            The sender-provided contact's title (job title or role) associated with the EngagementInvitation.

          • Email (string) --

            The sender-provided contact's email address associated with the EngagementInvitation.

          • FirstName (string) --

            The sender-provided contact's last name associated with the EngagementInvitation.

          • LastName (string) --

            The sender-provided contact's first name associated with the EngagementInvitation.

          • Phone (string) --

            The sender-provided contact's phone number associated with the EngagementInvitation.

  • PayloadType (string) --

    The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

  • Receiver (dict) --

    Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

    • Account (dict) --

      Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.

      • Alias (string) --

        Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.

      • AwsAccountId (string) --

        Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.

  • RejectionReason (string) --

    If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

  • SenderAwsAccountId (string) --

    Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

  • SenderCompanyName (string) --

    The name of the AWS organization or team that sent the engagement invitation.

  • Status (string) --

    The current status of the engagement invitation (e.g., Accepted, Pending, or Rejected).

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

See also: AWS API Documentation

Request Syntax

client.list_engagement_invitations(
    Catalog='string',
    MaxResults=123,
    NextToken='string',
    ParticipantType='RECEIVER',
    PayloadType=[
        'OpportunityInvitation',
    ],
    Sort={
        'SortBy': 'InvitationDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

type MaxResults:

integer

param MaxResults:

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

type NextToken:

string

param NextToken:

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

type ParticipantType:

string

param ParticipantType:

[REQUIRED]

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

type PayloadType:

list

param PayloadType:

Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

• (string) --

type Sort:

dict

param Sort:

Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

• SortBy (string) -- [REQUIRED]

  Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.

• SortOrder (string) -- [REQUIRED]

  Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).

rtype:

dict

returns:

Response Syntax

{
    'EngagementInvitationSummaries': [
        {
            'Arn': 'string',
            'Catalog': 'string',
            'EngagementTitle': 'string',
            'ExpirationDate': datetime(2015, 1, 1),
            'Id': 'string',
            'InvitationDate': datetime(2015, 1, 1),
            'PayloadType': 'OpportunityInvitation',
            'Receiver': {
                'Account': {
                    'Alias': 'string',
                    'AwsAccountId': 'string'
                }
            },
            'SenderAwsAccountId': 'string',
            'SenderCompanyName': 'string',
            'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • EngagementInvitationSummaries (list) --

    An array containing summaries of engagement invitations. Each summary includes key information such as the invitation title, invitation date, and the current status of the invitation.

    • (dict) --

      Provides a summarized view of the Engagement Invitation, including key details like the identifier, status, and sender information. This summary helps partners track and manage AWS-originated opportunities.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.

      • Catalog (string) --

        Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.

      • EngagementTitle (string) --

        Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.

      • ExpirationDate (datetime) --

        Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will no longer be available for the partner to engage.

      • Id (string) --

        Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.

      • InvitationDate (datetime) --

        Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.

      • PayloadType (string) --

        Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.

      • Receiver (dict) --

        Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.

        • Account (dict) --

          Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.

          • Alias (string) --

            Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.

          • AwsAccountId (string) --

            Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.

      • SenderAwsAccountId (string) --

        Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.

      • SenderCompanyName (string) --

        Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.

      • Status (string) --

        Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.

  • NextToken (string) --

    A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.

See also: AWS API Documentation

Request Syntax

client.list_solutions(
    Catalog='string',
    Category=[
        'string',
    ],
    Identifier=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Sort={
        'SortBy': 'Identifier'|'Name'|'Status'|'Category'|'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    Status=[
        'Active'|'Inactive'|'Draft',
    ]
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

type Category:

list

param Category:

Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

• (string) --

type Identifier:

list

param Identifier:

Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

• (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

type NextToken:

string

param NextToken:

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.

type Sort:

dict

param Sort:

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

• SortBy (string) -- [REQUIRED]

  Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

• SortOrder (string) -- [REQUIRED]

  Specifies the sorting order, either Ascending or Descending. The default is Descending.

type Status:

list

param Status:

Filters the solutions based on their status. This filter helps retrieve solutions with statuses such as Active, Inactive, or Pending Approval, allowing partners to manage their solution portfolios effectively.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'SolutionSummaries': [
        {
            'Catalog': 'string',
            'Category': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Id': 'string',
            'Name': 'string',
            'Status': 'Active'|'Inactive'|'Draft'
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (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.

  • SolutionSummaries (list) --

    An array with minimal details for solutions matching the request criteria.

    • (dict) --

      Specifies minimal information for the solution offered to solve the customer's business problem.

      • Catalog (string) --

        Specifies the catalog in which the solution is hosted, either AWS or Sandbox. This helps partners differentiate between live solutions and those in testing environments.

      • Category (string) --

        Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.

      • CreatedDate (datetime) --

        Indicates the solution creation date. This is useful to track and audit.

      • Id (string) --

        Enables the association of solutions (offerings) to opportunities.

      • Name (string) --

        Specifies the solution name.

      • Status (string) --

        Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

See also: AWS API Documentation

Request Syntax

client.get_opportunity(
    Catalog='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

type Identifier:

string

param Identifier:

[REQUIRED]

Read-only, system generated Opportunity unique identifier.

rtype:

dict

returns:

Response Syntax

{
    'Catalog': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'Customer': {
        'Account': {
            'Address': {
                'City': 'string',
                'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                'PostalCode': 'string',
                'StateOrRegion': 'string',
                'StreetAddress': 'string'
            },
            'AwsAccountId': 'string',
            'CompanyName': 'string',
            'Duns': 'string',
            'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
            'OtherIndustry': 'string',
            'WebsiteUrl': 'string'
        },
        'Contacts': [
            {
                'BusinessTitle': 'string',
                'Email': 'string',
                'FirstName': 'string',
                'LastName': 'string',
                'Phone': 'string'
            },
        ]
    },
    'Id': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'LifeCycle': {
        'ClosedLostReason': 'Customer Deficiency'|'Delay / Cancellation of Project'|'Legal / Tax / Regulatory'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'Lost to Competitor - Other'|'No Opportunity'|'On Premises Deployment'|'Partner Gap'|'Price'|'Security / Compliance'|'Technical Limitations'|'Customer Experience'|'Other'|'People/Relationship/Governance'|'Product/Technology'|'Financial/Commercial',
        'NextSteps': 'string',
        'NextStepsHistory': [
            {
                'Time': datetime(2015, 1, 1),
                'Value': 'string'
            },
        ],
        'ReviewComments': 'string',
        'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
        'ReviewStatusReason': 'string',
        'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
        'TargetCloseDate': 'string'
    },
    'Marketing': {
        'AwsFundingUsed': 'Yes'|'No',
        'CampaignName': 'string',
        'Channels': [
            'AWS Marketing Central'|'Content Syndication'|'Display'|'Email'|'Live Event'|'Out Of Home (OOH)'|'Print'|'Search'|'Social'|'Telemarketing'|'TV'|'Video'|'Virtual Event',
        ],
        'Source': 'Marketing Activity'|'None',
        'UseCases': [
            'string',
        ]
    },
    'NationalSecurity': 'Yes'|'No',
    'OpportunityTeam': [
        {
            'BusinessTitle': 'string',
            'Email': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'Phone': 'string'
        },
    ],
    'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
    'PartnerOpportunityIdentifier': 'string',
    'PrimaryNeedsFromAws': [
        'Co-Sell - Architectural Validation'|'Co-Sell - Business Presentation'|'Co-Sell - Competitive Information'|'Co-Sell - Pricing Assistance'|'Co-Sell - Technical Consultation'|'Co-Sell - Total Cost of Ownership Evaluation'|'Co-Sell - Deal Support'|'Co-Sell - Support for Public Tender / RFx',
    ],
    'Project': {
        'AdditionalComments': 'string',
        'ApnPrograms': [
            'string',
        ],
        'CompetitorName': 'Oracle Cloud'|'On-Prem'|'Co-location'|'Akamai'|'AliCloud'|'Google Cloud Platform'|'IBM Softlayer'|'Microsoft Azure'|'Other- Cost Optimization'|'No Competition'|'*Other',
        'CustomerBusinessProblem': 'string',
        'CustomerUseCase': 'string',
        'DeliveryModels': [
            'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
        ],
        'ExpectedCustomerSpend': [
            {
                'Amount': 'string',
                'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                'Frequency': 'Monthly',
                'TargetCompany': 'string'
            },
        ],
        'OtherCompetitorNames': 'string',
        'OtherSolutionDescription': 'string',
        'RelatedOpportunityIdentifier': 'string',
        'SalesActivities': [
            'Initialized discussions with customer'|'Customer has shown interest in solution'|'Conducted POC / Demo'|'In evaluation / planning stage'|'Agreed on solution to Business Problem'|'Completed Action Plan'|'Finalized Deployment Need'|'SOW Signed',
        ],
        'Title': 'string'
    },
    'RelatedEntityIdentifiers': {
        'AwsMarketplaceOffers': [
            'string',
        ],
        'AwsProducts': [
            'string',
        ],
        'Solutions': [
            'string',
        ]
    },
    'SoftwareRevenue': {
        'DeliveryModel': 'Contract'|'Pay-as-you-go'|'Subscription',
        'EffectiveDate': 'string',
        'ExpirationDate': 'string',
        'Value': {
            'Amount': 'string',
            'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
        }
    }
}

Response Structure

• (dict) --

  • 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 opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

  • CreatedDate (datetime) --

    DateTime when the Opportunity was last created.

  • Customer (dict) --

    Specifies details of the customer associated with the Opportunity.

    • Account (dict) --

      An object that contains the customer's account details.

      • Address (dict) --

        Specifies the end Customer's address details associated with the Opportunity.

        • City (string) --

          Specifies the end Customer's city associated with the Opportunity.

        • CountryCode (string) --

          Specifies the end Customer's country associated with the Opportunity.

        • PostalCode (string) --

          Specifies the end Customer's postal code associated with the Opportunity.

        • StateOrRegion (string) --

          Specifies the end Customer's state or region associated with the Opportunity.

          Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

        • StreetAddress (string) --

          Specifies the end Customer's street address associated with the Opportunity.

      • AwsAccountId (string) --

        Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

      • CompanyName (string) --

        Specifies the end Customer's company name associated with the Opportunity.

      • Duns (string) --

        Indicates the Customer DUNS number, if available.

      • Industry (string) --

        Specifies the industry the end Customer belongs to that's associated with the Opportunity . It refers to the category or sector where the customer's business operates. This is a required field.

      • OtherIndustry (string) --

        Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

      • WebsiteUrl (string) --

        Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.

    • Contacts (list) --

      Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.

      • (dict) --

        An object that contains a Customer Partner's contact details.

        • BusinessTitle (string) --

          The partner contact's title (job title or role) associated with the Opportunity.

        • Email (string) --

          The contact's email address associated with the Opportunity.

        • FirstName (string) --

          The contact's first name associated with the Opportunity.

        • LastName (string) --

          The contact's last name associated with the Opportunity.

        • Phone (string) --

          The contact's phone number associated with the Opportunity.

  • Id (string) --

    Read-only, system generated Opportunity unique identifier.

  • LastModifiedDate (datetime) --

    DateTime when the opportunity was last modified.

  • LifeCycle (dict) --

    An object that contains lifecycle details for the Opportunity.

    • ClosedLostReason (string) --

      Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

      • Customer Deficiency: The customer lacked necessary resources or capabilities.

      • Delay/Cancellation of Project: The project was delayed or canceled.

      • Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.

      • Lost to Competitor - Google: The opportunity was lost to Google.

      • Lost to Competitor - Microsoft: The opportunity was lost to Microsoft.

      • Lost to Competitor - SoftLayer: The opportunity was lost to SoftLayer.

      • Lost to Competitor - VMWare: The opportunity was lost to VMWare.

      • Lost to Competitor - Other: The opportunity was lost to a competitor not listed above.

      • No Opportunity: There was no opportunity to pursue.

      • On Premises Deployment: The customer chose an on-premises solution.

      • Partner Gap: The partner lacked necessary resources or capabilities.

      • Price: The price was not competitive or acceptable to the customer.

      • Security/Compliance: Security or compliance issues prevented progress.

      • Technical Limitations: Technical limitations prevented progress.

      • Customer Experience: Issues related to the customer's experience impacted the decision.

      • Other: Any reason not covered by the other values.

      • People/Relationship/Governance: Issues related to people, relationships, or governance.

      • Product/Technology: Issues related to the product or technology.

      • Financial/Commercial: Financial or commercial issues impacted the decision.

    • NextSteps (string) --

      Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

    • NextStepsHistory (list) --

      Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

      • (dict) --

        Read-only; shows the last 50 values and change dates for the NextSteps field.

        • Time (datetime) --

          Indicates the step execution time.

        • Value (string) --

          Indicates the step's execution details.

    • ReviewComments (string) --

      Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.

    • ReviewStatus (string) --

      Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

      • Pending Submission: Not submitted for validation (editable).

      • Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).

      • In Review: Amazon Web Services is validating (read-only).

      • Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity, and ensure all required changes are made. Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:

        • Customer.Account.Address.City

        • Customer.Account.Address.CountryCode

        • Customer.Account.Address.PostalCode

        • Customer.Account.Address.StateOrRegion

        • Customer.Account.Address.StreetAddress

        • Customer.Account.WebsiteUrl

        • LifeCycle.TargetCloseDate

        • Project.ExpectedMonthlyAWSRevenue.Amount

        • Project.ExpectedMonthlyAWSRevenue.CurrencyCode

        • Project.CustomerBusinessProblem

        • PartnerOpportunityIdentifier

      After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.

      • Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).

      • Rejected: Disqualified (read-only).

    • ReviewStatusReason (string) --

      Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

    • Stage (string) --

      Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

      The descriptions of each sales stage are:

      • Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).

      • Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.

      • Technical Validation: All parties understand the implementation plan.

      • Business Validation: Pricing was proposed, and all parties agree to the steps to close.

      • Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.

      • Launched: The workload is complete, and Amazon Web Services has started billing.

      • Closed Lost: The opportunity is lost, and there are no steps to move forward.

    • TargetCloseDate (string) --

      Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

      Ensure the Target Close Date isn't in the past.

  • Marketing (dict) --

    An object that contains marketing details for the Opportunity.

    • AwsFundingUsed (string) --

      Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

    • CampaignName (string) --

      Specifies the Opportunity's unique marketing campaign name. The Amazon Web Services campaign name serves as a reference to specific marketing initiatives, promotions, or activities related to the Opportunity. This field captures the identifier used to track and categorize the Opportunity within Amazon Web Services's marketing campaigns. If you don't have a campaign name, reach out to your Amazon Web Services point of contact to obtain one.

    • Channels (list) --

      Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

      • (string) --

    • Source (string) --

      Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.

    • UseCases (list) --

      Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

      Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

      • (string) --

  • NationalSecurity (string) --

    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.

  • OpportunityTeam (list) --

    Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

    • (dict) --

      An object that contains a Customer Partner's contact details.

      • BusinessTitle (string) --

        The partner contact's title (job title or role) associated with the Opportunity.

      • Email (string) --

        The contact's email address associated with the Opportunity.

      • FirstName (string) --

        The contact's first name associated with the Opportunity.

      • LastName (string) --

        The contact's last name associated with the Opportunity.

      • Phone (string) --

        The contact's phone number associated with the Opportunity.

  • OpportunityType (string) --

    Specifies the opportunity type as 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.

  • PartnerOpportunityIdentifier (string) --

    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 sent back to the partner.

  • PrimaryNeedsFromAws (list) --

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

    Valid values:

    • Co-Sell - 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.

    • Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

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

    • Co-Sell - 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).

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

    • Co-Sell - 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.

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

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

    • Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request co-selling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

    • (string) --

  • Project (dict) --

    An object that contains project details summary for the Opportunity.

    • AdditionalComments (string) --

      Captures additional comments or information for the Opportunity that weren't captured in other fields.

    • ApnPrograms (list) --

      Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

      Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

      • (string) --

    • CompetitorName (string) --

      Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

    • CustomerBusinessProblem (string) --

      Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a clear and concise narrative that outlines the specific business challenge or issue the customer has. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

    • CustomerUseCase (string) --

      Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

      Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse / Data Integration / ETL / Data Lake / BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing / End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration / Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

    • DeliveryModels (list) --

      Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

      Options' descriptions from the Delivery Model field are:

      • SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.

      • BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.

      • Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).

      • Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).

      • Resell: Amazon Web Services accounts and billing management for your customers.

      • Other: Delivery model not described above.

      • (string) --

    • ExpectedCustomerSpend (list) --

      Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.

      • (dict) --

        Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

        • Amount (string) --

          Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

        • CurrencyCode (string) --

          Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

        • Frequency (string) --

          Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

        • TargetCompany (string) --

          Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

    • OtherCompetitorNames (string) --

      Only allowed when CompetitorNames has Other selected.

    • OtherSolutionDescription (string) --

      Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

    • RelatedOpportunityIdentifier (string) --

      Specifies the current opportunity's parent opportunity identifier.

    • SalesActivities (list) --

      Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

      Valid values:

      • Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.

      • Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.

      • Conducted POC / Demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.

      • In evaluation / planning stage: The customer is evaluating the solution and planning potential implementation.

      • Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.

      • Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.

      • Finalized Deployment Need: Both parties agree with and finalized the deployment needs.

      • SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.

      • (string) --

    • Title (string) --

      Specifies the Opportunity's title or name.

  • RelatedEntityIdentifiers (dict) --

    Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

    • AwsMarketplaceOffers (list) --

      Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: "offers": ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].

      Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.

      • (string) --

    • AwsProducts (list) --

      Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, "AWSProducts" : ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].

      Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.

      • (string) --

    • Solutions (list) --

      Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.

      If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. However, once the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.

      By associating the relevant solutions with the opportunity, you can clearly communicate the offerings that are being considered or implemented to address the customer's business problem.

      • (string) --

  • SoftwareRevenue (dict) --

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

    • DeliveryModel (string) --

      Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

    • EffectiveDate (string) --

      Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

    • ExpirationDate (string) --

      Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.

    • Value (dict) --

      Specifies the payment value (amount and currency).

      • Amount (string) --

        Specifies the payment amount.

      • CurrencyCode (string) --

        Specifies the payment currency.

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision-making. You can associate an opportunity with the following types of entities:

• Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address specific business challenges or achieve particular goals using Amazon Web Services services.

• Amazon Web Services Product: Amazon Web Services offers a wide range of products and services designed to provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, refer to Amazon Web Services products.

• Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, refer to Private offers in Amazon Web Services Marketplace.

To obtain identifiers for these entities, use the following methods:

• Solution: Use the ListSolutions operation.

• AWS products: For the latest list of Amazon Web Services products, refer to the Amazon Web Services products list.

• Amazon Web Services Marketplace private offer: Use the AWS Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request to the ListEntities API returns the details of the private offers available to you. For more information, refer to ListEntities.

See also: AWS API Documentation

Request Syntax

client.associate_opportunity(
    Catalog='string',
    OpportunityIdentifier='string',
    RelatedEntityIdentifier='string',
    RelatedEntityType='Solutions'|'AwsProducts'|'AwsMarketplaceOffers'
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines whichenvironment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox to test in a secure and isolated environment.

type OpportunityIdentifier:

string

param OpportunityIdentifier:

[REQUIRED]

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

type RelatedEntityIdentifier:

string

param RelatedEntityIdentifier:

[REQUIRED]

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

type RelatedEntityType:

string

param RelatedEntityType:

[REQUIRED]

Specifies the type of the related entity you're associating with the Opportunity. This helps to categorize and properly process the association.

returns:

None

This request accepts a list of filters to use to retrieve a specific subset of opportunities, as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the ListOpportunities action.

We recommend the following approach:

• Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

• When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

• Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

See also: AWS API Documentation

Request Syntax

client.list_opportunities(
    Catalog='string',
    CustomerCompanyName=[
        'string',
    ],
    Identifier=[
        'string',
    ],
    LastModifiedDate={
        'AfterLastModifiedDate': datetime(2015, 1, 1),
        'BeforeLastModifiedDate': datetime(2015, 1, 1)
    },
    LifeCycleReviewStatus=[
        'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
    ],
    LifeCycleStage=[
        'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
    ],
    MaxResults=123,
    NextToken='string',
    Sort={
        'SortBy': 'LastModifiedDate'|'Identifier'|'CustomerCompanyName',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 to test in a secure and isolated environment.

type CustomerCompanyName:

list

param CustomerCompanyName:

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.

• (string) --

type Identifier:

list

param Identifier:

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

• (string) --

type LastModifiedDate:

dict

param 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.

• AfterLastModifiedDate (datetime) --

  Specifies the date after which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified after a given timestamp.

• BeforeLastModifiedDate (datetime) --

  Specifies the date before which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified before a given timestamp.

type LifeCycleReviewStatus:

list

param LifeCycleReviewStatus:

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.

• (string) --

type LifeCycleStage:

list

param LifeCycleStage:

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.

• (string) --

type MaxResults:

integer

param MaxResults:

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

Default: 20

type NextToken:

string

param NextToken:

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.

type Sort:

dict

param Sort:

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

• SortBy (string) -- [REQUIRED]

  Field name to sort by.

• SortOrder (string) -- [REQUIRED]

  Sort order.

  Default: Descending

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'OpportunitySummaries': [
        {
            'Catalog': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'Customer': {
                'Account': {
                    'Address': {
                        'City': 'string',
                        'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                        'PostalCode': 'string',
                        'StateOrRegion': 'string'
                    },
                    'CompanyName': 'string',
                    'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
                    'OtherIndustry': 'string',
                    'WebsiteUrl': 'string'
                }
            },
            'Id': 'string',
            'LastModifiedDate': datetime(2015, 1, 1),
            'LifeCycle': {
                'ClosedLostReason': 'Customer Deficiency'|'Delay / Cancellation of Project'|'Legal / Tax / Regulatory'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'Lost to Competitor - Other'|'No Opportunity'|'On Premises Deployment'|'Partner Gap'|'Price'|'Security / Compliance'|'Technical Limitations'|'Customer Experience'|'Other'|'People/Relationship/Governance'|'Product/Technology'|'Financial/Commercial',
                'NextSteps': 'string',
                'ReviewComments': 'string',
                'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
                'ReviewStatusReason': 'string',
                'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
                'TargetCloseDate': 'string'
            },
            'OpportunityType': 'Net New Business'|'Flat Renewal'|'Expansion',
            'PartnerOpportunityIdentifier': 'string',
            'Project': {
                'DeliveryModels': [
                    'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
                ],
                'ExpectedCustomerSpend': [
                    {
                        'Amount': 'string',
                        'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                        'Frequency': 'Monthly',
                        'TargetCompany': 'string'
                    },
                ]
            }
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (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.

  • OpportunitySummaries (list) --

    An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

    • (dict) --

      An object that contains an Opportunity's subset of fields.

      • Catalog (string) --

        Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

      • CreatedDate (datetime) --

        DateTime when the Opportunity was last created.

      • Customer (dict) --

        An object that contains the Opportunity's customer details.

        • Account (dict) --

          An object that contains a customer's account details.

          • Address (dict) --

            Specifies the end Customer's address details associated with the Opportunity.

            • City (string) --

              Specifies the end Customer's city associated with the Opportunity.

            • CountryCode (string) --

              Specifies the end Customer's country associated with the Opportunity.

            • PostalCode (string) --

              Specifies the end Customer's postal code associated with the Opportunity.

            • StateOrRegion (string) --

              Specifies the end Customer's state or region associated with the Opportunity.

              Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

          • CompanyName (string) --

            Specifies the end Customer's company name associated with the Opportunity.

          • Industry (string) --

            Specifies which industry the end Customer belongs to associated with the Opportunity . It refers to the category or sector that the customer's business operates in.

            To submit a value outside the picklist, use Other.

            Conditionally mandatory if Other is selected for Industry Vertical in LOVs.

          • OtherIndustry (string) --

            Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.

          • WebsiteUrl (string) --

            Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system.

      • Id (string) --

        Read-only, system-generated Opportunity unique identifier.

      • LastModifiedDate (datetime) --

        DateTime when the Opportunity was last modified.

      • LifeCycle (dict) --

        An object that contains the Opportunity's lifecycle details.

        • ClosedLostReason (string) --

          Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.

        • NextSteps (string) --

          Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

        • ReviewComments (string) --

          Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.

        • ReviewStatus (string) --

          Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:

          • Pending Submission: Not submitted for validation (editable).

          • Submitted: Submitted for validation and not yet Amazon Web Services reviewed (read-only).

          • In Review: Undergoing Amazon Web Services validation (read-only).

          • Action Required: Address any issues Amazon Web Services highlights. Use the UpdateOpportunity API action to update the opportunity, and ensure you make all required changes. Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:

            • Customer.Account.Address.City

            • Customer.Account.Address.CountryCode

            • Customer.Account.Address.PostalCode

            • Customer.Account.Address.StateOrRegion

            • Customer.Account.Address.StreetAddress

            • Customer.Account.WebsiteUrl

            • LifeCycle.TargetCloseDate

            • Project.ExpectedCustomerSpend.Amount

            • Project.ExpectedCustomerSpend.CurrencyCode

            • Project.CustomerBusinessProblem

            • PartnerOpportunityIdentifier

          After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.

          • Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).

          • Rejected: Disqualified (read-only).

        • ReviewStatusReason (string) --

          Indicates the reason a specific decision was taken during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provides clarity for why an opportunity was disqualified or required further action.

        • Stage (string) --

          Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

          The descriptions of each sales stage are:

          • Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).

          • Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.

          • Technical Validation: All parties understand the implementation plan.

          • Business Validation: Pricing has been proposed, Pricing was proposed, and all parties agree to the steps to close.

          • Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.

          • Launched: The workload is complete, and Amazon Web Services has started billing.

          • Closed Lost: The opportunity is lost, and there are no steps to move forward.

        • TargetCloseDate (string) --

          Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

          Ensure the Target Close Date isn't in the past.

      • OpportunityType (string) --

        Specifies 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.

      • PartnerOpportunityIdentifier (string) --

        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 sent back to the partner. It allows partners to link an opportunity to their CRM.

      • Project (dict) --

        An object that contains the Opportunity's project details summary.

        • DeliveryModels (list) --

          Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.

          Options' descriptions from the Delivery Model field are:

          • SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.

          • BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.

          • Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).

          • Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).

          • Resell: Amazon Web Services accounts and billing management for your customers.

          • Other: Delivery model not described above.

          • (string) --

        • ExpectedCustomerSpend (list) --

          Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.

          • (dict) --

            Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

            • Amount (string) --

              Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

            • CurrencyCode (string) --

              Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

            • Frequency (string) --

              Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

            • TargetCompany (string) --

              Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.

This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

See also: AWS API Documentation

Request Syntax

client.assign_opportunity(
    Assignee={
        'BusinessTitle': 'string',
        'Email': 'string',
        'FirstName': 'string',
        'LastName': 'string'
    },
    Catalog='string',
    Identifier='string'
)

type Assignee:

dict

param Assignee:

[REQUIRED]

Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.

• BusinessTitle (string) -- [REQUIRED]

  Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization.

• Email (string) -- [REQUIRED]

  Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.

• FirstName (string) -- [REQUIRED]

  Specifies the first name of the assignee managing the opportunity.

• LastName (string) -- [REQUIRED]

  Specifies the last name of the assignee managing the opportunity.

type Catalog:

string

param Catalog:

[REQUIRED]

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 assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox to test in a secure and isolated environment.

type Identifier:

string

param Identifier:

[REQUIRED]

Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

returns:

None

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

See also: AWS API Documentation

Request Syntax

client.start_engagement_from_opportunity_task(
    AwsSubmission={
        'InvolvementType': 'For Visibility Only'|'Co-Sell',
        'Visibility': 'Full'|'Limited'
    },
    Catalog='string',
    ClientToken='string',
    Identifier='string'
)

type AwsSubmission:

dict

param AwsSubmission:

[REQUIRED]

Indicates the level of AWS involvement in the opportunity. This field helps track AWS's role and participation throughout the engagement, such as providing technical support, deal assistance, or sales support.

• InvolvementType (string) -- [REQUIRED]

  Specifies the type of AWS involvement in the opportunity, such as co-selling, deal support, or technical consultation. This helps categorize the nature of AWS's participation.

• Visibility (string) --

  Determines who can view AWS's involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

type ClientToken:

string

param ClientToken:

[REQUIRED]

A unique token provided by the client to ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

This field is autopopulated if not provided.

type Identifier:

string

param Identifier:

[REQUIRED]

The unique identifier of the opportunity from which the engagement task is to be initiated. This ensures the task is applied to the correct opportunity.

rtype:

dict

returns:

Response Syntax

{
    'Message': 'string',
    'OpportunityId': 'string',
    'ReasonCode': 'InvitationAccessDenied'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'EngagementValidationFailed'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict',
    'StartTime': datetime(2015, 1, 1),
    'TaskArn': 'string',
    'TaskId': 'string',
    'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
}

Response Structure

• (dict) --

  • Message (string) --

    If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

  • OpportunityId (string) --

    Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

  • ReasonCode (string) --

    Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.

  • StartTime (datetime) --

    The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

  • TaskArn (string) --

    The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

  • TaskId (string) --

    The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

  • TaskStatus (string) --

    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

See also: AWS API Documentation

Request Syntax

client.update_opportunity(
    Catalog='string',
    Customer={
        'Account': {
            'Address': {
                'City': 'string',
                'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                'PostalCode': 'string',
                'StateOrRegion': 'string',
                'StreetAddress': 'string'
            },
            'AwsAccountId': 'string',
            'CompanyName': 'string',
            'Duns': 'string',
            'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
            'OtherIndustry': 'string',
            'WebsiteUrl': 'string'
        },
        'Contacts': [
            {
                'BusinessTitle': 'string',
                'Email': 'string',
                'FirstName': 'string',
                'LastName': 'string',
                'Phone': 'string'
            },
        ]
    },
    Identifier='string',
    LastModifiedDate=datetime(2015, 1, 1),
    LifeCycle={
        'ClosedLostReason': 'Customer Deficiency'|'Delay / Cancellation of Project'|'Legal / Tax / Regulatory'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'Lost to Competitor - Other'|'No Opportunity'|'On Premises Deployment'|'Partner Gap'|'Price'|'Security / Compliance'|'Technical Limitations'|'Customer Experience'|'Other'|'People/Relationship/Governance'|'Product/Technology'|'Financial/Commercial',
        'NextSteps': 'string',
        'NextStepsHistory': [
            {
                'Time': datetime(2015, 1, 1),
                'Value': 'string'
            },
        ],
        'ReviewComments': 'string',
        'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
        'ReviewStatusReason': 'string',
        'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
        'TargetCloseDate': 'string'
    },
    Marketing={
        'AwsFundingUsed': 'Yes'|'No',
        'CampaignName': 'string',
        'Channels': [
            'AWS Marketing Central'|'Content Syndication'|'Display'|'Email'|'Live Event'|'Out Of Home (OOH)'|'Print'|'Search'|'Social'|'Telemarketing'|'TV'|'Video'|'Virtual Event',
        ],
        'Source': 'Marketing Activity'|'None',
        'UseCases': [
            'string',
        ]
    },
    NationalSecurity='Yes'|'No',
    OpportunityType='Net New Business'|'Flat Renewal'|'Expansion',
    PartnerOpportunityIdentifier='string',
    PrimaryNeedsFromAws=[
        'Co-Sell - Architectural Validation'|'Co-Sell - Business Presentation'|'Co-Sell - Competitive Information'|'Co-Sell - Pricing Assistance'|'Co-Sell - Technical Consultation'|'Co-Sell - Total Cost of Ownership Evaluation'|'Co-Sell - Deal Support'|'Co-Sell - Support for Public Tender / RFx',
    ],
    Project={
        'AdditionalComments': 'string',
        'ApnPrograms': [
            'string',
        ],
        'CompetitorName': 'Oracle Cloud'|'On-Prem'|'Co-location'|'Akamai'|'AliCloud'|'Google Cloud Platform'|'IBM Softlayer'|'Microsoft Azure'|'Other- Cost Optimization'|'No Competition'|'*Other',
        'CustomerBusinessProblem': 'string',
        'CustomerUseCase': 'string',
        'DeliveryModels': [
            'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
        ],
        'ExpectedCustomerSpend': [
            {
                'Amount': 'string',
                'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                'Frequency': 'Monthly',
                'TargetCompany': 'string'
            },
        ],
        'OtherCompetitorNames': 'string',
        'OtherSolutionDescription': 'string',
        'RelatedOpportunityIdentifier': 'string',
        'SalesActivities': [
            'Initialized discussions with customer'|'Customer has shown interest in solution'|'Conducted POC / Demo'|'In evaluation / planning stage'|'Agreed on solution to Business Problem'|'Completed Action Plan'|'Finalized Deployment Need'|'SOW Signed',
        ],
        'Title': 'string'
    },
    SoftwareRevenue={
        'DeliveryModel': 'Contract'|'Pay-as-you-go'|'Subscription',
        'EffectiveDate': 'string',
        'ExpirationDate': 'string',
        'Value': {
            'Amount': 'string',
            'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
        }
    }
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 updated in. Use AWS to update real opportunities in the production environment, and Sandbox to test in a secure and isolated environment. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

type Customer:

dict

param Customer:

Specifies details of the customer associated with the Opportunity .

• Account (dict) --

  An object that contains the customer's account details.

  • Address (dict) --

    Specifies the end Customer's address details associated with the Opportunity.

    • City (string) --

      Specifies the end Customer's city associated with the Opportunity.

    • CountryCode (string) --

      Specifies the end Customer's country associated with the Opportunity.

    • PostalCode (string) --

      Specifies the end Customer's postal code associated with the Opportunity.

    • StateOrRegion (string) --

      Specifies the end Customer's state or region associated with the Opportunity.

      Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

    • StreetAddress (string) --

      Specifies the end Customer's street address associated with the Opportunity.

  • AwsAccountId (string) --

    Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

  • CompanyName (string) -- [REQUIRED]

    Specifies the end Customer's company name associated with the Opportunity.

  • Duns (string) --

    Indicates the Customer DUNS number, if available.

  • Industry (string) --

    Specifies the industry the end Customer belongs to that's associated with the Opportunity . It refers to the category or sector where the customer's business operates. This is a required field.

  • OtherIndustry (string) --

    Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

  • WebsiteUrl (string) --

    Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.

• Contacts (list) --

  Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.

  • (dict) --

    An object that contains a Customer Partner's contact details.

    • BusinessTitle (string) --

      The partner contact's title (job title or role) associated with the Opportunity.

    • Email (string) --

      The contact's email address associated with the Opportunity.

    • FirstName (string) --

      The contact's first name associated with the Opportunity.

    • LastName (string) --

      The contact's last name associated with the Opportunity.

    • Phone (string) --

      The contact's phone number associated with the Opportunity.

type Identifier:

string

param Identifier:

[REQUIRED]

Read-only, system generated Opportunity unique identifier.

type LastModifiedDate:

datetime

param LastModifiedDate:

[REQUIRED]

DateTime when the opportunity was last modified.

type LifeCycle:

dict

param LifeCycle:

An object that contains lifecycle details for the Opportunity.

• ClosedLostReason (string) --

  Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

  • Customer Deficiency: The customer lacked necessary resources or capabilities.

  • Delay/Cancellation of Project: The project was delayed or canceled.

  • Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.

  • Lost to Competitor - Google: The opportunity was lost to Google.

  • Lost to Competitor - Microsoft: The opportunity was lost to Microsoft.

  • Lost to Competitor - SoftLayer: The opportunity was lost to SoftLayer.

  • Lost to Competitor - VMWare: The opportunity was lost to VMWare.

  • Lost to Competitor - Other: The opportunity was lost to a competitor not listed above.

  • No Opportunity: There was no opportunity to pursue.

  • On Premises Deployment: The customer chose an on-premises solution.

  • Partner Gap: The partner lacked necessary resources or capabilities.

  • Price: The price was not competitive or acceptable to the customer.

  • Security/Compliance: Security or compliance issues prevented progress.

  • Technical Limitations: Technical limitations prevented progress.

  • Customer Experience: Issues related to the customer's experience impacted the decision.

  • Other: Any reason not covered by the other values.

  • People/Relationship/Governance: Issues related to people, relationships, or governance.

  • Product/Technology: Issues related to the product or technology.

  • Financial/Commercial: Financial or commercial issues impacted the decision.

• NextSteps (string) --

  Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

• NextStepsHistory (list) --

  Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

  • (dict) --

    Read-only; shows the last 50 values and change dates for the NextSteps field.

    • Time (datetime) -- [REQUIRED]

      Indicates the step execution time.

    • Value (string) -- [REQUIRED]

      Indicates the step's execution details.

• ReviewComments (string) --

  Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.

• ReviewStatus (string) --

  Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

  • Pending Submission: Not submitted for validation (editable).

  • Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).

  • In Review: Amazon Web Services is validating (read-only).

  • Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity, and ensure all required changes are made. Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:

    • Customer.Account.Address.City

    • Customer.Account.Address.CountryCode

    • Customer.Account.Address.PostalCode

    • Customer.Account.Address.StateOrRegion

    • Customer.Account.Address.StreetAddress

    • Customer.Account.WebsiteUrl

    • LifeCycle.TargetCloseDate

    • Project.ExpectedMonthlyAWSRevenue.Amount

    • Project.ExpectedMonthlyAWSRevenue.CurrencyCode

    • Project.CustomerBusinessProblem

    • PartnerOpportunityIdentifier

  After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.

  • Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).

  • Rejected: Disqualified (read-only).

• ReviewStatusReason (string) --

  Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

• Stage (string) --

  Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

  The descriptions of each sales stage are:

  • Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).

  • Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.

  • Technical Validation: All parties understand the implementation plan.

  • Business Validation: Pricing was proposed, and all parties agree to the steps to close.

  • Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.

  • Launched: The workload is complete, and Amazon Web Services has started billing.

  • Closed Lost: The opportunity is lost, and there are no steps to move forward.

• TargetCloseDate (string) --

  Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

  Ensure the Target Close Date isn't in the past.

type Marketing:

dict

param Marketing:

An object that contains marketing details for the Opportunity.

• AwsFundingUsed (string) --

  Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

• CampaignName (string) --

  Specifies the Opportunity's unique marketing campaign name. The Amazon Web Services campaign name serves as a reference to specific marketing initiatives, promotions, or activities related to the Opportunity. This field captures the identifier used to track and categorize the Opportunity within Amazon Web Services's marketing campaigns. If you don't have a campaign name, reach out to your Amazon Web Services point of contact to obtain one.

• Channels (list) --

  Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

  • (string) --

• Source (string) --

  Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.

• UseCases (list) --

  Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

  Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

  • (string) --

type NationalSecurity:

string

param NationalSecurity:

Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national security-related opportunities, specific validation and compliance rules may apply, impacting the opportunity's visibility and processing.

type OpportunityType:

string

param 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.

type PartnerOpportunityIdentifier:

string

param 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 sent back to the partner.

type PrimaryNeedsFromAws:

list

param PrimaryNeedsFromAws:

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

Valid values:

• Co-Sell - 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.

• Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

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

• Co-Sell - Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

• Co-Sell - Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

• Co-Sell - 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.

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

• Co-Sell - Support for Public Tender / RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.

• Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request co-selling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

• (string) --

type Project:

dict

param Project:

An object that contains project details summary for the Opportunity.

• AdditionalComments (string) --

  Captures additional comments or information for the Opportunity that weren't captured in other fields.

• ApnPrograms (list) --

  Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

  Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

  • (string) --

• CompetitorName (string) --

  Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

• CustomerBusinessProblem (string) --

  Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a clear and concise narrative that outlines the specific business challenge or issue the customer has. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

• CustomerUseCase (string) --

  Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

  Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse / Data Integration / ETL / Data Lake / BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing / End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration / Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

• DeliveryModels (list) --

  Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

  Options' descriptions from the Delivery Model field are:

  • SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.

  • BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.

  • Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).

  • Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).

  • Resell: Amazon Web Services accounts and billing management for your customers.

  • Other: Delivery model not described above.

  • (string) --

• ExpectedCustomerSpend (list) --

  Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.

  • (dict) --

    Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

    • Amount (string) -- [REQUIRED]

      Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

    • CurrencyCode (string) -- [REQUIRED]

      Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

    • Frequency (string) -- [REQUIRED]

      Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

    • TargetCompany (string) -- [REQUIRED]

      Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

• OtherCompetitorNames (string) --

  Only allowed when CompetitorNames has Other selected.

• OtherSolutionDescription (string) --

  Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

• RelatedOpportunityIdentifier (string) --

  Specifies the current opportunity's parent opportunity identifier.

• SalesActivities (list) --

  Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

  Valid values:

  • Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.

  • Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.

  • Conducted POC / Demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.

  • In evaluation / planning stage: The customer is evaluating the solution and planning potential implementation.

  • Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.

  • Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.

  • Finalized Deployment Need: Both parties agree with and finalized the deployment needs.

  • SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.

  • (string) --

• Title (string) --

  Specifies the Opportunity's title or name.

type SoftwareRevenue:

dict

param SoftwareRevenue:

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

• DeliveryModel (string) --

  Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

• EffectiveDate (string) --

  Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

• ExpirationDate (string) --

  Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.

• Value (dict) --

  Specifies the payment value (amount and currency).

  • Amount (string) -- [REQUIRED]

    Specifies the payment amount.

  • CurrencyCode (string) -- [REQUIRED]

    Specifies the payment currency.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'LastModifiedDate': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • Id (string) --

    Read-only, system generated Opportunity unique identifier.

  • LastModifiedDate (datetime) --

    DateTime when the opportunity was last modified.

This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves several steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS Opportunity, and copying over key details for tracking. Once completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.

See also: AWS API Documentation

Request Syntax

client.start_engagement_by_accepting_invitation_task(
    Catalog='string',
    ClientToken='string',
    Identifier='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

type ClientToken:

string

param ClientToken:

[REQUIRED]

A unique, case-sensitive identifier provided by the client to ensure the idempotency of the request. Can be a random or meaningful string, but must be unique for each request.

This field is autopopulated if not provided.

type Identifier:

string

param Identifier:

[REQUIRED]

Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures the right engagement invitation is processed.

rtype:

dict

returns:

Response Syntax

{
    'EngagementInvitationId': 'string',
    'Message': 'string',
    'OpportunityId': 'string',
    'ReasonCode': 'InvitationAccessDenied'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'EngagementValidationFailed'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict',
    'StartTime': datetime(2015, 1, 1),
    'TaskArn': 'string',
    'TaskId': 'string',
    'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
}

Response Structure

• (dict) --

  • EngagementInvitationId (string) --

    Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.

  • Message (string) --

    If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

  • OpportunityId (string) --

    Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.

  • ReasonCode (string) --

    Indicates the reason for task failure using an enumerated code. Possible values are: ACCEPT_ENGAGEMENT_INVITATION_FAILED, GET_ENGAGEMENT_INVITATION_FAILED, CREATE_OPPORTUNITY_FAILED, CREATE_RESOURCE_VIEW_AUTOMATION_FAILED, SUBMIT_OPPORTUNITY_FAILED.

  • StartTime (datetime) --

    The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

  • TaskArn (string) --

    The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

  • TaskId (string) --

    The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

  • TaskStatus (string) --

    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity intended to be submitted to Amazon Web Services. Creating an opportunity sets its Lifecycle.ReviewStatus to Pending Submission.

To fully submit an opportunity, follow these steps:

• To create the opportunity, use CreateOpportunity.

• To associate a solution with the opportunity, use AssociateOpportunity.

• To submit the opportunity, use SubmitOpportunity.

After submission, you can't edit the opportunity until the review is complete. However, opportunities in the Pending Submission state still need all details completed. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields required to create opportunities, but consider providing optional fields to enrich the opportunity record.

See also: AWS API Documentation

Request Syntax

client.create_opportunity(
    Catalog='string',
    ClientToken='string',
    Customer={
        'Account': {
            'Address': {
                'City': 'string',
                'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                'PostalCode': 'string',
                'StateOrRegion': 'string',
                'StreetAddress': 'string'
            },
            'AwsAccountId': 'string',
            'CompanyName': 'string',
            'Duns': 'string',
            'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
            'OtherIndustry': 'string',
            'WebsiteUrl': 'string'
        },
        'Contacts': [
            {
                'BusinessTitle': 'string',
                'Email': 'string',
                'FirstName': 'string',
                'LastName': 'string',
                'Phone': 'string'
            },
        ]
    },
    LifeCycle={
        'ClosedLostReason': 'Customer Deficiency'|'Delay / Cancellation of Project'|'Legal / Tax / Regulatory'|'Lost to Competitor - Google'|'Lost to Competitor - Microsoft'|'Lost to Competitor - SoftLayer'|'Lost to Competitor - VMWare'|'Lost to Competitor - Other'|'No Opportunity'|'On Premises Deployment'|'Partner Gap'|'Price'|'Security / Compliance'|'Technical Limitations'|'Customer Experience'|'Other'|'People/Relationship/Governance'|'Product/Technology'|'Financial/Commercial',
        'NextSteps': 'string',
        'NextStepsHistory': [
            {
                'Time': datetime(2015, 1, 1),
                'Value': 'string'
            },
        ],
        'ReviewComments': 'string',
        'ReviewStatus': 'Pending Submission'|'Submitted'|'In review'|'Approved'|'Rejected'|'Action Required',
        'ReviewStatusReason': 'string',
        'Stage': 'Prospect'|'Qualified'|'Technical Validation'|'Business Validation'|'Committed'|'Launched'|'Closed Lost',
        'TargetCloseDate': 'string'
    },
    Marketing={
        'AwsFundingUsed': 'Yes'|'No',
        'CampaignName': 'string',
        'Channels': [
            'AWS Marketing Central'|'Content Syndication'|'Display'|'Email'|'Live Event'|'Out Of Home (OOH)'|'Print'|'Search'|'Social'|'Telemarketing'|'TV'|'Video'|'Virtual Event',
        ],
        'Source': 'Marketing Activity'|'None',
        'UseCases': [
            'string',
        ]
    },
    NationalSecurity='Yes'|'No',
    OpportunityTeam=[
        {
            'BusinessTitle': 'string',
            'Email': 'string',
            'FirstName': 'string',
            'LastName': 'string',
            'Phone': 'string'
        },
    ],
    OpportunityType='Net New Business'|'Flat Renewal'|'Expansion',
    Origin='AWS Referral'|'Partner Referral',
    PartnerOpportunityIdentifier='string',
    PrimaryNeedsFromAws=[
        'Co-Sell - Architectural Validation'|'Co-Sell - Business Presentation'|'Co-Sell - Competitive Information'|'Co-Sell - Pricing Assistance'|'Co-Sell - Technical Consultation'|'Co-Sell - Total Cost of Ownership Evaluation'|'Co-Sell - Deal Support'|'Co-Sell - Support for Public Tender / RFx',
    ],
    Project={
        'AdditionalComments': 'string',
        'ApnPrograms': [
            'string',
        ],
        'CompetitorName': 'Oracle Cloud'|'On-Prem'|'Co-location'|'Akamai'|'AliCloud'|'Google Cloud Platform'|'IBM Softlayer'|'Microsoft Azure'|'Other- Cost Optimization'|'No Competition'|'*Other',
        'CustomerBusinessProblem': 'string',
        'CustomerUseCase': 'string',
        'DeliveryModels': [
            'SaaS or PaaS'|'BYOL or AMI'|'Managed Services'|'Professional Services'|'Resell'|'Other',
        ],
        'ExpectedCustomerSpend': [
            {
                'Amount': 'string',
                'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                'Frequency': 'Monthly',
                'TargetCompany': 'string'
            },
        ],
        'OtherCompetitorNames': 'string',
        'OtherSolutionDescription': 'string',
        'RelatedOpportunityIdentifier': 'string',
        'SalesActivities': [
            'Initialized discussions with customer'|'Customer has shown interest in solution'|'Conducted POC / Demo'|'In evaluation / planning stage'|'Agreed on solution to Business Problem'|'Completed Action Plan'|'Finalized Deployment Need'|'SOW Signed',
        ],
        'Title': 'string'
    },
    SoftwareRevenue={
        'DeliveryModel': 'Contract'|'Pay-as-you-go'|'Subscription',
        'EffectiveDate': 'string',
        'ExpirationDate': 'string',
        'Value': {
            'Amount': 'string',
            'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL'
        }
    }
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 to test in a secure and isolated environment.

type ClientToken:

string

param ClientToken:

[REQUIRED]

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

Default: None

Best practice: To ensure uniqueness and avoid collisions, we recommend you use a UUID (Universally Unique Identifier) as the ClientToken. You can use standard libraries available in most programming languages to generated this. If you use the same client token, the API throws this error: "Conflicting client token submitted for a new request body".

This field is autopopulated if not provided.

type Customer:

dict

param Customer:

Specifies customer details associated with the Opportunity.

• Account (dict) --

  An object that contains the customer's account details.

  • Address (dict) --

    Specifies the end Customer's address details associated with the Opportunity.

    • City (string) --

      Specifies the end Customer's city associated with the Opportunity.

    • CountryCode (string) --

      Specifies the end Customer's country associated with the Opportunity.

    • PostalCode (string) --

      Specifies the end Customer's postal code associated with the Opportunity.

    • StateOrRegion (string) --

      Specifies the end Customer's state or region associated with the Opportunity.

      Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

    • StreetAddress (string) --

      Specifies the end Customer's street address associated with the Opportunity.

  • AwsAccountId (string) --

    Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

  • CompanyName (string) -- [REQUIRED]

    Specifies the end Customer's company name associated with the Opportunity.

  • Duns (string) --

    Indicates the Customer DUNS number, if available.

  • Industry (string) --

    Specifies the industry the end Customer belongs to that's associated with the Opportunity . It refers to the category or sector where the customer's business operates. This is a required field.

  • OtherIndustry (string) --

    Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

  • WebsiteUrl (string) --

    Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.

• Contacts (list) --

  Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.

  • (dict) --

    An object that contains a Customer Partner's contact details.

    • BusinessTitle (string) --

      The partner contact's title (job title or role) associated with the Opportunity.

    • Email (string) --

      The contact's email address associated with the Opportunity.

    • FirstName (string) --

      The contact's first name associated with the Opportunity.

    • LastName (string) --

      The contact's last name associated with the Opportunity.

    • Phone (string) --

      The contact's phone number associated with the Opportunity.

type LifeCycle:

dict

param LifeCycle:

An object that contains lifecycle details for the Opportunity.

• ClosedLostReason (string) --

  Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

  • Customer Deficiency: The customer lacked necessary resources or capabilities.

  • Delay/Cancellation of Project: The project was delayed or canceled.

  • Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.

  • Lost to Competitor - Google: The opportunity was lost to Google.

  • Lost to Competitor - Microsoft: The opportunity was lost to Microsoft.

  • Lost to Competitor - SoftLayer: The opportunity was lost to SoftLayer.

  • Lost to Competitor - VMWare: The opportunity was lost to VMWare.

  • Lost to Competitor - Other: The opportunity was lost to a competitor not listed above.

  • No Opportunity: There was no opportunity to pursue.

  • On Premises Deployment: The customer chose an on-premises solution.

  • Partner Gap: The partner lacked necessary resources or capabilities.

  • Price: The price was not competitive or acceptable to the customer.

  • Security/Compliance: Security or compliance issues prevented progress.

  • Technical Limitations: Technical limitations prevented progress.

  • Customer Experience: Issues related to the customer's experience impacted the decision.

  • Other: Any reason not covered by the other values.

  • People/Relationship/Governance: Issues related to people, relationships, or governance.

  • Product/Technology: Issues related to the product or technology.

  • Financial/Commercial: Financial or commercial issues impacted the decision.

• NextSteps (string) --

  Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

• NextStepsHistory (list) --

  Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

  • (dict) --

    Read-only; shows the last 50 values and change dates for the NextSteps field.

    • Time (datetime) -- [REQUIRED]

      Indicates the step execution time.

    • Value (string) -- [REQUIRED]

      Indicates the step's execution details.

• ReviewComments (string) --

  Indicates why an opportuntiy was sent back for further details. Partners must take corrective action based on the ReviewComments.

• ReviewStatus (string) --

  Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

  • Pending Submission: Not submitted for validation (editable).

  • Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).

  • In Review: Amazon Web Services is validating (read-only).

  • Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity, and ensure all required changes are made. Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:

    • Customer.Account.Address.City

    • Customer.Account.Address.CountryCode

    • Customer.Account.Address.PostalCode

    • Customer.Account.Address.StateOrRegion

    • Customer.Account.Address.StreetAddress

    • Customer.Account.WebsiteUrl

    • LifeCycle.TargetCloseDate

    • Project.ExpectedMonthlyAWSRevenue.Amount

    • Project.ExpectedMonthlyAWSRevenue.CurrencyCode

    • Project.CustomerBusinessProblem

    • PartnerOpportunityIdentifier

  After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.

  • Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).

  • Rejected: Disqualified (read-only).

• ReviewStatusReason (string) --

  Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

• Stage (string) --

  Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

  The descriptions of each sales stage are:

  • Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).

  • Qualified: Your account team engaged with the prospect/end customer to discuss viability and understand requirements. The prospect/end customer agreed that the opportunity is real, of interest, and may solve key business/technical needs.

  • Technical Validation: All parties understand the implementation plan.

  • Business Validation: Pricing was proposed, and all parties agree to the steps to close.

  • Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.

  • Launched: The workload is complete, and Amazon Web Services has started billing.

  • Closed Lost: The opportunity is lost, and there are no steps to move forward.

• TargetCloseDate (string) --

  Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

  Ensure the Target Close Date isn't in the past.

type Marketing:

dict

param Marketing:

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

• AwsFundingUsed (string) --

  Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

• CampaignName (string) --

  Specifies the Opportunity's unique marketing campaign name. The Amazon Web Services campaign name serves as a reference to specific marketing initiatives, promotions, or activities related to the Opportunity. This field captures the identifier used to track and categorize the Opportunity within Amazon Web Services's marketing campaigns. If you don't have a campaign name, reach out to your Amazon Web Services point of contact to obtain one.

• Channels (list) --

  Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

  • (string) --

• Source (string) --

  Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.

• UseCases (list) --

  Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

  Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

  • (string) --

type NationalSecurity:

string

param 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.

type OpportunityTeam:

list

param OpportunityTeam:

Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

• (dict) --

  An object that contains a Customer Partner's contact details.

  • BusinessTitle (string) --

    The partner contact's title (job title or role) associated with the Opportunity.

  • Email (string) --

    The contact's email address associated with the Opportunity.

  • FirstName (string) --

    The contact's first name associated with the Opportunity.

  • LastName (string) --

    The contact's last name associated with the Opportunity.

  • Phone (string) --

    The contact's phone number associated with the Opportunity.

type OpportunityType:

string

param 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.

type Origin:

string

param 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.

type PartnerOpportunityIdentifier:

string

param 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 sent back to the partner.

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

type PrimaryNeedsFromAws:

list

param PrimaryNeedsFromAws:

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

Valid values:

• Co-Sell - 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.

• Co-Sell - Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

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

• Co-Sell - 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).

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

• Co-Sell - 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.

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

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

• Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request co-selling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.

• (string) --

type Project:

dict

param Project:

An object that contains project details for the Opportunity.

• AdditionalComments (string) --

  Captures additional comments or information for the Opportunity that weren't captured in other fields.

• ApnPrograms (list) --

  Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

  Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

  • (string) --

• CompetitorName (string) --

  Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

• CustomerBusinessProblem (string) --

  Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a clear and concise narrative that outlines the specific business challenge or issue the customer has. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

• CustomerUseCase (string) --

  Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

  Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse / Data Integration / ETL / Data Lake / BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing / End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration / Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

• DeliveryModels (list) --

  Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

  Options' descriptions from the Delivery Model field are:

  • SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.

  • BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.

  • Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).

  • Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).

  • Resell: Amazon Web Services accounts and billing management for your customers.

  • Other: Delivery model not described above.

  • (string) --

• ExpectedCustomerSpend (list) --

  Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.

  • (dict) --

    Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

    • Amount (string) -- [REQUIRED]

      Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

    • CurrencyCode (string) -- [REQUIRED]

      Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

    • Frequency (string) -- [REQUIRED]

      Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

    • TargetCompany (string) -- [REQUIRED]

      Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

• OtherCompetitorNames (string) --

  Only allowed when CompetitorNames has Other selected.

• OtherSolutionDescription (string) --

  Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

• RelatedOpportunityIdentifier (string) --

  Specifies the current opportunity's parent opportunity identifier.

• SalesActivities (list) --

  Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

  Valid values:

  • Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.

  • Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.

  • Conducted POC / Demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.

  • In evaluation / planning stage: The customer is evaluating the solution and planning potential implementation.

  • Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.

  • Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.

  • Finalized Deployment Need: Both parties agree with and finalized the deployment needs.

  • SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.

  • (string) --

• Title (string) --

  Specifies the Opportunity's title or name.

type SoftwareRevenue:

dict

param SoftwareRevenue:

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

• DeliveryModel (string) --

  Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

• EffectiveDate (string) --

  Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

• ExpirationDate (string) --

  Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.

• Value (dict) --

  Specifies the payment value (amount and currency).

  • Amount (string) -- [REQUIRED]

    Specifies the payment amount.

  • CurrencyCode (string) -- [REQUIRED]

    Specifies the payment currency.

rtype:

dict

returns:

Response Syntax

{
    'Id': 'string',
    'LastModifiedDate': datetime(2015, 1, 1),
    'PartnerOpportunityIdentifier': 'string'
}

Response Structure

• (dict) --

  • Id (string) --

    Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent actions on the opportunity, such as updates, associations, and submissions. It ensures that each opportunity can be accurately tracked and managed within the system.

  • LastModifiedDate (datetime) --

    DateTime when the opportunity was last modified. When the Opportunity is created, its value is equal to CreatedDate.

  • PartnerOpportunityIdentifier (string) --

    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 sent back to the partner.

Use this action to reject an EngagementInvitation that has been shared by AWS. Rejecting the engagement invitation indicates that the partner does not wish to pursue the opportunity, and all related data will be inaccessible after the rejection.

See also: AWS API Documentation

Request Syntax

client.reject_engagement_invitation(
    Catalog='string',
    Identifier='string',
    RejectionReason='string'
)

type Catalog:

string

param Catalog:

[REQUIRED]

Specifies the catalog related to the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the opportunity is managed.

type Identifier:

string

param Identifier:

[REQUIRED]

Specifies the unique identifier of the EngagementInvitation to be rejected. Providing the correct identifier ensures that the intended invitation is rejected.

type RejectionReason:

string

param RejectionReason:

Specifies the reason for rejecting the engagement invitation. Providing a reason helps document the rationale behind the rejection and assists AWS in tracking patterns or issues. Possible values include:

• Customer problem unclear: The customer's problem is not clearly defined.

• Next steps unclear: The next steps required to proceed are not clear.

• Unable to support: The partner is unable to provide support due to resource or capability constraints.

• Duplicate of Partner Referral: The opportunity is a duplicate of an existing referral.

• Other: Any other reason not covered by the specified values.

returns:

None

Allows you to remove an existing association between an Opportunity and related entities such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining related entity that's required.

See also: AWS API Documentation

Request Syntax

client.disassociate_opportunity(
    Catalog='string',
    OpportunityIdentifier='string',
    RelatedEntityIdentifier='string',
    RelatedEntityType='Solutions'|'AwsProducts'|'AwsMarketplaceOffers'
)

type Catalog:

string

param Catalog:

[REQUIRED]

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 disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox to test in a secure and isolated environment.

type OpportunityIdentifier:

string

param OpportunityIdentifier:

[REQUIRED]

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier is crucial to ensure the correct opportunity is updated, especially in environments with numerous opportunities.

Validation: Ensure that the identifier provided corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

type RelatedEntityIdentifier:

string

param RelatedEntityIdentifier:

[REQUIRED]

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, refer to Amazon Web Services Marketplace Catalog API .

Validation: Ensure the identifier or ARN is valid and corresponds to an existing related entity. An incorrect or invalid identifier results in an error.

type RelatedEntityType:

string

param RelatedEntityType:

[REQUIRED]

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request and ensures that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplace offer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to ensure successful disassociation. Invalid or incorrect entity types result in an error.

returns:

None