Smaws_Client_PartnerCentralSelling.Typestype nonrec validation_exception_error = {code : validation_exception_error_code;Specifies the error code for the invalid field value.
*)message : Smaws_Lib.Smithy_api.Types.string_;Specifies the detailed error message for the invalid field value.
*)field_name : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the field name with the invalid value.
*)}Indicates an invalid value for a field.
REQUIRED_FIELD_MISSING: The request is missing a required field.
Fix: Verify your request payload includes all required fields.
INVALID_ENUM_VALUE: The enum field value isn't an accepted values.
Fix: Check the documentation for the list of valid enum values, and update your request with a valid value.
INVALID_STRING_FORMAT: The string format is invalid.
Fix: Confirm that the string is in the expected format (For example: email address, date).
INVALID_VALUE: The value isn't valid.
Fix: Confirm that the value meets the expected criteria and is within the allowable range or set.
TOO_MANY_VALUES: There are too many values in a field that expects fewer entries.
Fix: Reduce the number of values to match the expected limit.
NOT_ENOUGH_VALUES: There are not enough values in a field that expects more entries.
Fix: Increase the number of values to match the expected threshold.
ACTION_NOT_PERMITTED: The action isn't permitted due to current state or permissions.
Fix: Verify that the action is appropriate for the current state, and that you have the necessary permissions to perform it.
DUPLICATE_KEY_VALUE: The value in a field duplicates a value that must be unique.
Fix: Verify that the value is unique and doesn't duplicate an existing value in the system.
type nonrec validation_exception_error_list = validation_exception_error listtype nonrec validation_exception = {error_list : validation_exception_error_list option;A list of issues that were discovered in the submitted request or the resource state.
*)reason : validation_exception_reason;The primary reason for this validation exception to occur.
REQUEST_VALIDATION_FAILED: The request format is not valid.
Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
BUSINESS_VALIDATION_FAILED: The requested change doesn't pass the business validation rules.
Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
message : Smaws_Lib.Smithy_api.Types.string_;}The input fails to satisfy the constraints specified by the service or business validation rules.
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
type nonrec use_cases = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec update_opportunity_response = {last_modified_date : date_time;DateTime when the opportunity was last modified.
id : opportunity_identifier;Read-only, system generated Opportunity unique identifier.
}type nonrec primary_needs_from_aws = primary_need_from_aws listtype nonrec industry = | OTHER| WHOLESALE_DISTRIBUTION| TRAVEL| TRANSPORTATION_LOGISTICS| TELECOMMUNICATIONS| SOFTWARE_INTERNET| RETAIL| REALESTATE_CONSTRUCTION| PROFESSIONAL_SERVICES| NON_PROFIT_ORGANIZATION| MINING| MEDIA_ENTERTAINMENT| MARKETING_ADVERTISING| MANUFACTURING| LIFE_SCIENCES| HOSPITALITY| HEALTHCARE| GOVERNMENT| GAMING| FINANCIAL_SERVICES| ENERGY_POWER_UTILITIES| ENERGY_OIL_GAS| EDUCATION| CONSUMER_GOODS| COMPUTERS_ELECTRONICS| AUTOMOTIVE| AGRICULTURE| AEROSPACE_SATELLITEtype nonrec country_code = | ZW| ZM| YE| EH| WF| VI| VG| VN| VE| VU| UZ| UY| UM| GB| AE| UA| UG| TV| TC| TM| TR| TN| TT| TO| TK| TG| TL| TH| TZ| TJ| TW| SY| CH| SE| SZ| SJ| SR| SD| LK| ES| SS| GS| ZA| SO| SB| SI| SK| SX| SG| SL| SC| RS| SN| SA| ST| SM| WS| VC| PM| MF| LC| KN| SH| BL| RW| RU| RO| RE| QA| PR| PT| PL| PN| PH| PE| PY| PG| PA| PS| PW| PK| OM| NO| MP| NF| NU| NG| NE| NI| NZ| NC| AN| NL| NP| NR| NA| MM| MZ| MA| MS| ME| MN| MC| MD| FM| MX| YT| MU| MR| MQ| MH| MT| ML| MV| MY| MW| MG| MK| MO| LU| LT| LI| LY| LR| LS| LB| LV| LA| KG| KW| KR| KI| KE| KZ| JO| JE| JP| JM| IT| IL| IM| IE| IQ| IR| ID| IN| IS| HU| HK| HN| VA| HM| HT| GY| GW| GN| GG| GT| GU| GP| GD| GL| GR| GI| GH| DE| GE| GM| GA| TF| PF| GF| FR| FI| FJ| FO| FK| ET| EE| ER| GQ| SV| EG| EC| DO| DM| DJ| DK| CD| CZ| CY| CW| CU| HR| CI| CR| CK| CG| KM| CO| CC| CX| CN| CL| TD| CF| KY| CV| CA| CM| KH| BI| BF| BG| BN| IO| BR| BV| BW| BA| BQ| BO| BT| BM| BJ| BZ| BE| BY| BB| BD| BH| BS| AZ| AT| AU| AW| AM| AR| AG| AQ| AI| AO| AD| AS| DZ| AL| AX| AF| UStype nonrec address = {street_address : address_part option;Specifies the end Customer's street address associated with the Opportunity.
country_code : country_code option;Specifies the end Customer's country associated with the Opportunity.
state_or_region : address_part option;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
postal_code : address_part option;Specifies the end Customer's postal code associated with the Opportunity.
city : address_part option;Specifies the end Customer's city associated with the Opportunity.
}Specifies the end Customer's address details associated with the Opportunity.
type nonrec account = {duns : duns_number option;Indicates the Customer DUNS number, if available.
address : address option;Specifies the end Customer's address details associated with the Opportunity.
aws_account_id : aws_account option;Specifies the Customer Amazon Web Services account ID associated with the Opportunity.
website_url : website_url option;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.
company_name : name;Specifies the end Customer's company name associated with the Opportunity.
other_industry : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.
industry : industry option;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.
}Specifies the Customer's account details associated with the Opportunity.
type nonrec contact = {phone : phone_number option;The contact's phone number associated with the Opportunity.
business_title : job_title option;The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
last_name : name option;The contact's last name associated with the Opportunity.
first_name : name option;The contact's first name associated with the Opportunity.
email : email option;The contact's email address associated with the Opportunity.
}An object that contains a Customer Partner's contact details.
type nonrec customer_contacts_list = contact listtype nonrec customer = {contacts : customer_contacts_list option;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.
account : account option;An object that contains the customer's account details.
*)}An object that contains the customer's Account and Contact.
type nonrec delivery_models = delivery_model listtype nonrec currency_code = | ZWL| ZMW| ZAR| YER| XUA| XSU| XPF| XOF| XDR| XCD| XAF| WST| VUV| VND| VEF| UZS| UYU| UYI| USN| UGX| UAH| TZS| TWD| TTD| TRY| TOP| TND| TMT| TJS| THB| SZL| SYP| SVC| STN| SSP| SRD| SOS| SLL| SHP| SGD| SDG| SCR| SBD| SAR| RWF| RUB| RSD| RON| QAR| PYG| PLN| PKR| PHP| PGK| PEN| PAB| OMR| NPR| NOK| NIO| NGN| NAD| MZN| MYR| MXV| MXN| MWK| MVR| MUR| MRU| MOP| MNT| MMK| MKD| MGA| MDL| MAD| LYD| LSL| LRD| LKR| LBP| LAK| KZT| KYD| KWD| KRW| KPW| KMF| KHR| KGS| KES| JOD| JMD| ISK| IRR| IQD| ILS| IDR| HUF| HTG| HRK| HNL| HKD| GYD| GTQ| GNF| GMD| GIP| GHS| GEL| FKP| FJD| ETB| ERN| EGP| DZD| DOP| DKK| DJF| CZK| CVE| CUP| CUC| CRC| COU| COP| CLP| CLF| CHW| CHE| CDF| BZD| BYN| BWP| BTN| BSD| BRL| BOV| BOB| BND| BMD| BIF| BHD| BGN| BDT| BBD| BAM| AZN| AWG| ARS| AOA| ANG| AMD| ALL| AFN| AED| SEK| CHF| JPY| INR| NZD| CNY| CAD| AUD| GBP| EUR| USDtype nonrec expected_customer_spend = {estimation_url : estimation_url option;A URL providing additional information or context about the spend estimation.
*)target_company : Smaws_Lib.Smithy_api.Types.string_;Specifies the entity associated with this spend entry. Use AWS for the system’s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner’s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
frequency : payment_frequency;Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: "AWS" entries). Use None for one-time deal value entries (required for TargetCompany: "Self" entries when providing Total Contract Value).
currency_code : currency_code;Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
amount : amount option;Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
*)}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.
type nonrec expected_customer_spend_list = expected_customer_spend listThe unit of measurement for the contract duration value. Currently accepts only Months.
type nonrec expected_contract_duration = {value : Smaws_Lib.Smithy_api.Types.string_;A String representation of the contract duration as an integer, expressed in the unit defined by Term. Valid values range from 1 to 144.
term : expected_contract_duration_term;The unit of measurement for the contract duration value. Currently accepts only Months.
}The expected duration of a partner's contract with the customer. Used to convert Total Contract Value (TCV) to Monthly Recurring Revenue (MRR) for opportunity dealsizing calculations.
type nonrec apn_programs = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec sales_activities = sales_activity listtype nonrec project = {aws_partition : aws_partition option;AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
additional_comments : Smaws_Lib.Smithy_api.Types.string_ option;Captures additional comments or information for the Opportunity that weren't captured in other fields.
other_solution_description : pii_string option;Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.
other_competitor_names : Smaws_Lib.Smithy_api.Types.string_ option;Only allowed when CompetitorNames has Other selected.
competitor_name : competitor_name option;Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.
sales_activities : sales_activities option;Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.
Valid values:
customer_use_case : Smaws_Lib.Smithy_api.Types.string_ option;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
customer_business_problem : pii_string option;Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. 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.
apn_programs : apn_programs option;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
title : pii_string option;Specifies the Opportunity's title or name.
expected_contract_duration : expected_contract_duration option;Optional. The expected duration of the contract associated with this opportunity. Partners use this value alongside expected customer spend to convert Total Contract Value (TCV) into Monthly Recurring Revenue (MRR).
*)expected_customer_spend : expected_customer_spend_list option;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.
*)delivery_models : delivery_models option;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:
}An object that contains the Opportunity's project details.
type nonrec channels = channel listtype nonrec marketing = {aws_funding_used : aws_funding_used option;Indicates if the Opportunity is a marketing development fund (MDF) funded activity.
channels : channels option;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.
use_cases : use_cases option;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
source : marketing_source option;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.
campaign_name : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.
}An object that contains marketing details for the Opportunity.
type nonrec monetary_value = {currency_code : currency_code;Specifies the payment currency. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
amount : Smaws_Lib.Smithy_api.Types.string_;Specifies the payment amount.
*)}Specifies payments details.
type nonrec software_revenue = {expiration_date : date option;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.
*)effective_date : date option;Specifies the Opportunity's customer engagement start date for the contract's effectiveness.
value : monetary_value option;Specifies the payment value (amount and currency).
*)delivery_model : revenue_model option;Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.
}Specifies a customer's procurement terms details. Required only for partners in eligible programs.
type nonrec closed_lost_reason = | FINANCIALCOMMERCIAL| PRODUCTTECHNOLOGY| PEOPLERELATIONSHIPGOVERNANCE| OTHER| CUSTOMER_EXPERIENCE| TECHNICAL_LIMITATIONS| SECURITY_COMPLIANCE| PRICE| PARTNER_GAP| ON_PREMISES_DEPLOYMENT| NO_OPPORTUNITY| LOST_TO_COMPETITOR_OTHER| LOST_TO_COMPETITOR_VMWARE| LOST_TO_COMPETITOR_SOFTLAYER| LOST_TO_COMPETITOR_MICROSOFT| LOST_TO_COMPETITOR_GOOGLE| LEGAL_TAX_REGULATORY| DELAY_CANCELLATION_OF_PROJECT| CUSTOMER_DEFICIENCYtype nonrec next_steps_history = {time : date_time;Indicates the step execution time.
*)value : Smaws_Lib.Smithy_api.Types.string_;Indicates the step's execution details.
*)}Read-only; shows the last 50 values and change dates for the NextSteps field.
type nonrec next_steps_histories = next_steps_history listtype nonrec life_cycle = {next_steps_history : next_steps_histories option;Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.
*)review_status_reason : Smaws_Lib.Smithy_api.Types.string_ option;Code indicating the validation decision during the Amazon Web Services opportunity review. Applies when status is Rejected or Action Required. Used to document validation results for AWS Partner Referrals and indicate when additional information is needed from partners as part of the APN Customer Engagement (ACE) program.
review_comments : Smaws_Lib.Smithy_api.Types.string_ option;Contains detailed feedback from Amazon Web Services when requesting additional information from partners. Provides specific guidance on what partners need to provide or clarify for opportunity validation, complementing the ReviewStatusReason field.
review_status : review_status option;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:
Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made. Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:
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.
target_close_date : date option;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.
next_steps : pii_string option;Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.
closed_lost_reason : closed_lost_reason option;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:
stage : stage option;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.
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
The descriptions of each sales stage are:
}An object that contains the Opportunity lifecycle's details.
type nonrec update_opportunity_request = {life_cycle : life_cycle option;An object that contains lifecycle details for the Opportunity.
identifier : opportunity_identifier;Read-only, system generated Opportunity unique identifier.
last_modified_date : date_time;DateTime when the opportunity was last modified.
software_revenue : software_revenue option;Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
*)marketing : marketing option;An object that contains marketing details for the Opportunity.
opportunity_type : opportunity_type option;Specifies the opportunity type as a renewal, new, or expansion.
Opportunity types:
project : project option;An object that contains project details summary for the Opportunity.
customer : customer option;Specifies details of the customer associated with the Opportunity.
partner_opportunity_identifier : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)national_security : national_security option;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, validation and compliance rules may apply, impacting the opportunity's visibility and processing.
primary_needs_from_aws : primary_needs_from_aws option;Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
catalog : catalog_identifier;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 for testing in secure, isolated environments. 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.
}This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.
This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.
type nonrec access_denied_exception = {reason : access_denied_exception_error_code option;The reason why access was denied for the requested operation.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}This error occurs when you don't have permission to perform the requested action.
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
type nonrec address_summary = {country_code : country_code option;Specifies the end Customer's country associated with the Opportunity.
state_or_region : address_part option;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
postal_code : address_part option;Specifies the end Customer's postal code associated with the Opportunity.
city : address_part option;Specifies the end Customer's city associated with the Opportunity.
}An object that contains an Address object's subset of fields.
type nonrec lead_customer = {market_segment : market_segment option;Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
*)aws_maturity : aws_maturity option;Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
*)address : address_summary;website_url : company_website_url option;The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
*)company_name : company_name;The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
*)industry : industry option;Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
*)}Contains detailed information about the customer associated with the lead, including company details, industry classification, and AWS maturity level. This information helps qualify and categorize the lead for appropriate engagement strategies.
type nonrec lead_contact = {phone : phone_number option;The lead contact's phone number associated with the engagement.
*)last_name : name;The lead contact's last name associated with the engagement.
*)first_name : name;The lead contact's first name associated with the engagement.
*)email : email;The lead contact's email address associated with the engagement.
*)business_title : job_title;The lead contact's business title or job role associated with the engagement.
*)}An object that contains a lead contact's details associated with the engagement. This provides contact information for individuals involved in lead-related activities.
type nonrec lead_interaction = {contact : lead_contact;Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
*)business_problem : engagement_customer_business_problem option;Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
*)customer_action : customer_action;Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
*)interaction_date : date_time option;The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
*)usecase : engagement_use_case option;Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
*)source_name : lead_source_name;The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
*)source_id : lead_source_id;The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
*)source_type : lead_source_type;Specifies the type of source that generated the lead interaction, such as "Event", "Website", "Referral", or "Campaign". This categorization helps track lead generation effectiveness across different channels.
*)}Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.
type nonrec lead_insights = {lead_readiness_score : Smaws_Lib.Smithy_api.Types.string_ option;A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
}Contains insights that AI generates for a lead. These insights provide automated analysis to help partners evaluate the lead quality and prioritize engagement efforts.
type nonrec update_lead_context = {insights : lead_insights option;Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness.
*)interaction : lead_interaction option;Updated interaction details for the lead context.
*)customer : lead_customer;Updated customer information associated with the lead.
*)qualification_status : lead_qualification_status option;The updated qualification status of the lead.
*)}Updates the context information for a lead with qualification status, customer details, and interaction data.
type nonrec update_engagement_context_response = {context_id : engagement_context_identifier;The unique identifier of the engagement context that was updated.
*)engagement_last_modified_at : date_time;The timestamp when the engagement context was last modified.
*)engagement_arn : engagement_arn;The Amazon Resource Name (ARN) of the updated engagement.
*)engagement_id : engagement_identifier;The unique identifier of the engagement that was updated.
*)}type nonrec engagement_customer = {country_code : country_code;Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.
*)website_url : company_website_url;Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.
*)company_name : company_name;Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
*)industry : industry;Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
*)}Contains details about the customer associated with the Engagement Invitation, including company information and industry.
type nonrec engagement_customer_project_details = {target_completion_date : Smaws_Lib.Smithy_api.Types.string_;The target completion date for the customer's project.
*)business_problem : engagement_customer_business_problem;A description of the business problem the project aims to solve.
*)title : engagement_customer_project_title;The title of the project.
*)}Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements.
type nonrec customer_projects_context = {project : engagement_customer_project_details option;Information about the customer project associated with the Engagement.
*)customer : engagement_customer option;}The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers.
All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.
type nonrec eligible_programs_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec prospecting_result_customer = {public_profile_summary : prospecting_public_profile_summary option;A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
*)eligible_programs : eligible_programs_list option;A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
*)company_size : prospecting_company_size option;The company size classification of the prospected customer account.
*)segment : prospecting_segment option;The market segment classification of the prospected customer account.
*)sub_industry : prospecting_sub_industry option;The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
*)industry : industry option;The industry classification of the prospected customer account.
*)country : country_code option;The country code of the prospected customer account.
*)sub_region : prospecting_sub_region option;The subregion classification of the prospected customer account.
*)region : prospecting_region option;The specific region of the prospected customer account.
*)geo : prospecting_geo option;The geographic region classification of the prospected customer account.
*)account_name : prospecting_account_name option;The name of the prospected customer account.
*)}Contains detailed information about the prospected customer account, including company identifiers, geographic classification, industry segmentation, and program eligibility.
type nonrec prospecting_insights = {solution_sub_category : Smaws_Lib.Smithy_api.Types.string_ option;The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
*)solution_category : Smaws_Lib.Smithy_api.Types.string_ option;The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
*)solution_score : Smaws_Lib.Smithy_api.Types.string_ option;A score that indicates how well the partner's solution fits the prospected customer's needs.
*)marketplace_engagement_score : engagement_score_level option;A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
}Contains insights that AI generates from the prospecting analysis. These insights include marketplace engagement scoring, solution fit assessments, and solution categorization for the prospected customer.
type nonrec prospecting_result_aws = {insights : prospecting_insights option;Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
*)customer : prospecting_result_customer option;Contains details about the prospected customer account, including geographic, industry, and segment classifications.
*)task_name : task_name option;The name that the user provides for the prospecting task that generates this result.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
*)task_id : prospecting_task_identifier option;The unique identifier of the prospecting task that generates this result.
*)end_time : date_time option;The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
*)start_time : date_time option;The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
*)}Contains the prospecting data that AWS sources. This includes task execution details, customer account information, and insights that AI generates from the prospecting analysis.
type nonrec prospecting_result = {aws : prospecting_result_aws option;Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
*)}Contains the results of an autonomous prospecting job. This includes data and insights that AWS provides about a prospected customer account.
type nonrec update_engagement_context_payload = | ProspectingResult of prospecting_resultContains updated prospecting result data when the context type is "ProspectingResult". This field includes enriched data and insights that the system generates when a partner runs an autonomous prospecting job on leads.
*)| CustomerProject of customer_projects_context| Lead of update_lead_contextContains updated information about a lead when the context type is "Lead". This field is present only when updating a lead context within the engagement.
*)Represents the updated payload of an engagement context. The structure of this payload varies based on the context type being updated.
type nonrec update_engagement_context_request = {payload : update_engagement_context_payload;Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.
*)type_ : engagement_context_type;Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
*)engagement_last_modified_at : date_time;The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.
*)context_identifier : engagement_context_identifier;The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.
*)engagement_identifier : engagement_arn_or_identifier;The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.
catalog : catalog_identifier;Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.
}type nonrec service_quota_exceeded_exception = {message : Smaws_Lib.Smithy_api.Types.string_ option;}This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.
Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
*)resource_arn : taggable_resource_arn;The Amazon Resource Name (ARN) of the resource that you want to untag.
*)}type nonrec task_statuses = task_status listtype nonrec task_name_list = task_name listtype nonrec task_identifiers = task_arn_or_identifier listtype nonrec task_identifier_list = prospecting_task_identifier listtype nonrec target_close_date_filter = {before_target_close_date : date option;Filters opportunities with a target close date before this date. Use the YYYY-MM-DD format.
after_target_close_date : date option;Filters opportunities with a target close date after this date. Use the YYYY-MM-DD format.
}Filters opportunities based on their target close date.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_arn : taggable_resource_arn;The Amazon Resource Name (ARN) of the resource that you want to tag.
*)}type nonrec submit_opportunity_request = {visibility : visibility option;Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:
Full: The opportunity is fully visible to AWS sales.Limited: The opportunity has restricted visibility to AWS sales.involvement_type : sales_involvement_type;Specifies the level of AWS sellers' involvement on the opportunity. Valid values:
Co-sell: Indicates the user wants to co-sell with AWS. Share the opportunity with AWS to receive deal assistance and support.For Visibility Only: Indicates that the user does not need support from AWS Sales Rep. Share this opportunity with AWS for visibility only, you will not receive deal assistance and support.identifier : opportunity_identifier;The identifier of the Opportunity previously created by partner and needs to be submitted.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
}type nonrec string_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec stop_resource_snapshot_job_request = {resource_snapshot_job_identifier : resource_snapshot_job_identifier;The identifier of the job to stop.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
}type nonrec start_resource_snapshot_job_request = {resource_snapshot_job_identifier : resource_snapshot_job_identifier;The identifier of the resource snapshot job to start.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
}type nonrec engagement_identifier_list = engagement_identifier listThe current execution state of a prospecting task. A task transitions from PENDING to IN_PROGRESS when processing begins, and then to either COMPLETED or FAILED when processing ends.
type nonrec start_prospecting_from_engagement_task_response = {task_status : prospecting_task_status;The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
task_arn : prospecting_task_arn option;The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.
*)task_id : prospecting_task_identifier option;The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.
start_time : date_time;The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
*)reason_code : Smaws_Lib.Smithy_api.Types.string_ option;An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.
message : Smaws_Lib.Smithy_api.Types.string_ option;A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.
*)task_name : task_name;The task name from the request.
*)identifiers : engagement_identifier_list;The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
*)}Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.
type nonrec start_prospecting_from_engagement_task_request = {client_token : client_token;A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same ClientToken returns the same response without creating a duplicate task.
task_name : task_name;A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters.
*)identifiers : engagement_identifier_list;The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task.
*)catalog : catalog_identifier;Specifies the catalog in which the task is initiated. Specify AWS for production environments and Sandbox for testing and development purposes.
}Represents the request structure for starting a prospecting task. Includes up to 100 engagement identifiers and a task name. Uses ClientToken to ensure idempotency.
type nonrec reason_code = | DISQUALIFIED_LEAD_NOT_PERMITTED| CUSTOMER_PROJECT_CONTEXT_NOT_PERMITTED| CONTEXT_NOT_FOUND| REQUEST_THROTTLED| SERVICE_QUOTA_EXCEEDED| RESOURCE_SNAPSHOT_CONFLICT| RESOURCE_SNAPSHOT_VALIDATION_FAILED| RESOURCE_SNAPSHOT_ACCESS_DENIED| OPPORTUNITY_CONFLICT| OPPORTUNITY_VALIDATION_FAILED| INTERNAL_ERROR| ENGAGEMENT_INVITATION_CONFLICT| OPPORTUNITY_SUBMISSION_FAILED| ENGAGEMENT_CONFLICT| ENGAGEMENT_VALIDATION_FAILED| RESOURCE_SNAPSHOT_JOB_CONFLICT| RESOURCE_SNAPSHOT_JOB_VALIDATION_FAILED| RESOURCE_SNAPSHOT_JOB_ACCESS_DENIED| OPPORTUNITY_ACCESS_DENIED| ENGAGEMENT_ACCESS_DENIED| INVITATION_VALIDATION_FAILED| INVITATION_ACCESS_DENIEDtype nonrec start_opportunity_from_engagement_task_response = {context_id : context_identifier option;The unique identifier of the engagement context used to create the opportunity.
*)engagement_id : engagement_identifier option;The unique identifier of the engagement from which the opportunity was created.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;The identifier of the resource snapshot job created as part of the opportunity creation process.
*)opportunity_id : opportunity_identifier option;The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
*)reason_code : reason_code option;Indicates the reason for task failure using an enumerated code.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
*)task_status : task_status option;Indicates the current status of the task.
*)start_time : date_time option;The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
*)task_id : task_identifier option;The unique identifier of the task, used to track the task's progress.
*)}type nonrec start_opportunity_from_engagement_task_request = {context_identifier : context_identifier;The unique identifier of the engagement context from which to create the opportunity. This specifies the specific contextual information within the engagement that will be used for opportunity creation.
*)identifier : engagement_arn_or_identifier;The unique identifier of the engagement from which the opportunity creation task is to be initiated. This helps ensure that the task is applied to the correct engagement.
*)client_token : client_token;A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
*)catalog : catalog_identifier;Specifies the catalog in which the opportunity creation task is executed. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec start_engagement_from_opportunity_task_response = {engagement_invitation_id : engagement_invitation_identifier option;The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.
*)engagement_id : engagement_identifier option;The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
*)opportunity_id : opportunity_identifier option;Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
*)reason_code : reason_code option;Indicates the reason for task failure using an enumerated code.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
*)task_status : task_status option;Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
start_time : date_time option;The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
*)task_id : task_identifier option;The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
}type nonrec aws_submission = {visibility : visibility option;Determines who can view AWS 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.
involvement_type : sales_involvement_type;Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.
*)}Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.
type nonrec start_engagement_from_opportunity_task_request = {aws_submission : aws_submission;identifier : opportunity_identifier;The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.
*)client_token : client_token;A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
*)catalog : catalog_identifier;Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec start_engagement_by_accepting_invitation_task_response = {engagement_invitation_id : engagement_invitation_identifier option;Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;The identifier of the Resource Snapshot Job created as part of this task.
*)opportunity_id : opportunity_identifier option;Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
*)reason_code : reason_code option;Indicates the reason for task failure using an enumerated code.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
*)task_status : task_status option;Indicates the current status of the task.
*)start_time : date_time option;The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
*)task_id : task_identifier option;The unique identifier of the task, used to track the task’s progress.
*)}type nonrec start_engagement_by_accepting_invitation_task_request = {identifier : engagement_invitation_arn_or_identifier;Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.
client_token : client_token;A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.
*)catalog : catalog_identifier;Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.
}type nonrec sort_object = {sort_order : sort_order option;Determines the order in which the sorted results are presented.
*)sort_by : sort_by option;Specifies the field by which to sort the resource snapshot jobs.
*)}Defines the sorting parameters for listing resource snapshot jobs. This structure allows you to specify the field to sort by and the order of sorting.
type nonrec solution_sort = {sort_by : solution_sort_name;Specifies the attribute to sort by, such as Name, CreatedDate, or Status.
sort_order : sort_order;Specifies the sorting order, either Ascending or Descending. The default is Descending.
}Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.
type nonrec solution_base = {aws_marketplace_solution_arn : aws_marketplace_solution_arn option;The Amazon Resource Name (ARN) of the AWS Marketplace solution associated with this partner solution.
*)created_date : date_time;Indicates the solution creation date. This is useful to track and audit.
*)category : Smaws_Lib.Smithy_api.Types.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.
status : solution_status;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.
name : Smaws_Lib.Smithy_api.Types.string_;Specifies the solution name.
*)arn : solution_arn option;The SolutionBase structure provides essential information about a solution.
*)id : solution_identifier;Enables the association of solutions (offerings) to opportunities.
*)catalog : catalog_identifier;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.
}Specifies minimal information for the solution offered to solve the customer's business problem.
type nonrec solution_list = solution_base listtype nonrec solution_identifiers = solution_identifier listtype nonrec solution = Smaws_Lib.CoreTypes.Resource.ttype nonrec sender_contact = {phone : phone_number option;The sender-provided contact's phone number associated with the EngagementInvitation.
business_title : job_title option;The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
last_name : name option;The sender-provided contact's first name associated with the EngagementInvitation.
first_name : name option;The sender-provided contact's last name associated with the EngagementInvitation.
email : sender_contact_email;The sender-provided contact's email address associated with the EngagementInvitation.
}An object that contains the details of the sender-provided contact person for the EngagementInvitation.
type nonrec sender_contact_list = sender_contact listtype nonrec resource_snapshot_summary = {created_by : aws_account option;The AWS account ID of the entity that owns the resource from which the snapshot was created.
*)resource_snapshot_template_name : resource_template_name option;The name of the template used to create the snapshot.
*)resource_id : resource_identifier option;The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.
*)resource_type : resource_type option;The type of resource snapshotted.
*)revision : resource_snapshot_revision option;The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.
*)arn : resource_snapshot_arn option;The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.
*)}Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.
type nonrec resource_snapshot_summary_list = resource_snapshot_summary listtype nonrec life_cycle_for_view = {next_steps : pii_string option;Describes the next steps for the opportunity shared through a snapshot.
*)stage : stage option;Defines the current stage of the opportunity shared through a snapshot.
*)review_status : review_status option;Defines the approval status of the opportunity shared through a snapshot.
*)target_close_date : date option;The projected launch date of the opportunity shared through a snapshot.
*)}Provides the lifecycle view of an opportunity resource shared through a snapshot.
type nonrec partner_opportunity_team_members_list = contact listtype nonrec project_view = {other_solution_description : pii_string option;Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.
*)sales_activities : sales_activities option;Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.
*)customer_use_case : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the proposed solution focus or type of workload for the project.
*)expected_contract_duration : expected_contract_duration option;Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
expected_customer_spend : expected_customer_spend_list option;Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.
*)delivery_models : delivery_models option;Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.
*)}Provides the project view of an opportunity resource shared through a snapshot.
type nonrec aws_marketplace_offer_identifiers =
aws_marketplace_offer_identifier listtype nonrec aws_marketplace_offer_set_identifiers =
aws_marketplace_offer_set_identifier listtype nonrec aws_product_identifiers = aws_product_identifier listtype nonrec aws_marketplace_solution_identifiers =
aws_marketplace_solution_identifier listtype nonrec aws_marketplace_product_identifiers =
aws_marketplace_product_arn listThis field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.
type nonrec opportunity_summary_view = {project : project_view option;Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.
*)customer : customer option;primary_needs_from_aws : primary_needs_from_aws option;Identifies the type of support the partner needs from AWS.
*)opportunity_team : partner_opportunity_team_members_list option;Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.
*)lifecycle : life_cycle_for_view option;Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.
*)opportunity_type : opportunity_type option;Specifies the opportunity type.
*)}Provides a comprehensive view of an opportunity summary, including lifecycle information, team details, opportunity type, primary needs from AWS, and associated project information.
type nonrec aws_closed_lost_reason = | TERM_SHEET_IMPASSE| TECHNICAL_LIMITATIONS| SELF_SERVICE| SECURITY_COMPLIANCE| PRODUCT_NOT_ON_AWS| PRODUCT_TECHNOLOGY| PRICE| PREFERENCE_FOR_COMPETITOR| PLATFORM_TECHNOLOGY_LIMITATION| PEOPLE_RELATIONSHIP_GOVERNANCE| PAST_DUE| PARTNER_GAP| OTHER_DETAILS_IN_DESCRIPTION| OTHER| ON_PREMISES_DEPLOYMENT| NO_UPDATE| NOT_COMMITTED_TO_AWS| NO_RESPONSE| NO_PERCEIVED_VALUE_OF_MP| NO_OPPORTUNITY| NO_INTEGRATION_RESOURCES| NO_CUSTOMER_REFERENCE| LOST_TO_COMPETITOR_VMWARE| LOST_TO_COMPETITOR_SOFTLAYER| LOST_TO_COMPETITOR_RACKSPACE| LOST_TO_COMPETITOR_OTHER| LOST_TO_COMPETITOR_MICROSOFT| LOST_TO_COMPETITOR_GOOGLE| LOST_TO_COMPETITOR| LEGAL_TERMS_AND_CONDITIONS| LEGAL_TAX_REGULATORY| INTERNATIONAL_CONSTRAINTS| INSUFFICIENT_AWS_VALUE| INSUFFICIENT_AMAZON_VALUE| FINANCIAL_COMMERCIAL| FEATURE_LIMITATION| FAILED_VETTING| EXECUTIVE_BLOCKER| DUPLICATE_OPPORTUNITY| DUPLICATE| DELAY_CANCELLATION_OF_PROJECT| CUSTOMER_EXPERIENCE| CUSTOMER_DEFICIENCY| CUSTOMER_DATA_REQUIREMENT| COMPETITIVE_OFFERING| COMPANY_ACQUIRED_DISSOLVED| BUSINESS_ASSOCIATE_AGREEMENT| ADMINISTRATIVEtype nonrec aws_opportunity_stage = | CLOSED_INCOMPLETE| COMPLETED| CLOSED_LOST| DEFERRED_TO_PARTNER| LAUNCHED| COMMITTED| BUSINESS_VALIDATION| TECHNICAL_VALIDATION| ON_HOLD| QUALIFIED| BUILDING_INTEGRATION| ONBOARDING| CONTRACT_NEGOTIATION| TERM_SHEET_NEGOTIATION| SELLER_REGISTERED| EVALUATING| SELLER_ENGAGED| RESEARCH| QUALIFY| IDENTIFIED| ENGAGED| PROSPECT| IN_PROGRESS| NOT_STARTEDtype nonrec profile_next_steps_history = {time : date_time;Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
*)value : Smaws_Lib.Smithy_api.Types.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.
*)}Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
type nonrec profile_next_steps_histories = profile_next_steps_history listtype nonrec aws_opportunity_life_cycle = {next_steps_history : profile_next_steps_histories option;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.
*)next_steps : pii_string option;Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
*)stage : aws_opportunity_stage option;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.
closed_lost_reason : aws_closed_lost_reason option;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.
target_close_date : date option;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.
*)}Tracks the lifecycle of the AWS opportunity, including stages such as qualification, validation, and closure. This field helps partners understand the current status and progression of the opportunity.
type nonrec aws_team_member = {business_title : aws_member_business_title option;Specifies the Amazon Web Services team member's business title and indicates their organizational role.
*)last_name : name option;Provides the Amazon Web Services team member's last name.
*)first_name : name option;Provides the Amazon Web Services team member's first name.
*)email : email option;Provides the Amazon Web Services team member's email address.
*)}Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
type nonrec aws_opportunity_team_members_list = aws_team_member listtype nonrec amount_map =
(Smaws_Lib.Smithy_api.Types.string_ * monetary_amount) listMaps spend amounts to AWS programs and modernization pathways.
type nonrec aws_product_optimization = {savings_amount : monetary_amount;Quantified cost savings achievable by implementing this optimization.
*)description : Smaws_Lib.Smithy_api.Types.string_;Human-readable explanation of the optimization strategy.
*)}Specific optimization strategies partners can implement to reduce costs.
type nonrec aws_product_optimizations_list = aws_product_optimization listtype nonrec aws_product_details = {optimizations : aws_product_optimizations_list;List of specific optimization recommendations for this product.
*)potential_savings_amount : monetary_amount option;Service-specific cost reduction through optimizations.
*)optimized_amount : monetary_amount option;Service cost after applying optimizations.
*)amount : monetary_amount option;Baseline service cost before optimizations.
*)categories : string_list;List of program and pathway categories this product is eligible for.
*)service_code : Smaws_Lib.Smithy_api.Types.string_ option;Pricing Calculator service code.
*)product_code : Smaws_Lib.Smithy_api.Types.string_;AWS Partner Central product identifier used for opportunity association.
*)}List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
type nonrec aws_products_list = aws_product_details listtype nonrec aws_product_insights = {aws_products : aws_products_list;Product-level details including costs and optimization recommendations.
*)total_amount_by_category : amount_map;Spend amounts mapped to AWS programs and modernization pathways.
*)total_potential_savings_amount : monetary_amount option;Quantified savings achievable through implementing optimizations.
*)total_optimized_amount : monetary_amount option;Total estimated spend after applying recommended optimizations.
*)total_amount : monetary_amount option;Total estimated spend for this source before optimizations.
*)frequency : payment_frequency;Time period for spend amounts.
*)currency_code : currency_code;ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
}Comprehensive spend analysis for a single source (AWS or Partner) including total amounts, optimization savings, program category breakdowns, and detailed product-level insights.
type nonrec aws_products_spend_insights_by_source = {aw_s : aws_product_insights option;AI-generated insights including recommended products from AWS.
*)partner : aws_product_insights option;Partner-sourced insights derived from Pricing Calculator URLs.
*)}Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
type nonrec opportunity_quality = {trend : Smaws_Lib.Smithy_api.Types.string_ option;Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
score : Smaws_Lib.Smithy_api.Types.integer option;Deal quality score based on opportunity content completeness and sales methodology criteria. Values range from 0 to 100.
*)}Opportunity quality score and trend.
type nonrec recommendation_attribute_map =
(Smaws_Lib.Smithy_api.Types.string_ * Smaws_Lib.Smithy_api.Types.string_)
listtype nonrec recommendation = {attributes : recommendation_attribute_map option;Source-specific metadata as key-value pairs.
*)details : Smaws_Lib.Smithy_api.Types.string_;Human-readable recommendation text from this source.
*)type_ : Smaws_Lib.Smithy_api.Types.string_;The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
}A recommendation from an agent-driven source.
type nonrec recommendation_list = recommendation listtype nonrec aws_opportunity_insights = {recommendations : recommendation_list option;List of recommendations from various agent-driven sources.
*)opportunity_quality : opportunity_quality option;Opportunity quality assessment. Null if not yet scored.
*)aws_products_spend_insights_by_source : aws_products_spend_insights_by_source
option;Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
*)engagement_score : engagement_score option;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.
*)next_best_actions : Smaws_Lib.Smithy_api.Types.string_ option;Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
*)}Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.
Represents other entities related to the AWS opportunity, such as AWS products, partner solutions, and marketplace offers. These associations help build a complete picture of the solution being sold.
type nonrec aws_opportunity_customer = {contacts : customer_contacts_list option;Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.
*)}Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.
type nonrec aws_opportunity_project = {aws_partition : aws_partition option;AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
expected_customer_spend : expected_customer_spend_list option;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.
*)}Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.
type nonrec aws_opportunity_summary_full_view = {cosell_motion : Smaws_Lib.Smithy_api.Types.string_ option;Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
project : aws_opportunity_project option;customer : aws_opportunity_customer option;involvement_type_change_reason : involvement_type_change_reason option;Reason for changes in AWS involvement type for the opportunity.
*)insights : aws_opportunity_insights option;opportunity_team : aws_opportunity_team_members_list option;AWS team members involved in the opportunity.
*)life_cycle : aws_opportunity_life_cycle option;visibility : visibility option;Visibility level for the AWS opportunity.
*)involvement_type : sales_involvement_type option;Type of AWS involvement in the opportunity.
*)origin : opportunity_origin option;Source origin of the AWS opportunity.
*)}Provides a comprehensive view of AwsOpportunitySummaryFullView template.
type nonrec resource_snapshot_payload = | AwsOpportunitySummaryFullView of aws_opportunity_summary_full_viewProvides a comprehensive view of AwsOpportunitySummaryFullView template.
*)| OpportunitySummary of opportunity_summary_viewAn object that contains an opportunity's subset of fields.
Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.
type nonrec resource_snapshot_job_summary = {status : resource_snapshot_job_status option;The current status of the snapshot job.
Valid values:
engagement_id : engagement_identifier option;The unique identifier of the Engagement.
*)arn : resource_snapshot_job_arn option;The Amazon Resource Name (ARN) for the resource snapshot job.
*)id : resource_snapshot_job_identifier option;The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.
*)}An object that contains a Resource Snapshot Job's subset of fields.
type nonrec resource_snapshot_job_summary_list =
resource_snapshot_job_summary listtype nonrec resource_snapshot_job = Smaws_Lib.CoreTypes.Resource.ttype nonrec resource_snapshot = Smaws_Lib.CoreTypes.Resource.ttype nonrec reject_engagement_invitation_request = {rejection_reason : rejection_reason_string option;This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:
identifier : engagement_invitation_arn_or_identifier;This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.
catalog : catalog_identifier;This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.
}type nonrec receiver_responsibility_list = receiver_responsibility listtype nonrec account_receiver = {aws_account_id : aws_account;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.
*)alias : alias option;Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
*)}Contains the account details of the partner who received the Engagement Invitation, including the AWS account ID and company name.
type nonrec receiver = | Account of account_receiverSpecifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
*)Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.
type nonrec put_selling_system_settings_response = {resource_snapshot_job_role_arn : resource_snapshot_job_role_arn option;Specifies the ARN of the IAM Role used for resource snapshot job executions.
*)catalog : catalog_identifier;Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec put_selling_system_settings_request = {resource_snapshot_job_role_identifier : resource_snapshot_job_role_identifier
option;Specifies the ARN of the IAM Role used for resource snapshot job executions.
*)catalog : catalog_identifier;Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec prospecting_task_summary = {failed_engagement_count : Smaws_Lib.Smithy_api.Types.integer;The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.
completed_engagement_count : Smaws_Lib.Smithy_api.Types.integer;The number of engagements that have been successfully converted into prospecting leads.
*)total_engagement_count : Smaws_Lib.Smithy_api.Types.integer;The total number of engagements included in the task.
*)end_time : date_time option;The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.
*)start_time : date_time;The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
*)task_name : task_name;The descriptive name of the task provided when it was created.
*)task_arn : prospecting_task_arn;The Amazon Resource Name (ARN) of the task.
*)task_id : prospecting_task_identifier;The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.
}A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask.
type nonrec prospecting_task_summary_list = prospecting_task_summary listThe fields available for sorting results from ListProspectingFromEngagementTasks. Valid values are StartTime, TaskName, and FailedEngagementCount.
type nonrec prospecting_from_engagement_task_sort = {sort_by : prospecting_from_engagement_task_sort_name;The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).
sort_order : sort_order;The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.
}Specifies the sort configuration for ListProspectingFromEngagementTasks. Contains the field to sort by and the sort direction.
type nonrec prospecting_from_engagement_task = Smaws_Lib.CoreTypes.Resource.ttype nonrec project_summary = {expected_contract_duration : expected_contract_duration option;Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
expected_customer_spend : expected_customer_spend_list option;Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.
*)delivery_models : delivery_models option;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:
}An object that contains a Project object's subset of fields.
type nonrec project_details = {expected_customer_spend : expected_customer_spend_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.
*)target_completion_date : date;Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
*)title : Smaws_Lib.Smithy_api.Types.string_;Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
*)business_problem : engagement_customer_business_problem;Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.
*)}Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.
type nonrec opportunity_invitation_payload = {project : project_details;Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.
*)customer : engagement_customer;Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.
*)receiver_responsibilities : receiver_responsibility_list;Outlines the responsibilities or expectations of the receiver in the context of the invitation.
*)sender_contacts : sender_contact_list option;Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
*)}Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.
type nonrec lead_invitation_customer = {market_segment : market_segment option;Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
*)aws_maturity : aws_maturity option;Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
*)country_code : country_code;The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
*)website_url : company_website_url option;The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
*)company_name : company_name;The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
*)industry : industry option;Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
*)}Contains customer information included in a lead invitation payload. This structure provides essential details about the customer to help partners evaluate the lead opportunity and determine their interest in engagement.
type nonrec lead_invitation_interaction = {contact_business_title : job_title;The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
*)usecase : engagement_use_case option;Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
*)source_name : lead_source_name;The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
*)source_id : lead_source_id;The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
*)source_type : lead_source_type;Specifies the type of source that generated the lead interaction, such as "Event", "Website", or "Campaign". This helps partners understand the lead generation channel and assess lead quality based on the source type.
*)}Represents interaction details included in a lead invitation payload. This structure provides context about how the lead was generated and the customer's engagement history to help partners assess the opportunity quality.
type nonrec lead_invitation_payload = {interaction : lead_invitation_interaction;Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
*)customer : lead_invitation_customer;Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
*)}Represents the data payload of an engagement invitation for a lead opportunity. This contains detailed information about the customer and interaction history that partners use to evaluate whether to accept the lead engagement invitation.
type nonrec payload = | LeadInvitation of lead_invitation_payloadSpecifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
*)| OpportunityInvitation of opportunity_invitation_payloadSpecifies 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.
*)Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.
type nonrec life_cycle_summary = {review_status_reason : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)review_comments : Smaws_Lib.Smithy_api.Types.string_ option;Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
review_status : review_status option;Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:
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:
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.
target_close_date : date option;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.
next_steps : pii_string option;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.
closed_lost_reason : closed_lost_reason option;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.
stage : stage option;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.
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
The descriptions of each sales stage are:
}An object that contains a LifeCycle object's subset of fields.
type nonrec account_summary = {address : address_summary option;Specifies the end Customer's address details associated with the Opportunity.
website_url : website_url option;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.
company_name : name;Specifies the end Customer's company name associated with the Opportunity.
other_industry : Smaws_Lib.Smithy_api.Types.string_ option;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.
industry : industry option;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.
}An object that contains an Account's subset of fields.
type nonrec customer_summary = {account : account_summary option;An object that contains a customer's account details.
*)}An object that contains a Customer object's subset of fields.
type nonrec opportunity_summary = {project : project_summary option;An object that contains the Opportunity's project details summary.
customer : customer_summary option;An object that contains the Opportunity's customer details.
life_cycle : life_cycle_summary option;An object that contains the Opportunity's lifecycle details.
created_date : date_time option;DateTime when the Opportunity was last created.
last_modified_date : date_time option;DateTime when the Opportunity was last modified.
opportunity_type : opportunity_type option;Specifies opportunity type as a renewal, new, or expansion.
Opportunity types:
partner_opportunity_identifier : Smaws_Lib.Smithy_api.Types.string_ option;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.
arn : opportunity_arn option;The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.
*)id : opportunity_identifier option;Read-only, system-generated Opportunity unique identifier.
catalog : catalog_identifier;Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.
}An object that contains an Opportunity's subset of fields.
type nonrec opportunity_summaries = opportunity_summary listtype nonrec opportunity_sort = {sort_by : opportunity_sort_name;Field name to sort by.
*)sort_order : sort_order;Sort order.
Default: Descending
}Object that configures response sorting.
type nonrec opportunity_identifiers = opportunity_identifier listtype nonrec opportunity_from_engagement_task = Smaws_Lib.CoreTypes.Resource.ttype nonrec opportunity_engagement_invitation_sort = {sort_by : opportunity_engagement_invitation_sort_name;Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
sort_order : sort_order;Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
}Defines sorting options for retrieving Engagement Invitations. Sorting can be done based on various criteria like the invitation date or status.
type nonrec opportunity = Smaws_Lib.CoreTypes.Resource.ttype nonrec list_tasks_sort_base = {sort_by : list_tasks_sort_name;Specifies the field by which the task list should be sorted.
*)sort_order : sort_order;Determines the order in which the sorted results are presented.
*)}Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.
type nonrec list_solutions_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)solution_summaries : solution_list;An array with minimal details for solutions matching the request criteria.
*)}type nonrec filter_status = solution_status listtype nonrec aws_marketplace_solution_arn_list =
aws_marketplace_solution_arn listtype nonrec list_solutions_request = {aws_marketplace_solution_arn : aws_marketplace_solution_arn_list option;Filters results by AWS Marketplace solution ARN. You can provide up to 10 ARNs.
*)category : string_list option;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.
identifier : solution_identifiers option;Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.
*)status : filter_status option;Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
*)sort : solution_sort option;Object that configures sorting done on the response. Default Sort.SortBy is Identifier.
next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)max_results : page_size option;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
*)catalog : catalog_identifier;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 nonrec list_resource_snapshots_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token to retrieve the next set of results. If there are no additional results, this value is null.
*)resource_snapshot_summaries : resource_snapshot_summary_list;An array of resource snapshot summary objects.
*)}type nonrec list_resource_snapshots_request = {created_by : aws_account option;Filters the response to include only snapshots of resources owned by the specified AWS account.
*)resource_snapshot_template_identifier : resource_template_name option;Filters the response to include only snapshots created using the specified template.
*)resource_identifier : resource_identifier option;Filters the response to include only snapshots of the specified resource.
*)resource_type : resource_type option;Filters the response to include only snapshots of the specified resource type.
*)engagement_identifier : engagement_identifier;The unique identifier of the engagement associated with the snapshots.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for the next set of results.
*)max_results : page_size option;The maximum number of results to return in a single call.
*)catalog : catalog_identifier;Specifies the catalog related to the request.
*)}type nonrec list_resource_snapshot_jobs_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token to retrieve the next set of results. If there are no additional results, this value is null.
*)resource_snapshot_job_summaries : resource_snapshot_job_summary_list;An array of resource snapshot job summary objects.
*)}type nonrec list_resource_snapshot_jobs_request = {sort : sort_object option;Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.
status : resource_snapshot_job_status option;The status of the jobs to filter the response.
*)engagement_identifier : engagement_identifier option;The identifier of the engagement to filter the response.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for the next set of results.
*)max_results : page_size option;The maximum number of results to return in a single call. If omitted, defaults to 50.
*)catalog : catalog_identifier;Specifies the catalog related to the request.
*)}type nonrec list_prospecting_from_engagement_tasks_response = {task_summaries : prospecting_task_summary_list;Prospecting task summaries matching the specified filters. Each summary includes the task identifier, name, status counters, and timing information. If no tasks match the filter criteria, the list is empty.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;A pagination token used to retrieve the next page of results. If this field is present, pass its value as NextToken in the next call. If absent or empty, there are no further pages.
}Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through NextToken when additional results are available.
type nonrec list_prospecting_from_engagement_tasks_request = {sort : prospecting_from_engagement_task_sort option;Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.
*)start_before : date_time option;Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.
start_after : date_time option;Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.
task_name : task_name_list option;Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.
*)task_identifier : task_identifier_list option;Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.
*)max_results : page_size option;The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.
catalog : catalog_identifier;Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.
}Represents the request structure for listing prospecting tasks. All filter parameters are optional. Results are paginated — uses NextToken from the response to retrieve subsequent pages.
type nonrec list_opportunity_from_engagement_task_summary = {context_id : context_identifier option;The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.
*)engagement_id : engagement_identifier option;The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.
*)opportunity_id : opportunity_identifier option;The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
*)reason_code : reason_code option;A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution.
*)task_status : task_status option;The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.
*)start_time : date_time option;The timestamp indicating when the task was initiated, in RFC 3339 format.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
*)task_id : task_identifier option;The unique identifier of the task for creating an opportunity from an engagement.
*)}Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task's status, associated identifiers, and any failure details for opportunity creation processes.
type nonrec list_opportunity_from_engagement_task_summaries =
list_opportunity_from_engagement_task_summary listtype nonrec list_opportunity_from_engagement_tasks_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
*)task_summaries : list_opportunity_from_engagement_task_summaries option;An array of ListOpportunityFromEngagementTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
}type nonrec engagement_identifiers = engagement_arn_or_identifier listtype nonrec context_identifiers = context_identifier listtype nonrec list_opportunity_from_engagement_tasks_request = {context_identifier : context_identifiers option;Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.
*)engagement_identifier : engagement_identifiers option;Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.
*)opportunity_identifier : opportunity_identifiers option;Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.
*)task_identifier : task_identifiers option;Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.
*)task_status : task_statuses option;Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.
sort : list_tasks_sort_base option;next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
*)max_results : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
*)}type nonrec list_opportunities_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)opportunity_summaries : opportunity_summaries;An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.
*)}type nonrec last_modified_date = {before_last_modified_date : date_time option;Specifies the date before which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified before a given timestamp.
*)after_last_modified_date : date_time option;Specifies the date after which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified after a given timestamp.
*)}Defines a filter to retrieve opportunities based on the last modified date. This filter is useful for tracking changes or updates to opportunities over time.
type nonrec filter_identifier = opportunity_identifier listtype nonrec filter_life_cycle_stage = stage listtype nonrec filter_life_cycle_review_status = review_status listtype nonrec created_date_filter = {before_created_date : date_time option;Filter opportunities created before this date.
*)after_created_date : date_time option;Filter opportunities created after this date.
*)}Filter for opportunities based on creation date range.
type nonrec list_opportunities_request = {target_close_date : target_close_date_filter option;Filters opportunities based on their target close date. This filter helps retrieve opportunities with an expected close date before or after a specified date.
*)created_date : created_date_filter option;Filter opportunities by creation date criteria.
*)customer_company_name : string_list option;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.
*)life_cycle_review_status : filter_life_cycle_review_status option;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.
life_cycle_stage : filter_life_cycle_stage option;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.
identifier : filter_identifier option;Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.
*)last_modified_date : last_modified_date option;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.
*)sort : opportunity_sort option;An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.
next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)max_results : page_size option;Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.
Default: 20
*)catalog : catalog_identifier;Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
}type nonrec engagement_context_type_list = engagement_context_type listtype nonrec engagement_summary = {context_types : engagement_context_type_list option;An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.
*)modified_by : aws_account option;The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
*)modified_at : date_time option;The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
*)member_count : Smaws_Lib.Smithy_api.Types.integer option;The number of members in the Engagement.
*)created_by : aws_account option;The AWS Account ID of the Engagement creator.
*)created_at : date_time option;The date and time when the Engagement was created.
*)title : engagement_title option;The title of the Engagement.
*)id : engagement_identifier option;The unique identifier for the Engagement.
*)arn : engagement_arn option;The Amazon Resource Name (ARN) of the created Engagement.
*)}An object that contains an Engagement's subset of fields.
type nonrec engagement_summary_list = engagement_summary listtype nonrec list_engagements_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token to retrieve the next set of results. This field will be null if there are no more results.
*)engagement_summary_list : engagement_summary_list;An array of engagement summary objects.
*)}type nonrec aws_account_list = aws_account listtype nonrec engagement_sort = {sort_by : engagement_sort_name;The field by which to sort the results.
*)sort_order : sort_order;The order in which to sort the results.
*)}Specifies the sorting parameters for listing Engagements.
type nonrec list_engagements_request = {engagement_identifier : engagement_identifiers option;An array of strings representing engagement identifiers to retrieve.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for the next set of results. This value is returned from a previous call.
*)max_results : engagement_page_size option;The maximum number of results to return in a single call.
*)sort : engagement_sort option;exclude_context_types : engagement_context_type_list option;Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.
*)context_types : engagement_context_type_list option;Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.
*)exclude_created_by : aws_account_list option;An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
*)created_by : aws_account_list option;A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
*)catalog : catalog_identifier;Specifies the catalog related to the request.
*)}type nonrec engagement_resource_association_summary = {created_by : aws_account option;The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource.
*)resource_id : resource_identifier option;A unique identifier for the specific resource. Varies depending on the resource type.
*)resource_type : resource_type option;Categorizes the type of resource associated with the engagement.
*)engagement_id : engagement_identifier option;A unique identifier for the engagement associated with the resource.
*)catalog : catalog_identifier;Indicates the environment in which the resource and engagement exist.
*)}This provide a streamlined view of the relationships between engagements and resources. These summaries offer a crucial link between collaborative engagements and the specific resources involved, such as opportunities.These summaries are particularly valuable for partners navigating complex engagements with multiple resources. They enable quick insights into resource distribution across engagements, support efficient resource management, and help maintain a clear overview of collaborative activities.
type nonrec engagement_resource_association_summary_list =
engagement_resource_association_summary listtype nonrec list_engagement_resource_associations_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.
*)engagement_resource_association_summaries : engagement_resource_association_summary_list;A list of engagement-resource association summaries.
*)}type nonrec list_engagement_resource_associations_request = {created_by : aws_account option;Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.
*)resource_identifier : resource_identifier option;Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.
*)resource_type : resource_type option;Filters the results to include only associations with resources of the specified type.
*)engagement_identifier : engagement_identifier option;Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.
*)max_results : page_size option;Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.
*)catalog : catalog_identifier;Specifies the catalog in which to search for engagement-resource associations. Valid Values: "AWS" or "Sandbox"
AWS for production environments.Sandbox for testing and development purposes.}type nonrec engagement_member = {account_id : aws_account option;This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification.
*)website_url : Smaws_Lib.Smithy_api.Types.string_ option;The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
*)company_name : member_company_name option;The official name of the member's company or organization.
*)}Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement.
Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.
type nonrec engagement_members = engagement_member listtype nonrec list_engagement_members_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.
*)engagement_member_list : engagement_members;Provides a list of engagement members.
*)}type nonrec list_engagement_members_request = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for the next set of results.
*)max_results : member_page_size option;The maximum number of results to return in a single call.
*)identifier : engagement_arn_or_identifier;Identifier of the Engagement record to retrieve members from.
*)catalog : catalog_identifier;The catalog related to the request.
*)}type nonrec engagement_invitation_summary = {participant_type : participant_type option;Identifies the role of the caller in the engagement invitation.
*)catalog : catalog_identifier;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.
receiver : receiver option;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.
*)sender_company_name : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)sender_aws_account_id : aws_account option;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.
*)expiration_date : date_time option;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 be unavailable to the partner.
*)invitation_date : date_time option;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.
*)status : invitation_status option;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.
engagement_title : engagement_title option;Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
*)engagement_id : engagement_identifier option;The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
*)id : engagement_invitation_arn_or_identifier;Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
*)payload_type : engagement_invitation_payload_type option;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.
arn : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)}Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
type nonrec engagement_invitation_summaries =
engagement_invitation_summary listtype nonrec list_engagement_invitations_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)engagement_invitation_summaries : engagement_invitation_summaries option;An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
*)}type nonrec engagement_invitations_payload_type =
engagement_invitation_payload_type listtype nonrec invitation_status_list = invitation_status listtype nonrec aws_account_id_or_alias_list = aws_account listtype nonrec list_engagement_invitations_request = {sender_aws_account_id : aws_account_id_or_alias_list option;List of sender AWS account IDs to filter the invitations.
*)engagement_identifier : engagement_identifiers option;Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
*)status : invitation_status_list option;Status values to filter the invitations.
*)participant_type : participant_type;Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
*)payload_type : engagement_invitations_payload_type option;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.
*)sort : opportunity_engagement_invitation_sort option;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.
next_token : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)max_results : page_size option;Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
*)catalog : catalog_identifier;Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
}type nonrec list_engagement_from_opportunity_task_summary = {engagement_invitation_id : engagement_invitation_identifier option;The unique identifier of the Engagement Invitation.
*)engagement_id : engagement_identifier option;The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
*)opportunity_id : opportunity_identifier option;The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
*)reason_code : reason_code option;A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
*)task_status : task_status option;The current status of the task.
*)start_time : date_time option;The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
*)task_id : task_identifier option;A unique identifier for a specific task.
*)}Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.
type nonrec list_engagement_from_opportunity_task_summaries =
list_engagement_from_opportunity_task_summary listtype nonrec list_engagement_from_opportunity_tasks_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
*)task_summaries : list_engagement_from_opportunity_task_summaries option;TaskSummaries An array of TaskSummary objects containing details about each task.
*)}type nonrec list_engagement_from_opportunity_tasks_request = {engagement_identifier : engagement_identifiers option;Filters tasks by the identifiers of the engagements they created or are associated with.
*)opportunity_identifier : opportunity_identifiers option;The identifier of the original opportunity associated with this task.
*)task_identifier : task_identifiers option;Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
*)task_status : task_statuses option;Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
sort : list_tasks_sort_base option;Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
*)max_results : Smaws_Lib.Smithy_api.Types.integer option;Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
*)}type nonrec list_engagement_by_accepting_invitation_task_summary = {engagement_invitation_id : engagement_invitation_identifier option;The unique identifier of the engagement invitation that was accepted.
*)resource_snapshot_job_id : resource_snapshot_job_identifier option;Unique identifier of the resource snapshot job that was created.
*)opportunity_id : opportunity_identifier option;Unique identifier of opportunity that was created.
*)reason_code : reason_code option;A code pointing to the specific reason for the failure.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;Detailed message describing the failure and possible recovery steps.
*)task_status : task_status option;Status of the task.
*)start_time : date_time option;Task start timestamp.
*)task_arn : task_arn option;The Amazon Resource Name (ARN) that uniquely identifies the task.
*)task_id : task_identifier option;Unique identifier of the task.
*)}Specifies a subset of fields associated with tasks related to accepting an engagement invitation.
type nonrec list_engagement_by_accepting_invitation_task_summaries =
list_engagement_by_accepting_invitation_task_summary listtype nonrec list_engagement_by_accepting_invitation_tasks_response = {next_token : Smaws_Lib.Smithy_api.Types.string_ option;A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
*)task_summaries : list_engagement_by_accepting_invitation_task_summaries option;An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
}type nonrec engagement_invitation_identifiers =
engagement_invitation_arn_or_identifier listtype nonrec list_engagement_by_accepting_invitation_tasks_request = {task_identifier : task_identifiers option;Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
*)engagement_invitation_identifier : engagement_invitation_identifiers option;Filters tasks by the identifiers of the engagement invitations they are processing.
*)opportunity_identifier : opportunity_identifiers option;Filters tasks by the identifiers of the opportunities they created or are associated with.
*)task_status : task_statuses option;Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
sort : list_tasks_sort_base option;Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
*)next_token : Smaws_Lib.Smithy_api.Types.string_ option;Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.
*)max_results : Smaws_Lib.Smithy_api.Types.integer option;Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
*)}type nonrec lead_interaction_list = lead_interaction listtype nonrec lead_context = {interactions : lead_interaction_list;An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
*)customer : lead_customer;Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
*)qualification_status : lead_qualification_status option;Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
*)insights : lead_insights option;Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
*)}Provides comprehensive details about a lead associated with an engagement. This structure contains information about lead qualification status, customer details, and interaction history to facilitate lead management and tracking within the engagement.
type nonrec invitation = {payload : payload;receiver : receiver;message : invitation_message;A message accompanying the invitation.
*)}The Invitation structure represents an invitation exchanged between partners and AWS. It includes a message, receiver information, and a payload providing context for the invitation.
type nonrec get_selling_system_settings_response = {resource_snapshot_job_role_arn : resource_snapshot_job_role_arn option;Specifies the ARN of the IAM Role used for resource snapshot job executions.
*)catalog : catalog_identifier;Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec get_selling_system_settings_request = {catalog : catalog_identifier;Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
}type nonrec get_resource_snapshot_response = {target_member_accounts : aws_account_id_or_alias_list option;Target member accounts associated with the resource snapshot.
*)payload : resource_snapshot_payload option;revision : resource_snapshot_revision option;The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.
*)resource_snapshot_template_name : resource_template_name option;The name of the view used for this snapshot. This is the same as the template name.
*)resource_id : resource_identifier option;The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.
*)resource_type : resource_type option;The type of the resource that was snapshotted. Matches the ResourceType specified in the request.
*)engagement_id : engagement_identifier option;The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.
*)created_at : date_time option;The timestamp when the snapshot was created, in ISO 8601 format (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was taken.
*)created_by : aws_account option;The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.
*)arn : resource_arn option;The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.
*)catalog : catalog_identifier;The catalog in which the snapshot was created. Matches the Catalog specified in the request.
*)}type nonrec get_resource_snapshot_request = {revision : resource_snapshot_revision option;Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
*)resource_snapshot_template_identifier : resource_template_name;he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.
resource_identifier : resource_identifier;The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID
resource_type : resource_type;Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.
engagement_identifier : engagement_identifier;The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
}type nonrec get_resource_snapshot_job_response = {last_failure : Smaws_Lib.Smithy_api.Types.string_ option;If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.
*)last_successful_execution_date : date_time option;The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
*)status : resource_snapshot_job_status option;The current status of the snapshot job. Valid values:
created_at : date_time option;The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
*)resource_snapshot_template_name : resource_template_name option;The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.
*)resource_arn : resource_arn option;The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
*)resource_id : resource_identifier option;The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
*)resource_type : resource_type option;The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
*)engagement_id : engagement_identifier option;The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.
*)arn : resource_snapshot_job_arn option;The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
*)id : resource_snapshot_job_identifier option;The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
*)catalog : catalog_identifier;The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
*)}type nonrec get_resource_snapshot_job_request = {resource_snapshot_job_identifier : resource_snapshot_job_identifier;The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.
*)catalog : catalog_identifier;Specifies the catalog related to the request. Valid values are:
}type nonrec engagement_prospecting_result = {message : Smaws_Lib.Smithy_api.Types.string_ option;A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.
reason_code : Smaws_Lib.Smithy_api.Types.string_ option;An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.
status : prospecting_task_status;The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
engagement_context_id : Smaws_Lib.Smithy_api.Types.string_ option;The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.
engagement_identifier : engagement_identifier;The unique identifier of the engagement that was processed.
*)}Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task.
type nonrec engagement_prospecting_result_list =
engagement_prospecting_result listtype nonrec get_prospecting_from_engagement_task_response = {engagements : engagement_prospecting_result_list;An array of EngagementProspectingResult entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message.
end_time : date_time option;The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.
*)start_time : date_time;The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
*)task_name : task_name;The descriptive name of the task that you provided when you created it.
*)task_arn : prospecting_task_arn;The Amazon Resource Name (ARN) of the task.
*)task_id : prospecting_task_identifier;The unique identifier of the task.
*)}Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the Status field of each EngagementProspectingResult entry to determine individual outcomes.
type nonrec get_prospecting_from_engagement_task_request = {task_identifier : prospecting_task_identifier;The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.
catalog : catalog_identifier;Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.
}Represents the request structure for retrieving the status and results of a prospecting task.
type nonrec get_opportunity_response = {opportunity_team : partner_opportunity_team_members_list option;Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.
*)life_cycle : life_cycle option;An object that contains lifecycle details for the Opportunity.
created_date : date_time;DateTime when the Opportunity was last created.
last_modified_date : date_time;DateTime when the opportunity was last modified.
arn : opportunity_arn option;The Amazon Resource Name (ARN) that uniquely identifies the opportunity.
*)id : opportunity_identifier;Read-only, system generated Opportunity unique identifier.
software_revenue : software_revenue option;Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
*)marketing : marketing option;An object that contains marketing details for the Opportunity.
opportunity_type : opportunity_type option;Specifies the opportunity type as renewal, new, or expansion.
Opportunity types:
project : project option;An object that contains project details summary for the Opportunity.
customer : customer option;Specifies details of the customer associated with the Opportunity.
partner_opportunity_identifier : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)national_security : national_security option;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.
primary_needs_from_aws : primary_needs_from_aws option;Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
catalog : catalog_identifier;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.
}type nonrec get_opportunity_request = {identifier : opportunity_identifier;Read-only, system generated Opportunity unique identifier.
catalog : catalog_identifier;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, isolated testing environment.
}type nonrec engagement_context_payload = | ProspectingResult of prospecting_resultContains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".
*)| Lead of lead_contextContains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".
*)| CustomerProject of customer_projects_contextContains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".
*)Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.
type nonrec engagement_context_details = {payload : engagement_context_payload option;Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
*)type_ : engagement_context_type;Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
*)id : engagement_context_identifier option;The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
*)}Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
type nonrec engagement_contexts = engagement_context_details listtype nonrec get_engagement_response = {contexts : engagement_contexts option;A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
*)modified_by : aws_account option;The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
*)modified_at : date_time option;The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z". This helps track the most recent changes to the engagement.
*)member_count : Smaws_Lib.Smithy_api.Types.integer option;Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
*)created_by : aws_account option;The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
*)created_at : date_time option;The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
*)description : engagement_description option;A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
*)title : engagement_title option;The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
*)arn : engagement_arn option;The Amazon Resource Name (ARN) of the engagement retrieved.
*)id : engagement_identifier option;The unique resource identifier of the engagement retrieved.
*)}type nonrec get_engagement_request = {identifier : engagement_arn_or_identifier;Specifies the identifier of the Engagement record to retrieve.
*)catalog : catalog_identifier;Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.
}type nonrec engagement_member_summary = {website_url : Smaws_Lib.Smithy_api.Types.string_ option;The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
*)company_name : member_company_name option;The official name of the member's company or organization.
*)}The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.
type nonrec engagement_member_summaries = engagement_member_summary listtype nonrec get_engagement_invitation_response = {existing_members : engagement_member_summaries option;A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.
engagement_description : engagement_description option;The description of the engagement associated with this invitation.
*)invitation_message : invitation_message option;The message sent to the invited partner when the invitation was created.
*)payload : payload option;Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
*)rejection_reason : rejection_reason_string option;If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
*)catalog : catalog_identifier;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.
receiver : receiver option;Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
*)sender_company_name : Smaws_Lib.Smithy_api.Types.string_ option;The name of the AWS organization or team that sent the engagement invitation.
*)sender_aws_account_id : aws_account option;Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.
*)expiration_date : date_time option;Indicates the date on which the engagement invitation will expire if not accepted by the partner.
*)invitation_date : date_time option;The date when the engagement invitation was sent to the partner.
*)status : invitation_status option;The current status of the engagement invitation.
*)engagement_title : engagement_title option;The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
*)engagement_id : engagement_identifier option;The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.
*)id : engagement_invitation_arn_or_identifier;Unique identifier assigned to the engagement invitation being retrieved.
*)payload_type : engagement_invitation_payload_type option;The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
*)arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) that identifies the engagement invitation.
*)}type nonrec get_engagement_invitation_request = {identifier : engagement_invitation_arn_or_identifier;Specifies the unique identifier for the retrieved engagement invitation.
*)catalog : catalog_identifier;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 nonrec get_aws_opportunity_summary_response = {catalog : catalog_identifier;Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.
cosell_motion : Smaws_Lib.Smithy_api.Types.string_ option;Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
project : aws_opportunity_project option;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.
*)customer : aws_opportunity_customer option;Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.
*)involvement_type_change_reason : involvement_type_change_reason option;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.
insights : aws_opportunity_insights option;Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.
*)opportunity_team : aws_opportunity_team_members_list option;Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.
*)life_cycle : aws_opportunity_life_cycle option;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.
*)visibility : visibility option;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.
involvement_type : sales_involvement_type option;Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.
*)origin : opportunity_origin option;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.
*)}type nonrec get_aws_opportunity_summary_request = {catalog : catalog_identifier;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 nonrec engagement_invitation = Smaws_Lib.CoreTypes.Resource.ttype nonrec engagement_from_opportunity_task = Smaws_Lib.CoreTypes.Resource.ttype nonrec engagement_by_accepting_invitation_task =
Smaws_Lib.CoreTypes.Resource.ttype nonrec engagement = Smaws_Lib.CoreTypes.Resource.ttype nonrec disassociate_opportunity_request = {opportunity_identifier : opportunity_identifier;The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.
*)catalog : catalog_identifier;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 for testing in secure, isolated environments.
}type nonrec delete_resource_snapshot_job_request = {resource_snapshot_job_identifier : resource_snapshot_job_identifier;The unique identifier of the resource snapshot job to be deleted.
*)catalog : catalog_identifier;Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.
}type nonrec create_resource_snapshot_response = {revision : resource_snapshot_revision option;Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.
*)arn : resource_arn option;Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.
*)}type nonrec create_resource_snapshot_request = {client_token : client_token;Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.
*)resource_snapshot_template_identifier : resource_template_name;The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.
resource_identifier : resource_identifier;The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.
resource_type : resource_type;Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.
engagement_identifier : engagement_identifier;The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.
*)catalog : catalog_identifier;Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.
}type nonrec create_resource_snapshot_job_response = {arn : resource_snapshot_job_arn option;The Amazon Resource Name (ARN) of the created snapshot job.
*)id : resource_snapshot_job_identifier option;The unique identifier for the created snapshot job.
*)}type nonrec create_resource_snapshot_job_request = {resource_snapshot_template_identifier : resource_template_name;Specifies the name of the template that defines the schema for the snapshot.
*)resource_identifier : resource_identifier;Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.
resource_type : resource_type;The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
engagement_identifier : engagement_identifier;Specifies the identifier of the engagement associated with the resource to be snapshotted.
*)client_token : client_token;A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.
*)catalog : catalog_identifier;Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.
}type nonrec create_opportunity_response = {last_modified_date : date_time option;DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.
partner_opportunity_identifier : Smaws_Lib.Smithy_api.Types.string_ option;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.
*)id : opportunity_identifier;Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.
}type nonrec create_opportunity_request = {opportunity_team : partner_opportunity_team_members_list option;Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
*)origin : opportunity_origin option;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.
life_cycle : life_cycle option;An object that contains lifecycle details for the Opportunity.
client_token : client_token;Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.
Default: None
Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."
software_revenue : software_revenue option;Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.
*)marketing : marketing option;This object contains marketing details and is optional for an opportunity.
*)opportunity_type : opportunity_type option;Specifies the opportunity type as a renewal, new, or expansion.
Opportunity types:
project : project option;An object that contains project details for the Opportunity.
customer : customer option;Specifies customer details associated with the Opportunity.
partner_opportunity_identifier : Smaws_Lib.Smithy_api.Types.string_ option;Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.
This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.
*)national_security : national_security option;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.
primary_needs_from_aws : primary_needs_from_aws option;Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
catalog : catalog_identifier;Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
}type nonrec create_engagement_response = {modified_at : date_time option;The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). For newly created engagements, this value matches the creation timestamp. Example: "2023-05-01T20:37:46Z".
*)arn : engagement_arn option;The Amazon Resource Name (ARN) that identifies the engagement.
*)id : engagement_identifier option;Unique identifier assigned to the newly created engagement.
*)}type nonrec create_engagement_request = {contexts : engagement_contexts option;The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
description : engagement_description;Provides a description of the Engagement.
title : engagement_title;Specifies the title of the Engagement.
client_token : client_token;The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.
catalog : catalog_identifier;The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
}type nonrec create_engagement_invitation_response = {arn : engagement_invitation_arn;The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
*)id : engagement_invitation_identifier;Unique identifier assigned to the newly created engagement invitation.
*)}type nonrec create_engagement_invitation_request = {invitation : invitation;The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or LeadInvitation, which includes structures for customer information and interaction details.
engagement_identifier : engagement_identifier;The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
client_token : client_token;Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
*)catalog : catalog_identifier;Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
}type nonrec create_engagement_context_response = {context_id : engagement_context_identifier option;The unique identifier assigned to the newly created engagement context. This ID can be used to reference the specific context within the engagement for future operations.
*)engagement_last_modified_at : date_time option;The timestamp indicating when the engagement was last modified as a result of adding the context, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".
*)engagement_arn : engagement_arn option;The Amazon Resource Name (ARN) of the engagement to which the context was added. This globally unique identifier can be used for cross-service references and IAM policies.
*)engagement_id : engagement_identifier option;The unique identifier of the engagement to which the context was added. This ID confirms the successful association of the context with the specified engagement.
*)}type nonrec create_engagement_context_request = {payload : engagement_context_payload;type_ : engagement_context_type;Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
client_token : client_token;A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.
*)engagement_identifier : engagement_arn_or_identifier;The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.
catalog : catalog_identifier;Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.
}type nonrec associate_opportunity_request = {opportunity_identifier : opportunity_identifier;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.
catalog : catalog_identifier;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 association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
}type nonrec assignee_contact = {business_title : job_title;Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.
phone : phone_number option;Specifies the contact phone number of the assignee responsible for the opportunity or engagement. This field enables direct communication for time-sensitive matters and facilitates coordination between AWS and partner teams.
*)last_name : name;Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
*)first_name : name;Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
*)email : email;Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.
*)}Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.
type nonrec assign_opportunity_request = {assignee : assignee_contact;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.
*)identifier : opportunity_identifier;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.
catalog : catalog_identifier;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 for testing in secure, isolated environments.
}type nonrec accept_engagement_invitation_request = {identifier : engagement_invitation_arn_or_identifier;The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.
catalog : catalog_identifier;The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.
}