Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
apc-crm-008	apc-crm.pdf	8	TypeRequired/ optional validation Monthly number An estimate of the number of leads or opportuni ties to be shared with AWS. Currently, the Optional (must Number be a number) of Integration requires support from AWS Engineeri records ng for testing the completed Integration. We use shared this estimate to prioritize outstanding requests. with AWS Additiona l comments Additional information to share with AWS TextOptional Complete the details, and then choose Next. On the next screen, enter partner contacts. The following table lists the partner contact form ﬁelds, their description, and attributes. Name Description Type Required/optional validation Primary contact The primary point of contact for communicating updates on the Integration Email Read-only Third-party lead’s email address (who must be notiﬁed about any updates to the Integration) Third- par ty contact Additiona l partner contacts Additional email addresses for additional contacts to notify about any updates to the Integration. If you need to add more than three, we recommend using a mailer group instead of individual emails. Email and role string Required, when third-party solution is selected for What solution would you be using to integrate your CRM with APN? (Optional) When provided, must be valid email address. Email and role string Stage 2: Request submission 18 AWS Partner Central CRM Guide Complete the details, and then choose Next. On the next screen, provide Amazon Resource Name (ARN) information. The following table lists the ARN information form ﬁelds, their description, and attributes. Name Description ARN for connecting to ARN of the AWS Identity and Access Management (IAM) user or role used to sandbox connect to the Amazon S3 bucket used for testing (also known as sandbox). Use the IAM user or role created in the prerequisites sections. TypeRequired/ Optional validation StringRequired, Allowed ﬁeld values must match the pattern: arn:aws:i am::{Acco untId}:(u ser \| role)/ {username including text,numb er,_} ARN for connecting ARN of the IAM user or role used to connect to the Amazon S3 bucket used for productio String(Optional) When provided, to productio n. Use the IAM user or role created in the n—optional prerequisites sections. until Production Ready must match the pattern: arn:aws:i am::{Acco untId}:(u ser \| role)/ {username including text,numb er,_} Do you want to manage historical To manage only referrals created prior to your Integration, select Yes (recommended). Select No to only manage future referrals through the Integration. OptionRequired Yes, No Stage 2: Request submission 19 AWS Partner Central Name Description referrals via Integration? TypeRequired/ Optional validation CRM Guide Allowed ﬁeld values Complete the details, and then choose Submit. After you submit the form, the Request Submitted screen appears. If all the details are accurate, the sandbox is provisioned in less than ﬁve minutes. If there’s an issue with the details, you receive an error. You have the option to correct the details and resubmit the form. Stage 3: Sandbox setup What’s a sandbox? After partners submit their request, AWS uses the provided information to create a test Amazon S3 bucket and generates a custom policy for access. Partners are notiﬁed when the bucket is ready, and the custom policy is available to copy from the Sandbox Created stage in the onboarding ﬂow. Partners need to copy this custom policy and attach it to the AWS Identity and Access Management (IAM) user or role they created earlier. Attaching the custom policy to your IAM user or role To attach the custom policy to an IAM user or role: 1. Sign in to the AWS Management Console, and then open the IAM console. 2. In the navigation pane, choose Policies, and then choose Create policy (if you need to create a new policy). To attach an existing policy, skip to step 4. 3. Use the visual editor to create the policy, choose Review policy, and then choose Create policy. 4. Search for the user or role you created earlier in the IAM console. 5. Choose the user or role, and then choose the Permissions tab. 6. Choose Attach policies, and then locate the custom policy you created or received. 7. Choose Attach policy. For more information, refer to Adding and removing IAM identity permissions. Stage 3: Sandbox setup 20 AWS Partner Central CRM Guide Downloading IAM user credentials To download IAM user credentials (access key ID and secret access key): 1. Navigate to the IAM console, and then select the IAM user you created earlier. 2. Under the Security credentials tab, choose Create access key. 3. Choose Download .csv ﬁle to download the credentials ﬁle. This ﬁle contains the user’s new access key ID and secret access key. Keep these credentials secure because they provide programmatic access to your AWS resources. For more information, refer to Managing access keys (console). Amazon S3 bucket structure AWS structures the S3 buckets with diﬀerent folders for Integration, detailed in the table 1. #Purpose
apc-crm-009	apc-crm.pdf	9	IAM user credentials (access key ID and secret access key): 1. Navigate to the IAM console, and then select the IAM user you created earlier. 2. Under the Security credentials tab, choose Create access key. 3. Choose Download .csv ﬁle to download the credentials ﬁle. This ﬁle contains the user’s new access key ID and secret access key. Keep these credentials secure because they provide programmatic access to your AWS resources. For more information, refer to Managing access keys (console). Amazon S3 bucket structure AWS structures the S3 buckets with diﬀerent folders for Integration, detailed in the table 1. #Purpose Folder name Description 1Retrieve APN Customer Engagemen lead-outb ound Contains new leads or updates existing leads. Partners read and delete access. After a ﬁle is ts (ACE) leads 2Retrieve ACE opportunities processed, it should be deleted. opportuni ty-outbou Contains new or updated opportunities. Partners have read and delete access. nd 3Send new or updated ACE opportunities opportuni ty-inboun Partners can upload ﬁles with new or updated opportunities. d 4Send updates about ACE leads 5Retrieve results for opportunities sent to ACE lead-inbo Partners can upload ﬁles with updated lead data. und opportuni ty-inboun d-process ed-result s Contains the results for processed opportunities. Partners read and delete access. Stage 3: Sandbox setup 21 AWS Partner Central CRM Guide #Purpose Folder name Description Contains the results for processed leads. Partners read and delete access. 6Retrieve results for leads sent to ACE lead-inbo und-proce ssed-resu lts Stage 4: Implementation Overview With the sandbox setup completed, partners are now ready to move to the Implementation stage. This is a critical phase where partners choose their Integration path, and develop the necessary conﬁgurations within their sandbox environment. Partners should collaborate closely with their APN Customer Engagements (ACE) operations team to understand the business and automation requirements, to ensure the solution aligns with the ACE business operation ﬂow. Integration options Partners have three options for implementing their Integration with the ACE program: 1. AWS Partner CRM connector: The Amazon Web Services (AWS) Partner Customer Relationship Management (CRM) connector is a managed solution that AWS provides to connect your Salesforce CRM with AWS Partner Central. Find the AWS Partner CRM connector on the AppExchange. Documentation: Refer to AWS Partner CRM connector. 2. Custom Integration: For those who prefer a tailored solution, custom integration allows partners ﬂexibility and control over how their system interacts with ACE. For more information, refer to Custom integration using Amazon S3. 3. Using a third-party solution: Partners may opt for a third-party solution that ﬁts their speciﬁc needs. Discuss this option with your Partner Development Manager (PDM) to explore the available solutions. For a comparison of these options and to aid decision making, refer to the the section called “Options” section. Stage 4: Implementation 22 AWS Partner Central Moving to testing CRM Guide Once the implementation is complete, partners should transition to the testing phase to ensure the Integration functions as expected within the sandbox environment. This step is essential to validate the setup before going live. To mark the Implementation phase as complete: 1. Navigate to the My Integration page in Partner Central. 2. In the Next Steps dialog box, choose Mark Implementation Complete. Stage 5: Testing After implementation, the integration should be tested across various data ﬂow scenarios. Partners must ensure that all test cases pass successfully before proceeding to the next stage. Partners must test the scenarios in Table 1 for AWS originated (AO) and partner originated (PO) opportunities. Amazon Web Services (AWS) doesn’t oﬀer access to its CRM sandbox environment for partners to test out the complete Integration. As an alternative, partners can view the request/ response to ensure that the integration is working as expected. For any additional opportunity creation, or to validate opportunity through the various opportunity stages, raise an AWS Partner Network (APN) support case. For more information, refer to AWS Partner Support. We recommend you create a single APN support case with the details of the opportunities you want AWS to act on. Partners can refer to the following table to verify that all test scenarios pass before moving on to the next steps. # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) 1 AO (AWS to partners) Any further updates on the opportunity should not ﬂow through to AWS Partner AWS rejects sends opportuni opportuni ty ty (Create APN support case Stage 5: Testing 23 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) for request) 2 AO (AWS to AWS sends Partner accepts Partner should receive the updates with PII details partners) opportuni opportuni Verify the appropriate errors and are actionable Verify the
apc-crm-010	apc-crm.pdf	10	in the Amazon Simple Storage Service (Amazon S3) results folder) 1 AO (AWS to partners) Any further updates on the opportunity should not ﬂow through to AWS Partner AWS rejects sends opportuni opportuni ty ty (Create APN support case Stage 5: Testing 23 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) for request) 2 AO (AWS to AWS sends Partner accepts Partner should receive the updates with PII details partners) opportuni opportuni Verify the appropriate errors and are actionable Verify the opportunity is created in APN successfully ty ty (Create case for request) Partner creates 3 PO (Partner to AWS) opportuni ty without all details Partner creates 4 PO (Partner to AWS) opportuni ty with all mandatory and some optional ﬁelds Stage 5: Testing 24 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) 5 PO (Partner Partner creates AWS marks Partner is able to receive the update, make required changes, and send the updated values to AWS) opportuni the ty opportuni with ty as all action mandatory required and with some APN optional reviewer ﬁelds comments (Create APN support case for request) Stage 5: Testing 25 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) 6 PO (Partner Partner creates AWS rejects Partner should receive the disqualification. On Integration, they can’t see the disqualification reason. to AWS) opportuni the ty opportuni with ty all since mandatory it and doesn’t some have optional suﬃcien ﬁelds t details (Create APN support case for request) Update should be successful 7 PO (Partner Partner sends to AWS) update to an existing opportuni ty Stage 5: Testing 26 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) 8 PO (Partner AWS sends to AWS) update Partner should receive the correct information on an opportuni ty to partner Partner creates lead without all details 9 PO lead (Partner to AWS) Verify the appropriate errors and are actionable 10 PO lead (Partner Partner creates Verify the lead is created in APN successfully to AWS) 11 PO lead (Partner to AWS) lead with all mandatory and some optional ﬁelds Partner sends update to existing lead Update should be successful Stage 5: Testing 27 AWS Partner Central CRM Guide # Use cases Step 1 Step 2 Expected result (verify the response in the Amazon Simple Storage Service (Amazon S3) results folder) Partner should receive the correct information 12 PO lead (Partner AWS sends to AWS) update on a lead to partner Once you complete the testing, on the My Integration page, choose Mark testing complete to proceed to the next step. Partners building a custom Integration solution must share the results of the testing with AWS through a support case for validation. The test results from all scenarios must be attached to the support case. AWS validates the results, then enables the connection in production. After validation of test results, the Partner Alliance Lead receives an email notiﬁcation. The email conﬁrms that the Integration has moved to the UAT Passed stage. The email also provides the next step information, which is to update the ARN for production and conﬁgure historical data backﬁll. Stage 6: Production implementation At this point, the partner has thoroughly tested their solution in the sandbox environment. The next stage involves setting up the production environment and performing data migration to ensure all opportunities and leads can be managed through the integration. Production setup Moving CRM integration to Production Approved stage Before performing production conﬁguration for your CRM Integration, conﬁrm your IAM Identity and Access Management (IAM) user Amazon Resource Name (ARN) details for production access. 1. Access the CRM integration request page on Partner Central to conﬁrm that the sandbox implementation and testing is marked complete and moved to Production Approved stage. 2. To conﬁrm the IAM user ARN details used to access the production bucket, choose Update ARN for Prod. This opens the ARN details page from the request submission stage. Stage 6: Production implementation 28 AWS Partner Central CRM Guide 3. If the production IAM user ARN was provided at the time of the initial request submission, verify the ARN. 4. If the production IAM user ARN wasn’t provided initially (since it’s optional at that stage), you must be provide it now. 5. If you want to manage historical referrals via the new Integration, conﬁrm the data backﬁll process. To learn more, see Data backﬁll process. After determining the
apc-crm-011	apc-crm.pdf	11	to access the production bucket, choose Update ARN for Prod. This opens the ARN details page from the request submission stage. Stage 6: Production implementation 28 AWS Partner Central CRM Guide 3. If the production IAM user ARN was provided at the time of the initial request submission, verify the ARN. 4. If the production IAM user ARN wasn’t provided initially (since it’s optional at that stage), you must be provide it now. 5. If you want to manage historical referrals via the new Integration, conﬁrm the data backﬁll process. To learn more, see Data backﬁll process. After determining the need for data backﬁll and providing the IAM user ARN for the production bucket, choose Submit to ﬁnalize the setup. This action triggers the creation of the production bucket and the generation of the corresponding IAM user policies, paralleling the sandbox setup. For more information, refer to the section called “Stage 3: Sandbox setup”. After the production environment is successfully provisioned, the Partner Alliance Lead receives an email notiﬁcation. This notiﬁcation serves as conﬁrmation that the request for Integration has progressed to the Production Approved stage. The email also includes instructions on the subsequent steps, which involve: • Downloading the provided IAM policy. • Attaching the policy to the designated IAM user/role. • Accessing the production Amazon S3 bucket. • Deploying your Integration solution into the production environment. Finalizing production Integration To complete the Integration into the production environments: 1. Policy attachment: Obtain the custom IAM policy created speciﬁcally for your production environment. Attach this policy to the designated IAM user/role to ensure proper permissions are set. 2. Solution deployment: Depending on your Integration method, the deployment steps vary. • Custom solution: Implement the code that facilitates the connection to your production environment, to ensure that it’s conﬁgured to interact with the AWS services. • AWS Partner CRM connector: If you’re using the CRM connector, install it within your Salesforce production environment by following the guidelines AWS provides. Stage 6: Production implementation 29 AWS Partner Central CRM Guide • Third-party Integration: Coordinate with your third-party solution provider to transition your Integration from the sandbox to the production environment. Follow their recommended deployment procedures. 3. Credential management: Retrieve the production IAM credentials, which include the secret key and access key. Update your Integration solution with these credentials to authenticate your application with AWS services. 4. Data backﬁll completion: If you opted for data backﬁll, ensure that you followed the prescribed steps for this one-time process. Proper backﬁlling is essential to maintain continuity and integrity in your opportunity and lead management. Production connector implementation checklist To implement your connector in production, follow these steps: Step # User to perform step Step description 1 2 3 4 5 CRM/Salesforce administrator Download and install the AWS Partner CRM connector from the Salesforce AppExchange. CRM/Salesforce administrator Follow the guided setup to conﬁgure the named credentia l using the IAM user credentials and Amazon S3 bucket settings obtained from the CRM integration request page. CRM/Salesforce administrator Test the conﬁguration performed in the previous step. CRM/Salesforce administrator Follow the mapping guidance to complete the object mappings similar to your sandbox set up. Note: This is a manual eﬀort. Mapping from the sandbox cannot be exported and applied to your production Salesforce instance via the code pipeline. To learn more about complex mapping strategies, see ACE mapping guide for AWS Partner CRM connector Version 2.0. Complete backﬁll activities for handling historic referral data via the CRM connector. If needed, open a support Alliance lead and CRM/Salesforce administrator Stage 6: Production implementation 30 AWS Partner Central CRM Guide Step # User to perform step Step description case for live testing or backﬁll help with Partner Central Operations (PCO). 6 7 8 CRM/Salesforce administrator Set up a schedule using a user with an APN integration permission set to activate the connector. CRM/Salesforce administrator Alliance lead Validate the ﬂow of the data via the connector. Log in to the CRM integration request page on Partner Central and move the request to the Launched stage. Note: The Integration connection remains inactive until you complete the ﬁnal step described in Stage 7: Launch. This means you can securely establish all necessary connections without the risk of premature data transmission. Data backﬁll process If you decide to perform a data backﬁll, it aﬀects how your existing and future referrals are managed within the Integration. Data backﬁlling is the process of exporting existing referrals from the APN Customer Engagements (ACE) pipeline manager to your Amazon Simple Storage Service (Amazon S3) bucket and associating each with a unique identiﬁer for your CRM Integration. This ensures referrals can be identiﬁed during future updates and includes both AWS Originated (AO) and Partner Originated (PO) opportunity referrals. Important If you decide to backﬁll opportunities created on or after a
apc-crm-012	apc-crm.pdf	12	the risk of premature data transmission. Data backﬁll process If you decide to perform a data backﬁll, it aﬀects how your existing and future referrals are managed within the Integration. Data backﬁlling is the process of exporting existing referrals from the APN Customer Engagements (ACE) pipeline manager to your Amazon Simple Storage Service (Amazon S3) bucket and associating each with a unique identiﬁer for your CRM Integration. This ensures referrals can be identiﬁed during future updates and includes both AWS Originated (AO) and Partner Originated (PO) opportunity referrals. Important If you decide to backﬁll opportunities created on or after a speciﬁc start date, ensure that your integration solution includes a check to reject any AWS updates related to opportunities created before this backﬁll start date. This prevents your CRM from creating new records for historical opportunities you do not wish to maintain. Selecting No for data backﬁll If you select No for data backﬁll, it implies that you don’t need access to your existing opportunities and only plan to manage future referrals through CRM. If you do this and later Stage 6: Production implementation 31 AWS Partner Central CRM Guide decide to update your existing pipeline manager opportunities, all subsequent updates will replicate in CRM as net-new opportunities. This is because CRM doesn’t have a means (example: CRM unique identiﬁer) to associate existing pipeline manager referrals to the corresponding records in your CRM Amazon S3 bucket. To avoid this, you need to provide the partner CRM unique identiﬁer when you make future updates to existing opportunities. Selecting Yes for data backﬁll If you select Yes for data backﬁll (or initially selected No and now want to opt in for data backﬁll), you can complete the following one-time backﬁll process by using the bulk upload feature in ACE pipeline manager. 1. Sign in to AWS Partner Central. 2. Navigate to the Sell tab, and then choose Opportunity Management. 3. Choose Bulk Actions, and then choose Update Opportunities. 4. On the Bulk Update screen, download the pipeline of validated opportunities excel ﬁle (the instructions say Step 1: Download the pipeline of validated opportunities). 5. Open the excel ﬁle, and then in the partner CRM Unique Identiﬁer column, enter the CRM ID. Follow the guidance in Step 2: Manage opportunities in XLS ﬁle. 6. Save the ﬁle as a .csv and upload it in the ACE Pipeline Manager (this is Step 3: Upload saved CSV ﬁle). 7. Choose Update. 8. Review the Pipeline Upload tracker, and after it’s complete, close it. 9. Check the upload history for Records Processed, and if there are errors, download the error ﬁle. Correct the errors, and resubmit the ﬁle. Note Only approved AWS originated and partner originated opportunities that aren’t currently in submitted or closed lost status, are eligible for the data backﬁll process. Once validated, the opportunities can be synced to a partner’s CRM by populating a new CRM unique identiﬁer on the opportunity form, when making future updates. For more information about the data backﬁll process, refer to the Update Opportunities guidance in the Bulk Actions section of the ACE Bulk Functionality User Guide. For related inquiries, partners can raise a support case in Partner Central. Stage 6: Production implementation 32 AWS Partner Central Stage 7: Launch CRM Guide With the production environment conﬁgured and the data migration complete, it’s time to initiate the active phase of the Integration. The Partner Alliance Lead must choose Activate Integration to establish the live connection. This action enables the exchange of ﬁles through the designated Amazon Simple Storage Service (Amazon S3) bucket and marks the beginning of the Integration’s operational status. We encourage partners to share their experiences and any feedback using the feedback widget available on the My Integration page within Partner Central. For guidance on post-launch procedures, including maintenance and updates, refer to the section called “Maintenance”. If you have any questions or issues post-integration, we encourage you to seek support by creating AWS Partner Network (APN) support cases. For more information, refer to AWS Partner Support. The successful launch signiﬁes that the Integration is fully operational. Partners can now leverage the new capabilities to enhance sales operations, automate data exchanges, and foster greater collaboration with Amazon Web Services (AWS). AWS is committed to provide you with continued support to help you maintain and improve your Integrations. Stage 7: Launch 33 AWS Partner Central Glossary Glossary The following table contains a list of acronyms and terms. AcronymFull term Deﬁnition CRM Guide AWS Amazon Web Services A comprehensive, cloud computing platform oﬀered by AWS, providing a variety of services such as computing power, storage, and databases, accessible from the internet. APN AWS Partner Network A global partner program by AWS, designed to help partners build successful AWS-based businesses or solutions by providing business, technical, and marketing support.
apc-crm-013	apc-crm.pdf	13	Amazon Web Services (AWS). AWS is committed to provide you with continued support to help you maintain and improve your Integrations. Stage 7: Launch 33 AWS Partner Central Glossary Glossary The following table contains a list of acronyms and terms. AcronymFull term Deﬁnition CRM Guide AWS Amazon Web Services A comprehensive, cloud computing platform oﬀered by AWS, providing a variety of services such as computing power, storage, and databases, accessible from the internet. APN AWS Partner Network A global partner program by AWS, designed to help partners build successful AWS-based businesses or solutions by providing business, technical, and marketing support. ACE APN Customer Engagements A program that facilitates collaboration between AWS and its partners, helping to drive customer engagements and coselling opportunities. CRM Customer Relationship Management A strategy and software solution used by businesses for improving relationships and interactions with current and potential customers. AWS IAM AWS Identity and Access A web service that helps to securely control access to AWS resources by enabling the creation and management of AWS users and groups and Management assigning permissions. ISV Independe nt Software Vendor A company that specializes in creating and selling software, typically designed for mass or niche markets. This is in contrast to in-house software which is created by a user organization for its own use. PDM Partner Development Manager A role within the AWS Partner Network, responsible for improving relationships with AWS Partners, helping them grow and improve their oﬀerings on AWS. Glossary 34 AWS Partner Central Data security Data security and compliance Security CRM Guide At Amazon Web Services (AWS), cloud security is of the highest importance. Our customers reap the beneﬁts of a data center and network architecture engineered to cater to the needs of the most security-sensitive organizations. The security model at AWS is a Shared Responsibility Model between AWS and its customers. This is articulated as security of the cloud and security in the cloud. Customer responsibility AWS is responsible for protecting the infrastructure that runs all of the services oﬀered in the AWS Cloud. This infrastructure is composed of the hardware, software, networking, and facilities that run AWS Cloud services. Security in the cloud Customer responsibility is determined by the AWS Cloud services that a customer selects. This determines the amount of conﬁguration work the customer must perform as part of their security responsibilities. For example, a service such as Amazon Elastic Compute Cloud (Amazon EC2) is categorized as infrastructure as a service (IaaS) and as such, requires the customer to perform all of the necessary security conﬁguration and management tasks. Customers that deploy an Amazon EC2 instance are responsible for management of the guest operating system (including updates and security patches), any application software or utilities installed by the customer on the instances, and the conﬁguration of the AWS-provided ﬁrewall (called a security group) on each instance. For abstracted services, such as Amazon Simple Storage Service (Amazon S3) and Amazon DynamoDB, AWS operates the infrastructure layer, the operating system and platforms, and customers access the endpoints to store and retrieve data. Customers are responsible for managing their data (including encryption options), classifying their assets, and using AWS Identity and Access Management (IAM) tools to apply the appropriate permissions. • AWS undertakes regular evaluations of its privacy and security policies to ensure they align with the prevailing regulatory and industry standards. • In line with local legal frameworks, background veriﬁcation is conducted for all potential employees, contractors, and associated third parties. Data security 35 AWS Partner Central CRM Guide • AWS mandates all personnel to sign a nondisclosure agreement (NDA) or conﬁdentiality agreement to safeguard customer information. Amazon S3 bucket conﬁguration • An S3 bucket is instantiated within AWS’s internal account, mitigating any additional costs for partners integrating CRM with AWS. • Each partner engaging with AWS is provisioned with their distinct S3 bucket in both environments, sandbox and production. • Programmatic access to the respective bucket is granted to each partner, under the control of a custom access policy. • Access is restricted to AWS’s internal technical team for debugging purposes, subject to contingent authorization. • All access endeavors to the bucket are logged, as elaborated in Server Access Logging. Certiﬁcations and audits AWS is subjected to these third-party audits for certiﬁcations: • SOC2 • ISO 27001 • ISO 27017 • ISO 27018 These certiﬁcation reports are accessible in the compliance resources. For more information, refer to AWS Cloud Security Compliance FAQs and the Shared Responsibility Model. Legal Opportunity sharing Prior to disseminating any opportunity with an AWS Partner, AWS Sales personnel are mandated to secure customer consent. This protocol is adhered to for referrals shared through both APN Customer Engagements (ACE) pipeline manager and partner CRM Integration. Membership terms • Engagement in the AWS Partner Network is regulated by the AWS Partner
apc-crm-014	apc-crm.pdf	14	AWS is subjected to these third-party audits for certiﬁcations: • SOC2 • ISO 27001 • ISO 27017 • ISO 27018 These certiﬁcation reports are accessible in the compliance resources. For more information, refer to AWS Cloud Security Compliance FAQs and the Shared Responsibility Model. Legal Opportunity sharing Prior to disseminating any opportunity with an AWS Partner, AWS Sales personnel are mandated to secure customer consent. This protocol is adhered to for referrals shared through both APN Customer Engagements (ACE) pipeline manager and partner CRM Integration. Membership terms • Engagement in the AWS Partner Network is regulated by the AWS Partner Network Terms and Conditions. Data security and compliance 36 AWS Partner Central CRM Guide • Enrollment in the ACE program is directed by the APN Customer Engagements Terms and Conditions. • Participation in any beta programs extended by AWS to partners is governed by the AWS Service Terms. Data security and compliance 37 AWS Partner Central Maintenance CRM Guide In this section, we describe routine maintenance requirements for the AWS Partner Customer Relationship Management (CRM) Integration. • Monitoring AWS updates: Stay current with AWS updates to processes and data models that may aﬀect the CRM Integration. • Adopting new features: Embrace new features and enhancements released by AWS to ensure your CRM Integration remains contemporary and eﬃcient. Release cadence While there isn’t a ﬁxed release cadence, updates typically roll out two to four times a year. These updates may encompass new features, adjustments to data models, or alterations in AWS processes which could necessitate modiﬁcations to your CRM Integration. Partner expectations It’s imperative for partners to allocate resources for regular maintenance and upgrades to their CRM Integration, in accordance with the updates from AWS. Here’s what is generally expected: • Investment in maintenance: Dedicate time and resources to assimilate updates from AWS and implement necessary upgrades to your CRM Integration. • Communication: AWS usually informs the Partner Alliance Lead about the updates and associated timelines. Ensure open communication channels to receive these critical updates in a timely manner. Recommended resource allocation We recommend every quarter, partners designate two to four weeks of developer and sales operations time to focus on upgrading and maintaining the systems post each update. This time investment is essential to ensure that the AWS Partner CRM Integration continues to operate seamlessly and leverages the latest advancements and features provided by AWS. Maintenance 38 AWS Partner Central FAQ CRM Guide This section covers some frequently asked questions about the CRM Integration. Q: How do I contact my Partner Development Manager (PDM)? To ﬁnd contact information for your Partner Development Manager: 1. Sign in to Partner Central. 2. Choose Support, and then choose the Partner Development Manager name. Q: How do I ﬁnd my Partner ID or SPMS ID? To ﬁnd your Partner ID or SPMS ID: 1. Sign in to Partner Central. 2. Choose My company, and see your ID under Overview. Q: Is there any cost associated with the AWS account? No. There is no cost associated with the AWS account. Troubleshooting Raising support cases If you still have diﬃculties integrating your CRM with AWS, you can raise a support case by following these steps: 1. Sign in to the AWS Partner Central with your AWS Partner Network credentials. 2. On the Support Center for Partner Central, choose Open New Case to log a new case. Complete the ﬁelds below. i. Type of Support Case: AWS Partner Central. ii. Question regarding: Partner Central Tools or ACE leads and opportunities. iii. Get Speciﬁc: Select the most appropriate CRM Integration case type. iv. Subject: Include a brief description of the request. v. Description: Provide a detailed description of issues, questions, errors, and troubleshooting steps. vi. Attachments: Synch logs and screenshots, where applicable. FAQ 39 AWS Partner Central CRM Guide Troubleshooting during CRM Integration onboarding A few common error messages and resolutions are shown in the following table. #Error message Error condition Resolution steps 1Only Alliance Lead contact can make this request. When anyone other than an Alliance Lead (ACE eligible) tries to: update request For internal user: Verify if the status, access request details, abandon partner account is request, create new request. ACE eligible. 2Failed to mark implement ation as complete. Please try again. When you try to mark a request as implementation complete but there is any error that occurred during the update. Contact the support team. 3No Request received. When you try to abandon a request and there are no requests to abandon. 4Your request could not be taken at this time because Occurs when there is any issue when abandoning a request or during request Contact the support team. of an internal error. Check processing, if there is any exception. again after some time. 5Please provide ARN Details for the IAM User/Role to provision bucket
apc-crm-015	apc-crm.pdf	15	ation as complete. Please try again. When you try to mark a request as implementation complete but there is any error that occurred during the update. Contact the support team. 3No Request received. When you try to abandon a request and there are no requests to abandon. 4Your request could not be taken at this time because Occurs when there is any issue when abandoning a request or during request Contact the support team. of an internal error. Check processing, if there is any exception. again after some time. 5Please provide ARN Details for the IAM User/Role to provision bucket for … If beta/prod ARN is not provided. 6Duplicate Request: Bucket ARN details already created and provisioned for this IAM User/Role. Occurs when another request is created for the same partner with the same IAM details and the request is not abandoned. IAM details provided cannot be empty. Ensure the IAM details are provided. Abandon the existing request. 7Please update the IAM ARN details in the existing request. Occurs when the system tried to process the request and the request failed due to an error. Update the IAM ARN details and resubmit. Troubleshooting 40 AWS Partner Central CRM Guide #Error message Error condition Resolution steps 8Your request could not be taken at this time because After a request is submitted and something during the processing failed. Contact the support team. of an internal error. Check again after some time. Troubleshooting 41 AWS Partner Central CRM Guide AWS Partner CRM connector About The AWS Partner Customer Relationship Management (CRM) connector oﬀers a no-code solution to integrate Salesforce with AWS. With this integration, you can manage cosales activities within your Salesforce environment while collaborating with AWS services. The connector also oﬀers the ability for you to integrate with AWS Marketplace. This guide helps you set up and use the AWS Partner CRM connector. Introduction AWS Partner integration engineering oﬀers a new AWS managed package for AWS Partners who use Salesforce CRM. With this CRM connector for Salesforce, AWS Partners can install a managed package directly on their Salesforce organization instead of developing and maintaining custom code for the CRM integration. This CRM connector package is a no-code solution for partners to scale their lead and opportunity pipeline management, as well as their AWS Marketplace business, and is available for free from the Salesforce app exchange. AWS Partner CRM connector application You can install, upgrade, and uninstall the AWS Partner CRM connector application from the Salesforce App Exchange. Installing the AWS Partner CRM connector package 1. Navigate to AWS Partner CRM connector. 2. Choose Get it now. 3. Choose Install in sandbox. 4. Conﬁrm the installation details. 5. Choose Install for administrators only. 6. Choose Install. The package installation takes a few minutes to complete. About 42 AWS Partner Central CRM Guide Upgrading the AWS Partner CRM connector package Before upgrading the AWS Partner CRM connector package in your production Salesforce organization, refer to ACE integration and AWS Marketplace integration transisition recommendations and plan for sandbox testing. 1. Navigate to AWS Partner CRM connector. 2. Choose Get it now. 3. Choose Install in sandbox. 4. Conﬁrm the installation details. 5. Choose Install for administrators only. 6. Choose Upgrade. Note To upgrade from a previous version of the connector, ﬁrst upgrade the connector in your Salesforce organization, then complete the procedures in Upgrading from previous versions. Conﬁrming AWS Partner CRM connector installation • To conﬁrm package installation or upgrade, choose Home, Apps, Packaging, Installed Packages. Uninstalling the CRM connector package Before uninstalling the AWS Partner Central CRM connector, remove any user ACE integration permission sets and AWS Marketplace integration permission sets. Uninstalling the package 1. Choose Home, Apps, Packaging, Installed Packages. 2. Choose Uninstall. Uninstalling the CRM connector package 43 AWS Partner Central Available features CRM Guide The lists in the following sections describe the features provided by the AWS Partner Central API and the AWS Partner CRM connector for Salesforce. Topics • Partner Central API features • ACE features • AWS Marketplace features Partner Central API features AWS Partner Central API provides the following features: • A set of buttons that partners can use to help speed their operations: • Share with AWS – Create and update an opportunity. • Approval Status – Accept or reject AWS Referred Opportunities. • Associate or Disassociate – Associate or disassociate an opportunity with Partner Solutions, AWS Products, and AWS Marketplace Oﬀers throughout the opportunity lifecycle. • Assign – Reassign an opportunity to another user within your Partner Central account. • In the connector, partners can use the Solution oﬀering tab to view a list of available solutions. • Partners can use the AWS Marketplace notiﬁcations tab to view the events generated by AWS EventBridge. Events include Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, and Engagement Invitation
apc-crm-016	apc-crm.pdf	16	– Create and update an opportunity. • Approval Status – Accept or reject AWS Referred Opportunities. • Associate or Disassociate – Associate or disassociate an opportunity with Partner Solutions, AWS Products, and AWS Marketplace Oﬀers throughout the opportunity lifecycle. • Assign – Reassign an opportunity to another user within your Partner Central account. • In the connector, partners can use the Solution oﬀering tab to view a list of available solutions. • Partners can use the AWS Marketplace notiﬁcations tab to view the events generated by AWS EventBridge. Events include Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, and Engagement Invitation Rejected. Note • To start using the AWS Partner Central API, see AWS Partner Central API prerequisites, later in this section. • If you want to migrate from the ACE CRM integration to the AWS Partner Central API, see Upgrading to the Partner Central API before proceeding. Available features 44 AWS Partner Central ACE features CRM Guide The AWS Partner CRM connector for Salesforce integrates with AWS Marketplace and APN customer engagements (ACE). The following sections describe features that are supported by AWS Marketplace and ACE. • AWS originated opportunities — This lets you receive opportunities directly from AWS within your Salesforce CRM. These opportunities are potential cosell deals where AWS identiﬁes a customer that could beneﬁt from your solution. • Partner-originated opportunities — This facilitates creating and managing cosell opportunities that you identify. You can create opportunities within Salesforce and link them to relevant AWS services that can help streamline collaboration eﬀorts with AWS. • AWS lead referrals — This lets you receive leads from AWS that might be a good ﬁt for your oﬀerings. These leads could be potential customers who expressed an interest in solutions like yours. • Dashboard — This provides a centralized overview within Salesforce of your cosell activities with AWS. Depending on your conﬁguration, this can include opportunities and leads. AWS Marketplace features Multiple AWS Marketplace seller accounts — Manage private oﬀers, resale authorizations, and other functions for your AWS Marketplace seller accounts within a single Salesforce instance. Supported AWS Marketplace product types — The connector currently integrates with the following AWS Marketplace product types: • SaaS • AMI • Containers Dashboards — Provide a consolidated overview of your private oﬀers within Salesforce. Independent software vendor (ISV) features AWS Marketplace products ACE features 45 AWS Partner Central CRM Guide View your existing AWS Marketplace product listings within Salesforce. This lets you manage your product portfolio and cosell activities. Private oﬀers Create and manage private oﬀers for your listed AWS Marketplace products within Salesforce. Flexible payment schedules are available for all supported private oﬀers. Future dated agreements are supported only for private SaaS and contract oﬀerings. Import existing private oﬀers You can expedite the transition process by importing existing AWS Marketplace oﬀers directly into the connector. Private oﬀer management • Create/publish — Publish private oﬀers from within Salesforce. • Draft — Save private oﬀers as drafts for future editing before publishing them. • Modify — Modify the private oﬀer's expiration date. • Cancel — Remove oﬀers that have been published. • Clone — Create a copy of an existing private oﬀer as a starting point for a new oﬀer. Agreements • View — Access and reference existing AWS Marketplace agreements in Salesforce. • Import — To centralize management, import existing agreements from AWS Marketplace into the connector. Agreement-based oﬀers • Creating agreement-based oﬀers — Use existing agreements to create targeted customer oﬀers, which helps to simplify the quoting and purchasing process. Resale authorizations Manage the lifecycle of resale authorizations within Salesforce, which includes the following: • Create/publish — Create a resale authorization to authorize an AWS channel partner to resell your product. AWS Marketplace features 46 AWS Partner Central CRM Guide • Draft — Save resale authorization requests for further review before submitting them. • Deactivate — If a resale authorization is no longer required, you can deactivate it within the connector. • Clone — Clone existing resale authorizations to expedite the creation of new resale authorizations. Channel partner features If you're part of the AWS Marketplace channel partner program, you can use shared-resale authorizations to simplify the process of reselling products to your channel partners. The connector lets you do the following: • View — Access and review shared-resale authorizations within Salesforce. • Manage — Channel partner private oﬀers have the same functions as private oﬀers, such as Create/publish, Modify, Cancel, and Clone. Release notes This section contains the release history for the AWS Partner Customer Relationship Management (CRM) Connector for Salesforce. Topics • Version 3.8 (April 17, 2025) • Version 3.6 (March 18, 2025) • Version 3.5 (January 22, 2025) • Version 3.1 (December 2, 2024) • Version 3.0 (November 14, 2024) • Version 2.2 (April 24, 2024) • Version 2.1 (April 18,
apc-crm-017	apc-crm.pdf	17	partners. The connector lets you do the following: • View — Access and review shared-resale authorizations within Salesforce. • Manage — Channel partner private oﬀers have the same functions as private oﬀers, such as Create/publish, Modify, Cancel, and Clone. Release notes This section contains the release history for the AWS Partner Customer Relationship Management (CRM) Connector for Salesforce. Topics • Version 3.8 (April 17, 2025) • Version 3.6 (March 18, 2025) • Version 3.5 (January 22, 2025) • Version 3.1 (December 2, 2024) • Version 3.0 (November 14, 2024) • Version 2.2 (April 24, 2024) • Version 2.1 (April 18, 2024) • Version 2.0 (November 29, 2023) • Version 1.7 (October 12, 2022) • Version 1.6 (January 13, 2023) • Version 1.5 (January 13, 2023) • Version 1.4 (December 7, 2022) Release notes 47 AWS Partner Central CRM Guide Version 3.8 (April 17, 2025) AWS Partner CRM Connector version 3.8 contains the following features and improvements. Bug ﬁxes • Fixed an issue where the APN CRM ID was not getting updated on the Opportunity post synchronization. • Fixed an issue when trying to refresh Marketplace products where a seller had more than 50 listed products. • Fixed an issue where the AWS Sales Rep and AWS Account Manager ﬁelds in the ACE object were not displaying the full name. Version 3.6 (March 18, 2025) AWS Partner CRM Connector version 3.6 contains the following features and improvements. AWS Marketplace • Added support for 8 decimal places (increased from 3) in pay-as-you-go pricing for software as a service (SaaS) products, which aligns with AWS Marketplace pricing standards. Bug ﬁxes • Partners can now create opportunities directly in Partner Central. These opportunities automatically sync with the partner's Salesforce organization via AWS Partner CRM connector. This improves the referral process and enhances collaborations between partners and AWS. • Fixed an issue where an opportunity sync fails with NUMBER_VALUE and can't be converted to a string when SaaS revenue recognition program (SRRP) ﬁelds are updated. • Resolved data sharing issue to prevent AWS referrals from being incorrectly processed as partner opportunities during APN synchronization. • Fixed ReviewStatus ﬁeld from changing to null on an approved opportunity after updating an allowed ﬁeld. • Implemented new ﬁeld mapping for Next Step History to accommodate larger data volumes and prevent sync failures. Version 3.8 (April 17, 2025) 48 AWS Partner Central CRM Guide • Resolved ACE opportunity activation ﬂow issues by implementing proper update logic for APN CRM Unique Identifier ﬁeld in an ACE opportunity record. • Updated and corrected guided setup instructions for a better user experience. Note If you upgrade to version 3.6, you must map the Next Step History ﬁeld on the ACE Mappings tab. Version 3.5 (January 22, 2025) AWS Partner CRM Connector version 3.5 contains the following features and improvements. AWS Partner Central API • You can now enable sandbox catalog using the PC API Sandbox Enabled checkbox in Custom Settings, AWS Partner CRM Connector Settings. • Updated product catalog. AWS Marketplace • You can now import details of resale authorizations created outside the CRM connector. • Added support to view up to 8 decimal points, where applicable. Bug ﬁxes • Fixed issue with a new installation of CRM connector Version 3.1, sync failure reporting with error message Field Level Security error on field: awspn_Campaign name_new_c. • Fixed issue with duplicate AWS Markeplace product names causing upsert failure. • Fixed issue preventing the ACE opportunity tab from being set as the default view for the ACE permission sets. Version 3.5 (January 22, 2025) 49 AWS Partner Central CRM Guide Version 3.1 (December 2, 2024) AWS Partner CRM Connector version 3.1 contains the following features and improvements. Bug ﬁxes • Fixed the production URL for AWS Partner Central API. • Fixed issues with change to Engagement Invitation Payload. Version 3.0 (November 14, 2024) AWS Partner CRM connector 3.0 contains the following features and improvements: Core features Multi-object mapping • Partners can now map ﬁelds from multiple Salesforce objects, including lookup and master- detail relationships, to the APN opportunity and lead schemas. • Improved UI for mapping ﬁelds, including expandable views for lookup ﬁelds. • Support for up to two levels of object relationships in a single mapping. ACE CRM Integration features AWS Partner Central API Support • The ACE integration user is not required for AWS Partner Central integrations • Inbound and outbound synchronization schedules between Salesforce and AWS Partner Network (APN) are no longer required. • The AWS Partner CRM connector handles synchronous errors. AWS Partner Central API support for AWS originated opportunities (AO) and partner-originated opportunities • Partners can use the Share with AWS button to create and update opportunities. • Partners can use the Approval Status button to accept or reject AWS referred opportunities. Version 3.1 (December 2, 2024) 50 AWS
apc-crm-018	apc-crm.pdf	18	a single mapping. ACE CRM Integration features AWS Partner Central API Support • The ACE integration user is not required for AWS Partner Central integrations • Inbound and outbound synchronization schedules between Salesforce and AWS Partner Network (APN) are no longer required. • The AWS Partner CRM connector handles synchronous errors. AWS Partner Central API support for AWS originated opportunities (AO) and partner-originated opportunities • Partners can use the Share with AWS button to create and update opportunities. • Partners can use the Approval Status button to accept or reject AWS referred opportunities. Version 3.1 (December 2, 2024) 50 AWS Partner Central CRM Guide • Partners can use the Associate or Disassociate buttons to associate or disassociate opportunities with Partner Solutions, AWS Products, and AWS Marketplace Oﬀers throughout the opportunity lifecycle. • Partners can use the Assign button to reassign opportunities to other users in their Partner Central account. • Partners can use the Solution oﬀering tab to view a list of available solutions. • Partners can view the events on the AWS Marketplace Notiﬁcation tab, such as Opportunity Created, Opportunity Updated, or Engagement Invitation Created. • Three new ﬁelds added for opportunities: • Opportunity Engagement Invitation ARN • Opportunity Type • Visibility Bug ﬁxes • Fixed an issue where the connector, upon receiving inbound data, overrides the account associated with opportunities to a default account provided in the custom settings, leading to internal Salesforce conﬂicts and validation errors • Fixed an issue where the connector encountered errors in inbound and outbound sync logs due to an invalid SalesActivity ﬁeld value of Finalized Deployment Needs. • Fixed an issue when trying to refresh shared resale authorizations. Version 2.2 (April 24, 2024) AWS Partner CRM connector version 2.2 contains the following features and improvements. Core features Enhancements to the existing resale authorization feature to support non-legacy products. Version 2.1 (April 18, 2024) AWS Partner CRM connector version 2.1 contains the following features and improvements. Version 2.2 (April 24, 2024) 51 AWS Partner Central Core features CRM Guide Channel Partners can create a synchronization schedule for shared resale authorizations. AWS Marketplace integration for ISV sellers and Channel Partners • You can modify the usage duration on released oﬀers for eligible products. • Support for future dated agreements (FDA) for private oﬀers. • You can import details of private oﬀers created outside of the CRM connector. • You can save private oﬀers and resale authorizations as drafts. • You can retrieve and view agreements for private oﬀers and public oﬀers. • You can create agreement-based oﬀers across multiple seller accounts for SaaS Contract products and SaaS Contract products with consumption accounts. ACE CRM integration • Enhanced Salesforce Lightning record form for AWS delivered ACE opportunity objects. • You can surface sync log detail records per opportunity on AWS delivered ACE opportunity objects. • You can link available AWS Marketplace private oﬀers to an opportunity on the AWS delivered ACE opportunity object. Version 2.0 (November 29, 2023) Core features • Modularized Application–single SF AppExchange app for both ACE CRM Integration and AWS Marketplace Seller integration features APN Customer Engagements (ACE) integration • Support for new data model (v14) with the ACE CRM integration. • Creates custom objects for ACE opportunities and leads which contains all the attributes/ values as deﬁned by the ACE CRM integration with new data model validations on the custom opportunity objects. Version 2.0 (November 29, 2023) 52 AWS Partner Central CRM Guide • One-click automapping capability for new ACE custom objects to expedite mapping with installed custom objects for opportunities and leads. • Fix for mapping missing attributes on opportunities. • Fix for associating AWS opportunities to an account if using a standard opportunity for mapping. AWS Marketplace integration • As an ISV seller: • Synchronize available MP Products into Salesforce organization. • Create, view and manage ISV Private Oﬀers on SaaS, AMI, and Container products. • Cancel and modify private oﬀers. • Clone private oﬀers to create new oﬀers. • Create resale authorizations on SaaS, AMI, and container products. • Cancel and modify resale authorizations. • Clone resale authorizations. • Receive notiﬁcations when buyers subscribe to private oﬀers. • View dashboard of private oﬀers and shared resale authorizations created through the connector. • As an AWS Channel Partner: • Synchronize and view shared resale authorizations created by the ISV seller. • Create and manage AWS Channel Partner private oﬀers for SaaS, AMI, and container products from shared resale authorizations. Version 1.7 (October 12, 2022) Change log User interface • Add AWS Partner Network review comments optional ﬁeld to mapping screen. • Move the help section to the Guided setup page. Version 1.7 (October 12, 2022) 53 AWS Partner Central Bug ﬁxes CRM Guide • Fix an issue where incorrect payload was being displayed in synclog detail source record in
apc-crm-019	apc-crm.pdf	19	through the connector. • As an AWS Channel Partner: • Synchronize and view shared resale authorizations created by the ISV seller. • Create and manage AWS Channel Partner private oﬀers for SaaS, AMI, and container products from shared resale authorizations. Version 1.7 (October 12, 2022) Change log User interface • Add AWS Partner Network review comments optional ﬁeld to mapping screen. • Move the help section to the Guided setup page. Version 1.7 (October 12, 2022) 53 AWS Partner Central Bug ﬁxes CRM Guide • Fix an issue where incorrect payload was being displayed in synclog detail source record in partial failure case. • Fix an issue where partners already updated the partner CRM unique identiﬁers in ACE to auto correct based on target object in organization. • Fix an issue to stop opportunity updates being sent that have not yet been approved after the initial create request to AWS Partner. This is to prevent validation error responses being received back from AWS Partner due to the opportunity not being in approved status. Known issues Not applicable. Version 1.6 (January 13, 2023) Change log User interface • Add component to allow partners to raise support cases through AWS Partner Central. This is available on the Guided Setup page in the app. • Administrators can correct data received in inbound payload to ﬁx incorrect picklist values so they can be processed. Sync log cleanup Old sync log records are cleaned up automatically based on the application custom setting Sync Log Retention. This feature allows partners to conﬁgure how long they want to retain inbound and outbound synchronization log records. Bug ﬁxes • Update validation message when an unmapped picklist value is present in inbound payload to indicate the incorrect value. • Update outbound job ﬁlter to utilize conﬁgured retry count and retry days in application custom setting to auto retry the transaction once data is corrected, until number of retries is exceeded. Version 1.6 (January 13, 2023) 54 AWS Partner Central Known issues Not applicable. Version 1.5 (January 13, 2023) Change log User interface CRM Guide • Update labels on scheduling modal. • Update validation error messages on scheduling screen to provide more context to users on scheduling failures. • Update the title of the application in all references with "AWS Partner CRM connector". • Opportunity/lead page • Update Eligible to Sync with APN ﬁeld label to Has Updates for AWS. • Update Sync with Partner Central ﬁeld label to Sync with AWS. • Guided Setup page • Update Enter Authentication details ﬁeld label to Set up the APN AWS connection. • Update SPMS ﬁeld label to Partner ID. • Update Map APN AWS ﬁelds to Salesforce ﬁelds. • Mapping page • Update ACE pipeline manager ﬁelds to AWS ﬁelds. • Update Enable APN updates ﬁelds to Enable Inbound Updates ﬁelds. • Sync Logs page • Replace references to "APN" with "AWS" (direction). • Update the following sync log purpose ﬁelds labels: Inbound Orchestration to Inbound File Retrieval, Inbound Orchestration—Record Retrieval to Inbound Record Retrieval, and Outbound Orchestration to Outbound File Retrieval. Instantaneous synchronization Administrators can initiate a speciﬁc outbound synchronization for a single record through an added quick action. The quick action Send to AWS was added to the standard opportunity and lead Version 1.5 (January 13, 2023) 55 AWS Partner Central CRM Guide object for reference. It can be added to any integrated standard or custom object to provide the option to immediately invoke the synchronization for a single record outside of the scheduled jobs. Bug ﬁxes • Fix an issue on the sync log that showed an incorrect FLS exception error. • Fix an issue on the Lead object when the campaignMemberStatus ﬁeld is mapped. • Fix a mapping issue where the awsFieldEngagement and awsAccountId ﬁelds were being excluded from the outbound mapping, when mapped. • Update bundled dashboards from dynamic to static so they don't use the installed organization's limit for dynamic dashboards. Known issues Not applicable. Version 1.4 (December 7, 2022) Change log User interface • Simplify interface for sync logs. • Simplify interface for mapping modal. • Add conﬁrmation modal to reset button on Mapping screen. • Disable Next option on picklist mapping until all ﬁelds are completed. • Add help text to tab titles in mapping modal. • Update app label from APN CRM Administration to AWS Partner CRM connector. Reports and dashboards Add new reports and dashboards for tracking sync log statuses. Flow template Add ﬂow template to the package for setting custom push notiﬁcation to business administrators on sync log errors. Version 1.4 (December 7, 2022) 56 AWS Partner Central Bug ﬁxes CRM Guide • Fix issue on date oﬀset with UTC in mapping. • Fix an issue when a partially processed sync log was picked for reprocessing, when encountering an error,
apc-crm-020	apc-crm.pdf	20	ﬁelds are completed. • Add help text to tab titles in mapping modal. • Update app label from APN CRM Administration to AWS Partner CRM connector. Reports and dashboards Add new reports and dashboards for tracking sync log statuses. Flow template Add ﬂow template to the package for setting custom push notiﬁcation to business administrators on sync log errors. Version 1.4 (December 7, 2022) 56 AWS Partner Central Bug ﬁxes CRM Guide • Fix issue on date oﬀset with UTC in mapping. • Fix an issue when a partially processed sync log was picked for reprocessing, when encountering an error, the status on the sync log doesn’t change to Error. • Update eligible to sync formula on standard opportunity and lead. • Hide read-only ﬁelds. • Update to loading spinners. • Update label for modal subtitle. • Retain apnValues_ on _tab3 in the mapping modal. • Update the Edit option so it takes the user to the current page. • Disable tab selection unless in read-only mode. • Disable field required error when optional. • Change modal checkmarks to green. • Add mapping tab components and utilities. • Add new dashboard and dashboard folder for sync logs. • Remove permission for deprecated custom report tab. Known issues Error when mapping the CampaignMemberStatus on the Lead object. Currently, AWS Partners can skip mapping this non-mandatory ﬁeld when mapping leads. Fix will be in the next version. Upgrading to the Partner Central API The steps in the following sections explain how to upgrade from the ACE CRM integration to the AWS Partner API. The upgrade removes the need for several ACE requirements, such as the need for an integration user, and the need to set up synchronization schedules. Upgrade features The upgrade provides the following features: • You no longer need an ACE integration user. • You no longer need to create inbound and outbound synchronization schedules. Upgrading to the Partner Central API 57 AWS Partner Central CRM Guide • The CRM connector handles synchronous errors. • The API provides a set of buttons that enable the following actions on your Opportunity Lightning Record page: • Approval Status – Accept or reject AWS Referred Opportunities. • Share with AWS – Create and update opportunities. • Associate or Disassociate – Associate or disassociate an opportunity with Partner Solutions, AWS Products, and AWS Marketplace Oﬀers throughout the opportunity lifecycle. • Assign – Reassign an opportunity to another user in your Partner Central account. Set up named credentials To upgrade to the AWS Partner API, you ﬁrst set up named credentials. For more information, see Partner Central API setup, in this guide. Add the Approval Status button to the Opportunity Lightning Record page The following steps explain how to add the Approval Status button to the record page for your Lightning Experience. The button enables you to see the status of your opportunities as they go through the approval process. To add the button 1. Sign in to your Salesforce organization as a system administrator. 2. Navigate to the Opportunity Lightning Record page. 3. Choose the highlighted panel to open the properties pane. 4. Select Upgrade now. 5. Select Migrate existing actions, then select the page layout from which you want to migrate the actions. –or— Start from scratch and add the actions manually. 6. From the Actions list, choose Approval Status. 7. Choose Save. Set up named credentials 58 AWS Partner Central Note CRM Guide • You only need to complete steps 4 and 5 once. • The Approval status button only appears in the Opportunity Lightning Record page for AWS Referred opportunities. Add the remaining buttons You can add some or all of the buttons listed in the following steps. To add the buttons 1. Sign in to your Salesforce organization as a system administrator. 2. Navigate to the Opportunity Lightning Record Page. 3. Choose the highlighted panel to open the properties pane. 4. Choose Assign from Actions, then select some or all of the following items: • Share with AWS • Associate or Disassociate • Assign For more information about what each button does, see Upgrade features, earlier in this section. 5. Choose Save. Refresh the solutions on the Solution Oﬀerings tab 1. Sign in to your Salesforce organization as a system administrator. 2. Navigate to the Solution Oﬀerings tab. 3. Select Refresh Solutions. Upgrading from previous versions After upgrading to version 3.6, map the Next Step History ﬁeld for the opportunity object in the ACE Mappings tab. For more information, see ACE object mappings. Add the remaining buttons 59 AWS Partner Central CRM Guide After upgrading to version 3.5 or later, add the Import Resale Authorization button to the Resale authorization tab. To add the Import Resale Authorization button to the Resale authorization tab 1. Log in to your Salesforce organization
apc-crm-021	apc-crm.pdf	21	1. Sign in to your Salesforce organization as a system administrator. 2. Navigate to the Solution Oﬀerings tab. 3. Select Refresh Solutions. Upgrading from previous versions After upgrading to version 3.6, map the Next Step History ﬁeld for the opportunity object in the ACE Mappings tab. For more information, see ACE object mappings. Add the remaining buttons 59 AWS Partner Central CRM Guide After upgrading to version 3.5 or later, add the Import Resale Authorization button to the Resale authorization tab. To add the Import Resale Authorization button to the Resale authorization tab 1. Log in to your Salesforce organization as a system administrator. 2. Choose Setup, Object Manager. 3. Choose Resale authorization. 4. In the left navigation pane, choose List View Button Layout. 5. Choose Edit to open the list view editor. 6. In the Custom Buttons section, in the Available Buttons column, choose Import Resale Authorization. 7. Choose the right-arrow button to add Import Resale Authorization to the Selected Buttons list. 8. Choose Save. After upgrading to version 2.2 or later, do the following: • To ensure that your product information is current, refresh your products on the Refresh Products tab. • Follow the procedures in this section to complete the transition to version 2.2. To add the Import Oﬀer button to the Private Oﬀers tab 1. Log in to your Salesforce organization as a system administrator. 2. Choose Setup, Object Manager. 3. Choose Private Oﬀer. 4. In the left navigation pane, choose List View Button Layout. 5. Choose Edit to open the list view editor. 6. In the Custom Buttons section, in the Available Buttons column, choose Import Oﬀer. 7. Choose the right-arrow button to add Import Oﬀer to the Selected Buttons list. 8. Choose Save. Upgrading from previous versions 60 AWS Partner Central CRM Guide To add the Import Agreement button to the Agreements tab 1. Log in to your Salesforce organization as a system administrator. 2. Choose Setup, Object Manager. 3. Choose Agreement. 4. In the Details section, choose Edit. 5. Choose Allow Search. 6. Choose Save. 7. 8. In the left navigation pane, choose List View Button Layout. In the Custom Buttons section, in the Available Buttons column, choose Import Agreement. 9. Choose the right-arrow button to add Import Agreement to the Selected Buttons list. 10. Choose Save. To add sync log details to the ACE Opportunity Record page 1. Log in to your Salesforce organization as a system administrator. 2. Choose Setup, Object Manager. 3. Choose ACE Opportunity. 4. In the left navigation pane, choose ACE Opportunity Layout. 5. Choose Related Lists. 6. Choose and move Sync Log Details to the Related Lists section of the page layout. 7. Choose Save. 8. Customize related lists for Sync Log Details and add Created Date, Error Messages, and Status ﬁelds to Related Lists. For more information, refer to Customize Related Lists. 9. Choose Save. Note Version 2.2 of the CRM connector features a path for the AWS delivered ACE Opportunity object. To view the path on the ACE Opportunity page, refer to Enable Paths. Upgrading from previous versions 61 AWS Partner Central CRM Guide To add ﬁeld mapping values to Closed Lost Reason label of ACE opportunity objects 1. Log in to your Salesforce organization as a system administrator. 2. Choose the ACE Mappings tab. 3. 4. 5. In the navigation bar, choose Opportunity. In the Object Selector, choose ACE Opportunity. For the Closed Lost Reason label, choose Edit Values. 6. Choose Auto Map. 7. Choose Next. 8. Choose Save. Setting up real-time notiﬁcations for AWS Partner Central and AWS Marketplace events The steps in the following sections explain how to set up real-time EventBridge notiﬁcations for AWS Partner Central and AWS Marketplace events. Topics • Conﬁguring a Salesforce connected app • Conﬁguring AWS Components • Creating AWS components manually • Example rules Conﬁguring a Salesforce connected app The following steps explain how to conﬁgure a connected app in Salesforce. You must create a connected app in order to use OAuth authentication for destination connections. For more information, see Creating AWS components manually, later in this section. 1. 2. 3. Sign in to your Salesforce organization as a system administrator. From Setup, in the Quick Find box, enter apps, then select App Manager. Select New Connected App then do the following: • Enter a name. Setting up real-time notiﬁcations 62 AWS Partner Central • Enter your contact email. CRM Guide • (Optional) Fill out other ﬁelds as described in Conﬁgure Basic Connected App Settings, in the Salesforce documentation. 4. In the API (Enable OAuth Settings) section, select Enable OAuth Settings, then do the following: • Select Enable for Device Flow. A callback URL isn't used in the device ﬂow. However, when this ﬂow is enabled, the value for the callback URL defaults to a placeholder.
apc-crm-022	apc-crm.pdf	22	Find box, enter apps, then select App Manager. Select New Connected App then do the following: • Enter a name. Setting up real-time notiﬁcations 62 AWS Partner Central • Enter your contact email. CRM Guide • (Optional) Fill out other ﬁelds as described in Conﬁgure Basic Connected App Settings, in the Salesforce documentation. 4. In the API (Enable OAuth Settings) section, select Enable OAuth Settings, then do the following: • Select Enable for Device Flow. A callback URL isn't used in the device ﬂow. However, when this ﬂow is enabled, the value for the callback URL defaults to a placeholder. • For OAuth scopes, select Manage user data via APIs. • Keep Require Secret for the Web Server Flow selected. This option requires the app's client secret in exchange for an access token. • Keep Require Secret for Refresh Token Flow selected. This option requires the app's client secret in the authorization request of a refresh token and the hybrid refresh token ﬂow. • Select Enable Client Credentials Flow. • Save your changes. 5. Choose Continue, then choose Manage Consumer Details. A window appears, and a veriﬁcation code is sent to your registered email address. 6. Verify your identity, and note the consumer key and consumer secret. 7. Select an execution user for the client credentials ﬂow. Salesforce requires the execution user in order to return access tokens on behalf of the user. 8. From Setup, in the Quick Find box, enter Apps, select Manage Connected Apps, then choose the connected app you just created. 9. Choose Edit Policies. Under Client Credentials Flow, for Run As, choose User, and ﬁnd the user who you want to assign the client credentials ﬂow. For Enterprise Edition orgs, we recommend that you select an execution user who has the API Only User permission. 10. Save your changes. Conﬁguring AWS Components For AWS Partner CRM connector version 3.0 and later, you can use an AWS CloudFormation template to conﬁgure the AWS Components for the Amazon EventBridge Integration, or you can create the components manually. To use AWS CloudFormation, download the templates from: Conﬁguring AWS Components 63 AWS Partner Central CRM Guide • ACE integration: https://servicecatalogconnector.s3.amazonaws.com/ APIDestinationCFT_PCAPI.json • AWS Marketplace integration: https://servicecatalogconnector.s3.amazonaws.com/ APIDestinationCFT_AWSMP.json Note Amazon EventBridge integration is only available for version 3.0 and later. For information about installing Amazon SNS notiﬁcations for AWS Marketplace integrations (AWS Partner CRM connector 2.x), see Available template for baseline permissions later in this guide. To create the components manually, see Creating AWS components manually, later in this section. When deploying the AWS CloudFormation template, you must enter the following input parameter values: • Client ID – The consumer key you noted when creating the connected app • Client Secret – The consumer secret you noted when creating the connected app • Domain URL – Use the following format: https://My_Salesforce_Domain Note You can ﬁnd your Salesforce org's My Domain name on the My Domain page in Setup. When deployed successfully, the templates create the API Destination, Connection, Event Rules, and Dead Letter Queue. Creating AWS components manually The following steps explain how to manually create the AWS components. Topics • Create an Amazon EventBridge API destination and connection • Create an EventBridge Rule and connect it to the API Destination • Change set events Creating AWS components manually 64 AWS Partner Central • Oﬀer Released events • Opportunity events • Types of events • Example event CRM Guide Create an Amazon EventBridge API destination and connection To create an API destination and connection in EventBridge, create an API destination that uses a new connection. In this case, the API destination is a REST API call to Salesforce to publish an event back. The connection contains the authentication information for the API call. The connection accepts several authorization methods. Prerequisites To use OAuth authorization for the API destination connection, create a connected app in Salesforce. To do so, follow the steps in Conﬁgure a Connected App for the OAuth 2.0 Client Credentials Flow, in the Salesforce documentation. You use the consumer key and secret from the connected app for the API destination connection. To create an API destination in the EventBridge console: • Follow the steps in Create an API destination in the Amazon EventBridge User Guide. • Set up the conﬁgurations that are speciﬁc to Salesforce. In Salesforce, on the My Domain page, under Setup, note your organizations domain name. You use it to set up the API destination and connection in the EventBridge console. The following steps explain how. To create the destination and connection 1. Open the EventBridge console at https://console.aws.amazon.com/events/, and in the left navigation pane, choose API destinations. 2. Scroll down to the API destinations table and choose Create API destination. The Create API destination page appears. 3. Enter the following information: Creating AWS components
apc-crm-023	apc-crm.pdf	23	destination in the Amazon EventBridge User Guide. • Set up the conﬁgurations that are speciﬁc to Salesforce. In Salesforce, on the My Domain page, under Setup, note your organizations domain name. You use it to set up the API destination and connection in the EventBridge console. The following steps explain how. To create the destination and connection 1. Open the EventBridge console at https://console.aws.amazon.com/events/, and in the left navigation pane, choose API destinations. 2. Scroll down to the API destinations table and choose Create API destination. The Create API destination page appears. 3. Enter the following information: Creating AWS components manually 65 AWS Partner Central CRM Guide a. A Name for the API destination. You can use up to 64 uppercase or lowercase letters, numbers, dots (.), dashes (-), or underscore (_) characters. b. c. The name must be unique to your account in the current Region. (Optional) Enter a Description of the API destination. For API destination endpoint, use this URL: https://my-salesforce-domain- name.my.salesforce.com/services/data/v58.0/sobjects/event-api-name. d. For HTTP method, select POST. 4. Under Connection conﬁguration, select Create a new connection, then do the following: a. b. c. d. e. f. g. Enter a name and optional description. For Destination type, choose Other. Choose OAuth Client Credentials. For Authorization endpoint, accept the prepopulated endpoint. —or— if you use a production organization, replace the populated endpoint with this URL: https://my-salesforce-domain-name.my.salesforce.com/services/oauth2/ token For HTTP method, select POST. For Client ID, enter the consumer key from the connected app in Salesforce. For Client secret, enter the consumer secret from the connected app in Salesforce. h. Add the following OAuth values: • Parameter: Body ﬁeld • Key: grant_type • Value: client_credentials 5. Choose Create. Note If your Salesforce organization uses multi-factor authentication for API access, users must complete a second authentication challenge to access the Salesforce APIs. For more Creating AWS components manually 66 AWS Partner Central CRM Guide information, see Set Multi-Factor Authentication Sign in Requirements for API Access in the Salesforce documentation. After you create the API destination, you can create a rule that uses the target as the destination. Create an EventBridge Rule and connect it to the API Destination EventBridge rules route events from the event bus to the API destination, which results in making a REST call to publish an event back to Salesforce. For more information about EventBridge rules, see Creating Amazon EventBridge rules that react to events in the Amazon EventBridge User Guide. Change set events The following steps explain how to create change set events. 1. 2. 3. 4. In Amazon EventBridge, choose Rules. From the list, select the desired event bus. In the Rules section, Choose Create rule. Enter a name for the rule, then choose Next. 5. Under Event pattern, select Custom patterns (JSON editor) and enter a ﬁlter. You must use the following ﬁlter. You can use any combination of detail types. { "source": [ "aws.marketplacecatalog" ], "detail-type": [ "Change Set Succeeded", "Change Set Failed", "Change Set Cancelled" ] } For more information about event pattern matching, see Content ﬁltering in Amazon EventBridge event patterns in the AWS documentation. 6. Choose Next. Creating AWS components manually 67 AWS Partner Central CRM Guide 7. 8. 9. In Select targets, under Target 1, select EventBridge API destination. From the list, select the API destination that you just created. Expand Additional settings. 10. Under Conﬁgure Target Input, select Input Transformer and Conﬁgure Input Transformer. This ensures that only the Salesforce event ﬁelds from the detail section of the original event are sent. The Input path must be: { "Name": "$.detail-type", "awsapn__Account_Number__c": "$.account", "awsapn__EntityId__c": "$.detail.ChangeSetId" } The template must be: { "Name": Name, "awsapn__Account_Number__c": awsapn__Account_Number__c, "awsapn__EntityId__c": awsapn__EntityId__c } 11. Choose Next, then Next. 12. Review the rule, then choose Create rule. Note To troubleshoot an API destination, you can use the Amazon SQS console to add a dead letter queue to the target. The queue receives messages that couldn't be delivered, plus the errors. From the Amazon SQS console, you can poll messages in the queue for errors. For more information, see Using dead-letter queues to process undelivered events in EventBridge, and Receiving and deleting a message in Amazon SQS in the Amazon SQS User Guide. Creating AWS components manually 68 AWS Partner Central Oﬀer Released events CRM Guide The following steps explain how to create Oﬀer Released events. 1. In the Amazon EventBridge console, Choose Rules. 2. Select the desired event bus from the list. 3. In the Rules section, Choose Create rule. 4. Enter a name for your rule, then choose Next. 5. Under Event pattern, select Custom patterns (JSON editor), then enter the following ﬁlter: { "source": [ "aws.marketplacecatalog" ], "detail-type": [ "Offer Released" ] } For more information about event pattern matching, see Content ﬁltering in Amazon EventBridge event patterns in the Amazon EventBridge User
apc-crm-024	apc-crm.pdf	24	manually 68 AWS Partner Central Oﬀer Released events CRM Guide The following steps explain how to create Oﬀer Released events. 1. In the Amazon EventBridge console, Choose Rules. 2. Select the desired event bus from the list. 3. In the Rules section, Choose Create rule. 4. Enter a name for your rule, then choose Next. 5. Under Event pattern, select Custom patterns (JSON editor), then enter the following ﬁlter: { "source": [ "aws.marketplacecatalog" ], "detail-type": [ "Offer Released" ] } For more information about event pattern matching, see Content ﬁltering in Amazon EventBridge event patterns in the Amazon EventBridge User Guide. . 6. Choose Next. 7. In Select targets, under Target 1, select EventBridge API destination, then open the list and select the API destination that you just created. 8. Expand Additional settings. 9. Under Conﬁgure Target Input Select Input Transformer, and select Conﬁgure Input Tansformer. This step prevents the top-level Amazon event ﬁelds from being sent to Salesforce. Only the part containing the Salesforce event ﬁelds from the detail section of the original event are sent. Use the following input path: { "Name":"$.detail-type", "awsapn__Account_Number__c":"$.account", "awsapn__EntityId__c":"$.detail.offer.id", "awsapn__Manufacturer_Account_Id__c":"$.detail.manufacturer.accountId", "awsapn__Product_Id__c":"$.detail.product.id", Creating AWS components manually 69 AWS Partner Central CRM Guide "awsapn__Seller_Account_Id__c":"$.detail.sellerOfRecord.accountId" } Use the following template: { "Name": Name, "awsapn__Account_Number__c": awsapn__Account_Number__c, "awsapn__EntityId__c": awsapn__EntityId__c, "awsapn__Seller_Account_Id__c": awsapn__Seller_Account_Id__c, "awsapn__Manufacturer_Account_Id__c": awsapn__Manufacturer_Account_Id__c, "awsapn__Product_Id__c": awsapn__Product_Id__c } 10.Choose Next and then Next. 11.Review the rule, then Choose Create rule. Note To troubleshoot the execution of the API destination, you can add an Amazon SQS dead letter queue to the target. The queue receives the messages that couldn't be delivered along with the errors. You can then poll the messages to view the errors. For more information, see Event retry policy and using dead-letter queues and Receiving and deleting messages (console) in the AWS documentation. Opportunity events Opportunity events provide real-time notiﬁcations about changes in the status or details of opportunities You can also create and manage EventBridge rules programmatically using the AWS SDKs. Types of events The following list describes the event types generated when partners work with opportunities. The links take you to the API documentation for each event. • Opportunity Created: – Triggered when a new opportunity is created. • Opportunity Updated – Triggered when an opportunity is updated. Creating AWS components manually 70 AWS Partner Central CRM Guide • Engagement Invitation Created – Triggered when an opportunity is created. • Engagement Invitation Accepted – Triggered when a partner accepts an AWS Engagement Invitation, conﬁrming their interest in collaborating with AWS on the opportunity. • Engagement Invitation Rejected – Triggered when an opportunity is rejected. Example event { "version": "1", "id": ""d1example-0c9c-4655-15bf-c5exampleb08", "source": "aws.partnercentral-selling", "detail-type": "Opportunity Created", "time": ""2023-10-28T13:31:05Z", "region": ""us-east-1", "account": ""123456789123", "detail": { "schemaVersion": "1", "catalog": "AWS", "opportunity": { "identifier": ""O1234567", "url": "Partner Central Opportunity Page URL" } } } Example rules The following table lists examples of the EventBridge rules that you can use with the events listed in the previous section. Rules route events from the event bus to the API destination, which results in making a REST call to publish an event back to Salesforce. Event type Example Opportunity Created { "source": ["aws.partnercentral- selling"], "detail-type": ["Opportunity Created"], "detail": { Example rules 71 AWS Partner Central Event type Opportunity Updated Engagement Invitation Created Engagement Invitation Accepted CRM Guide Example "catalog": ["AWS"] } } { "source": ["aws.partnercentral- selling"], "detail-type": ["Opportunity Updated"], "detail": { "catalog": ["AWS"] } } { "source": ["aws.partnercentral- selling"], "detail-type": ["Engagement Invitation Created"], "detail": { "catalog": ["AWS"] } } { "source": ["aws.partnercentral- selling"], "detail-type": ["Engagement Invitation Accepted"], "detail": { "catalog": ["AWS"] } } Example rules 72 AWS Partner Central Event type Engagement Invitation Rejected All events CRM Guide Example { "source": ["aws.partnercentral- selling"], "detail-type": ["Engagement Invitation Rejected"], "detail": { "catalog": ["AWS"] } } { "source": ["aws.partnercentral- selling"], "detail": { "catalog": ["AWS"] } } ACE integration The AWS Partner Network (APN) customer engagements (ACE) CRM integration of the AWS Partner CRM connector helps partners scale their build, market, and sell engagements with AWS through a direct connection between Salesforce and AWS Partner Central. With the integration, partners can accept new leads and opportunities and receive lead and opportunity updates from AWS. Partners can send new opportunities and updated opportunities to AWS. Topics • Prerequisites • Permissions sets • Guided setup • ACE object mappings • Creating synchronization schedules • Sync logs and reports • Production checklist ACE integration 73 AWS Partner Central CRM Guide • Upgrading AWS Partner CRM connector to the new data model • Sandbox testing with the custom ACE opportunity and ACE lead objects Note For more information about the ACE features, see the section called “ACE features”. Prerequisites Before installing and using the AWS Partner CRM connector, you must have an AWS account and an AWS Identity and access management (IAM) user. Then, your partner alliance lead must onboard
apc-crm-025	apc-crm.pdf	25	Prerequisites • Permissions sets • Guided setup • ACE object mappings • Creating synchronization schedules • Sync logs and reports • Production checklist ACE integration 73 AWS Partner Central CRM Guide • Upgrading AWS Partner CRM connector to the new data model • Sandbox testing with the custom ACE opportunity and ACE lead objects Note For more information about the ACE features, see the section called “ACE features”. Prerequisites Before installing and using the AWS Partner CRM connector, you must have an AWS account and an AWS Identity and access management (IAM) user. Then, your partner alliance lead must onboard this integration by submitting a request through AWS Partner Central. Partners can use the AWS Partner CRM connector for APN Customer Engagements (ACE) integration only after onboarding is complete through AWS Partner Central. The partner alliance lead must submit an onboarding request on the CRM Integration page on Partner Central. Topics • ACE program sign up • AWS Partner Central API prerequisites • Technical requirements–CRM administrator • CRM onboarding request ACE program sign up • To install and use AWS Partner CRM connector to share referrals, you must be a member of the ACE program. To learn about eligibility and sign up, refer to APN Customer Engagements Program. • To sign up for the ACE program, you must have access to Partner Central as an alliance lead. To obtain a Partner Central account, refer to Sign up for APN. To learn more about the ACE program, see the following resources: • ACE Program FAQs • ACE Pipeline Manager: In depth review of ACE submission form and AWS Validation Process Prerequisites 74 AWS Partner Central CRM Guide • ACE Pipeline Manager User Guide AWS Partner Central API prerequisites You must have the following prerequisites to use the AWS Partner Central API. 1. Link your AWS account to Partner Central. For more information, see Linking your AWS account to Partner Central, in the AWS Partner Central API Reference.. 2. Set up IAM roles and users. For more information, see Setting up IAM, in the AWS Partner Central API Reference.. 3. Assign AWS managed policies. For more information, see Access Control and Permissions, in the AWS Partner Central API Reference.. Technical requirements–CRM administrator • To install AWS Partner CRM connector, you must own a Salesforce instance. • Your CRM administrator must conﬁrm that your Salesforce organization edition is on Lightning Experience (enterprise, professional, or unlimited). For more information, refer to Sales Pricing. • You must have a sandbox environment for testing the integration. Your sandbox instance must use Salesforce Winter '23 release or higher. For more information, refer to Sandboxes: Staging Environments for Customizing and Testing. • (Optional) AWS Partners with AWS Marketplace seller accounts can connect their accounts using the account linking feature in AWS Partner Central. Refer to Link AWS Marketplace to Partner Central. Note You can only link AWS Marketplace to Partner Central in production AWS Partner Network accounts. CRM onboarding request Before your partner alliance lead can initiate a CRM integration, your cloud operations or IT team must create an AWS account and AWS Identity and Access Management (IAM) user. For more information, refer to ACE CRM—How to Create IAM User. Prerequisites 75 AWS Partner Central Note CRM Guide If your company policy does not allow the creation of IAM users, consider an AWS IAM Roles Anywhere integration. For details, refer to the IAM Roles Anywhere integration guide for installing AWS Partner CRM connector blog post. After the IAM user or IAM Roles Anywhere role is provisioned, the partner alliance can submit a CRM integration request on the CRM Integration page in Partner Central. This request provisions an Amazon S3 bucket on an AWS-owned account with IAM policies. These IAM policies should be attached back to the IAM user or IAM Roles Anywhere role before conﬁguring the AWS Partner CRM connector in your Salesforce organization. Permissions sets Three primary AWS Partner personas are supported in the AWS Partner Customer Relationship Management (CRM) connector application. These can be implemented by the AWS Partner by giving the designated Salesforce user the corresponding permission set from the app. Topics • Business administrator (APN business administrator) • Integration user (APN integration user) • Business user (APN business user) • System permissions to view reports • Activate ﬂow user Business administrator (APN business administrator) • Should be given to a system admin or a business admin to conﬁgure the setup/mapping of records. • Gives full access to the Salesforce AWS Partner Network (APN) CRM administration app. • Can create, view, and edit ﬁeld mappings. • Can view all sync log detail records. • Doesn’t allow the user to schedule the integration, only to set up conﬁgurations. • Doesn’t give core Salesforce setup access. Permissions sets 76 AWS Partner Central CRM Guide • There are
apc-crm-026	apc-crm.pdf	26	Business user (APN business user) • System permissions to view reports • Activate ﬂow user Business administrator (APN business administrator) • Should be given to a system admin or a business admin to conﬁgure the setup/mapping of records. • Gives full access to the Salesforce AWS Partner Network (APN) CRM administration app. • Can create, view, and edit ﬁeld mappings. • Can view all sync log detail records. • Doesn’t allow the user to schedule the integration, only to set up conﬁgurations. • Doesn’t give core Salesforce setup access. Permissions sets 76 AWS Partner Central CRM Guide • There are some settings in Salesforce that require additional access, speciﬁcally named credentials and custom settings that the AWS Partner must provide to their user. But if this permission set is paired with a Salesforce system admin proﬁle, all of the necessary permissions to conﬁgure the application should function. Integration user (APN integration user) • Should be assigned to a designated system user that’s responsible for processing the integration. • To schedule the integration, a Salesforce system admin should log in as this user and invoke the system integration schedule. • Allows for full access to conﬁgure the mappings, as well as invoke setting up the schedule. • The integration may break if this permission isn’t set on the user responsible for running the integration. • In addition to this permission set, the user designated to process the integration should be given ﬁeld level access to all mapped ﬁelds. If this isn’t done, the mappings will fail to sync as assigned. • The outbound jobs are designed to ignore updates done in the integration user context to prevent a race-around condition, with the same record updated during inbound integration being ﬂagged to be sent for outbound integration. Business user (APN business user) • Can be assigned to business users who might want to see the sync log details related to their opportunities. This allows for end user troubleshooting if data is not syncing correctly. • Does not provide visibility to the sync log records and only gives access to the object and ﬁelds. • We recommend that sync log records are set to private, since they contain sensitive opportunity information. • If a private model is conﬁgured, APN business users can access only the records if the partner Salesforce administrator conﬁgures record sharing with users. System permissions to view reports To allow a user to view reports on the Home tab of the AWS Partner CRM connector, an administrator must grant them the following permissions: Permissions sets 77 AWS Partner Central • Create and Customize Reports • Edit My Reports • Mange Reports in Public Folders • Run Reports • View Reports in Public Folders CRM Guide For more information, refer to Grant Users Access to Reports and Dashboards. Activate ﬂow user To allow a user to run ﬂows and the Link private oﬀer button on an ACE opportunity, the system administrator must conﬁgure the user as a ﬂow user. 1. Ensure that the system administrator the correct permissions to assign a ﬂow user. For more information, refer to Add Run Flows Permissions. 2. Choose Setup, Users. 3. Choose a user. 4. Choose Flow user. Guided setup The topics in this section provide Salesforce administrators with step-by-step instructions for integrating the AWS Partner CRM connector with APN Customer Engagements (ACE). To start conﬁguring the integration, use the App Launcher to locate and open the AWS Partner CRM connector app. Choose the AWS Guided Setup tab, and then expand the AWS ACE CRM integration section. Note Ensure that you complete the Prerequisites before continuing. Topics • Partner Central API setup • Legacy Amazon S3 setup Guided setup 78 AWS Partner Central Partner Central API setup CRM Guide The steps in the following sections explain how to set up the AWS Partner Central API. You must use the API in order to use the latest version of the AWS Partner CRM connector. Topics • Setting up named credentials • System conﬁguration settings • Testing the connection Setting up named credentials The AWS Partner CRM connector uses the partner's Salesforce organization credentials to authenticate with Partner Central. To set up credentials 1. Sign in to Salesforce as a system administrator. 2. Under Named credentials, choose New legacy. 3. In the New named credential form, enter the values from the following table. Field Label URL Value AWS Partner Central API https://partnercentral-selling.us-east-1.api. aws Identity type Named Principal Authentication protocol AWS signature version 4 AWS access key ID AWS secret access key Cloud-Ops provides the ID during the prerequisite steps Cloud-Ops provides the access key during the prerequisite steps Guided setup 79 AWS Partner Central CRM Guide Field AWS Region AWS service Value us-east-1 partnercentral-selling Generate authorization header Allow merge ﬁelds in HTTP header checked checked Allow merge
apc-crm-027	apc-crm.pdf	27	Salesforce as a system administrator. 2. Under Named credentials, choose New legacy. 3. In the New named credential form, enter the values from the following table. Field Label URL Value AWS Partner Central API https://partnercentral-selling.us-east-1.api. aws Identity type Named Principal Authentication protocol AWS signature version 4 AWS access key ID AWS secret access key Cloud-Ops provides the ID during the prerequisite steps Cloud-Ops provides the access key during the prerequisite steps Guided setup 79 AWS Partner Central CRM Guide Field AWS Region AWS service Value us-east-1 partnercentral-selling Generate authorization header Allow merge ﬁelds in HTTP header checked checked Allow merge ﬁelds in HTTP body unchecked 4. Choose Save. 5. Return to the AWSGuided setup page. In the Authentication details section, choose Review and conﬁrm the credentials. System conﬁguration settings You use custom settings in the AWS Partner CRM connector to manage global settings. The following table lists and describes the settings. Custom setting ﬁeld Purpose Name Default account Create New Account from Default Account Field isn’t used, but because it’s required, you can set it to any value. An 18-digit record ID of the default account that’s used when standard opportunities are used as the target object in Salesforce. Because AccountID is required on standard opportunities, the default account ﬁeld allows new inbound opportunities from AWS to have a default account tied to them. This can be any account record in your Salesforce organization that the integration user has access to from the sharing settings. This setting enables the connector to create a new account based on the default account Guided setup 80 AWS Partner Central CRM Guide Custom setting ﬁeld Purpose Default opportunity PC API Sandbox Enabled provided by the partner. When checked, it allows for dynamic account creation during the integration process, ensuring that new opportunities or engagements can be associated with appropriate account records even when the exact account doesn't exist in the target system. This option stores the 18-digit record ID of a default opportunity for use as a template. For partners using Standard Opportunity and custom objects other than an ACE Opportuni ty, the default record allows the connector to clone and create new opportunities or AWS referral engagements while bypassing potential required ﬁeld issues. The connector clones this default record, appends new ﬁeld values from the incoming data, and creates a new opportunity record. This method integrates data data with custom opportunity objects or unique ﬁeld requirements. Select this option to enable partners to test the connector with the AWS Partner Central API. When selected, users can create test opportunities which are sent to the AWS Sandbox API. Testing the connection After you complete the ﬁrst two setup steps, choose Test Conﬁguration for APN API to verify connectivity. If the connection succeeds, you receive a conﬁrmation message. Guided setup 81 AWS Partner Central Legacy Amazon S3 setup CRM Guide The following topics explain how to set up the AWS Partner CRM connector using an Amazon Simple Storage Service bucket. Topics • Setting up named credentials • System conﬁguration settings • Testing the connection Setting up named credentials The AWS Partner CRM connector authenticates with APN using Salesforce credentials from the partner’s Salesforce organization. 1. Sign in to Salesforce as a system administrator. 2. Under Named credentials, choose New legacy. 3. In the New named credential form, enter the values from the following table. Field Label URL Value APN API Connection https://s3.us-west-2.amazonaws.com Identity type named principal Authentication protocol AWS signature version 4 AWS access key ID AWS secret access key AWS Region AWS service Cloud-Ops provides the ID during the prerequisite steps Cloud-Ops provides the access key during the prerequisite steps us-west-2 S3 Guided setup 82 AWS Partner Central Field Generate authorization header Value checked Allow merge ﬁelds in HTTP header unchecked Allow merge ﬁelds in HTTP body unchecked 4. Choose Save. CRM Guide 5. Return to the AWSGuided setup page. In the Authentication details section, choose Review to conﬁrm the setup of named credentials. System conﬁguration settings You use custom settings in the AWS Partner CRM connector app to manage global settings. The following table lists and describes the settings. 1. Choose Setup, Custom settings. 2. Locate the AWS Partner CRM settings, and choose Manage. 3. Choose New, and then enter the required values from the following table. Custom setting ﬁeld Purpose Name Bucket name Default account Field isn’t used, but because it’s required, you can set it to any value. Bucket name that was provisioned for the partner. It’s diﬀerent for beta and production environments. An 18-digit record ID of the default account that’s used when standard opportunities are used as the target object in Salesforce. Because AccountID is required on standard opportunities, the default account ﬁeld allows new inbound opportunities from AWS to have a default account tied to. This can be
apc-crm-028	apc-crm.pdf	28	Manage. 3. Choose New, and then enter the required values from the following table. Custom setting ﬁeld Purpose Name Bucket name Default account Field isn’t used, but because it’s required, you can set it to any value. Bucket name that was provisioned for the partner. It’s diﬀerent for beta and production environments. An 18-digit record ID of the default account that’s used when standard opportunities are used as the target object in Salesforce. Because AccountID is required on standard opportunities, the default account ﬁeld allows new inbound opportunities from AWS to have a default account tied to. This can be any account record in your Salesforce Guided setup 83 AWS Partner Central CRM Guide Custom setting ﬁeld Purpose Outbound batch size Retry count Retry cutoﬀ days Partner ID Sync log retention Version organization that the integration user has access to from the sharing settings. Number of records sent in a single payload from your Salesforce organization to AWS. This is common for both opportunities and leads. We recommend a value between 1– 50. For example, if you set the batch size to 50, each opportunity payload sent from your organization to AWS contains 50 opportunity records. In the event of a failure, this value represent s the number of times the transaction is retried. If a record continues to fail, this value is the number of days after which a retry is no longer attempted. Unique partner identiﬁer that is shared as part of enablement. Number of days to retain the synchronization logs. For the new data model, choose version 2. For the previous data model, choose version 1. Guided setup 84 AWS Partner Central CRM Guide Custom setting ﬁeld Purpose Create New Account from Default Account Enables the connector to create a new account based on the default account provided by the partner. When you select this option, it enables dynamic account creation during the integration process, ensuring that new opportunities or engagements can be associated with appropriate account records even when the exact account doesn't exist in the target system. Testing the connection After you complete steps 1 and 2 of the setup, choose Test Conﬁguration for APN API to verify connectivity. If the connection is successful, you receive a conﬁrmation message. ACE object mappings The AWS Partner Customer Relationship Management (CRM) connector application provides partners the ability to set up object and ﬁeld mapping between their Salesforce organization and AWS Partner Network (APN) through the ACE Mappings page, included in the application. Topics • Mappings page • Multi-object mapping • Picklist mapping • Mapping guidance Mappings page AWS Partner Central provides the following to navigate to the ACE Mappings page: • In Salesforce, choose the ACE Mappings tab. • In the AWS Partner Central console, on the Guided Setup tab, go to the Map Leads and opportunities section, then choose Start or Review. ACE object mappings 85 AWS Partner Central CRM Guide On the ACE Mappings page, use the left navigation pane to toggle between opportunity and lead mappings. Use the Object Selector to choose the source object to map APN leads and opportunities. The object selector supports mapping to both standard opportunities and lead objects as well as custom objects. Use the Mapping View and Type View ﬁlters to toggle among mapped ﬁelds, unmapped ﬁelds, required ﬁelds, and optional ﬁelds. On the ACE Mappings page, the AWS Fields column for the object indicates the corresponding target APN ﬁelds. The Salesforce Fields are source ﬁelds of the selected object in the partner’s organization. Salesforce Fields are ﬁltered to show only applicable data types available in the organization to be mapped to the corresponding APN ﬁeld. For example, a text ﬁeld in APN can be mapped only to a text (string) ﬁeld in the partner’s organization. Partners can control inbound updates on mapped ﬁelds if they don’t want a ﬁeld updated by APN. To do this, set the Enable Inbound Updates toggle to False. For one-to-one mapping, select the relevant source ﬁeld, and then choose Save. Multi-object mapping Multi-object mapping allows you to map AWS ﬁelds to a primary source object, such as an opportunity or lead, and to the Salesforce objects related to the primary source. Note Remember the following when using multi-object mapping: • When using the Salesforce Account object for multi-object-mapping with an opportunity object, you must conﬁgure the Default Account in the ACE custom settings in order to receive opportunities. • When receiving an opportunity, if you map to an object other than the chosen Opportunity object, you must ensure that you link the related object to your opportunity record. For example, when receiving an AWS referral for the ﬁrst time, the inserted opportunity has no mapped objects' related IDs unless you conﬁgure the Default Account in the ACE custom settings. If you conﬁgure
apc-crm-029	apc-crm.pdf	29	Remember the following when using multi-object mapping: • When using the Salesforce Account object for multi-object-mapping with an opportunity object, you must conﬁgure the Default Account in the ACE custom settings in order to receive opportunities. • When receiving an opportunity, if you map to an object other than the chosen Opportunity object, you must ensure that you link the related object to your opportunity record. For example, when receiving an AWS referral for the ﬁrst time, the inserted opportunity has no mapped objects' related IDs unless you conﬁgure the Default Account in the ACE custom settings. If you conﬁgure the default account, the referral has the IDs of the chosen opportunity or account objects. Otherwise, the mapped ﬁeld value won't be inserted. In that case, you must modify the opportunity to add the related object ID, and choose Sync with AWS. When AWS pushes the opportunity back to Salesforce, the mapped object’s ﬁeld updates because it has a reference to the object's related ID. ACE object mappings 86 AWS Partner Central CRM Guide • Select the Clone Default Account option in custom settings. This allows AWS to clone the default account when necessary, particularly if you map account ﬁelds to your primary object. To map related objects 1. 2. In Salesforce, mavigate to the ACE Mappings tab and choose an opportunity or lead. From the Object selector, choose your source object. The Salesforce Fields column appears and displays the > symbol at the end of any ﬁelds that contain related objects. 3. Select an > symbol to expand the list of related objects for that ﬁeld. 4. Choose the ﬁeld that you want to map to the AWS ﬁeld. 5. Choose Save. Picklist mapping The picklist modal allows both limited and extended mappings between the partner’s picklist ﬁeld and APN. The ACE Mappings page also has an Auto Map function, so if an exact match is found between the partner’s ﬁeld values and APN, those values are mapped automatically. The option for extended mapping lets partners map a single APN value to multiple sources, conﬁgure additional target mappings, and set default mappings. Limited mapping 1. To open the picklist mapping modal, from the ACE Mappings page, select a source ﬁeld, and then choose Map Values. 2. For Step 1: Primary APN Values, choose either Auto Map or the Salesforce value for the corresponding ACE pipeline manager, and then choose Save. 3. Repeat steps 1 and 2 as necessary until all of your ACE pipeline manager values are mapped. 4. Partners will receive a conﬁrmation message that the value mappings were saved successfully. To close the mapping modal, choose Close. ACE object mappings 87 AWS Partner Central Extended mapping CRM Guide 1. If the same source value maps to multiple APN values, proceed with the mapping as previously described. 2. On the Primary APN Values tab, choose the same value mapping for multiple APN values. 3. If unmapped values exist in the partner’s organization, the Additional APN Value tab lets you map additional values to APN. This helps partners ensure that all applicable values in their organization are mapped to appropriate APN values. 4. If a single value in the partner’s organization is mapped to more than one APN value, use the Secondary APN Values tab to set the default value for outbound integrations. Mapping guidance Using an AWS ACE opportunity custom object In version 2.0 and later of the AWS Partner CRM connector, an ACE opportunity custom object is included when the connector installs from Salesforce AppExchange. Partners can use this custom object to manage AWS opportunities within Salesforce. When using an AWS custom opportunity object on the ACE Mappings page, partners can automatically map AWS ﬁelds to Salesforce ﬁelds. Additionally, the AWS custom opportunity object is aligned with the new ACE data model and has validations built in to the user interface that help users submit new opportunities. To use a custom ACE opportunity object, complete the following steps: 1. Navigate to the ACE Mappings page, and choose Opportunity from the left navigation pane. 2. Under Object Selector, choose ACE Opportunity . 3. To map Salesforce ﬁelds to AWS ﬁelds, choose the Auto Map ACE object button. Using a standard Salesforce object or custom object Partners may choose to use the Salesforce standard opportunity object or use their own custom opportunity object. To avoid failures in the ACE synchronization, ensure that the opportunity object contains all of the relevant ACE mandatory ﬁelds or conditionally mandatory ﬁelds. The data type of the mapped AWS ﬁeld must be the same data type as the Salesforce ﬁeld created in the custom object. If the data type doesn't match, the ﬁeld will not appear in the ACE mapping screen. For example, the text ﬁeld customerCompanyName can be mapped only to a text
apc-crm-030	apc-crm.pdf	30	a standard Salesforce object or custom object Partners may choose to use the Salesforce standard opportunity object or use their own custom opportunity object. To avoid failures in the ACE synchronization, ensure that the opportunity object contains all of the relevant ACE mandatory ﬁelds or conditionally mandatory ﬁelds. The data type of the mapped AWS ﬁeld must be the same data type as the Salesforce ﬁeld created in the custom object. If the data type doesn't match, the ﬁeld will not appear in the ACE mapping screen. For example, the text ﬁeld customerCompanyName can be mapped only to a text (string) ﬁeld in ACE object mappings 88 AWS Partner Central CRM Guide the standard or custom opportunity object. For required data types, refer to the ACE opportunity ﬁelds. To use a standard Salesforce object or custom object, complete the following steps: 1. Navigate to the ACE Mappings page, and choose Opportunity from the left navigation pane. 2. Choose your object under Object Selector. 3. Complete the mapping by selecting the required Salesforce ﬁelds against the corresponding AWS ﬁelds, and then choose Save. Note The Auto Map feature is available only for ACE opportunity custom objects. Creating synchronization schedules You can create inbound and outbound synchronization schedules between Salesforce and AWS Partner Network (APN). The steps in the following sections explain how Topics • Prerequisites • Creating a new schedule • Deactivating a scheduled job • Viewing all schedules Prerequisites Ensure that you complete the following before creating a syncronization schedule: • Map all required ﬁelds on at least one object, opportunity or lead. • Create a system integration user in Salesforce. System integration user Before you can create a synchronization schedule, you must create a system integration user in Salesforce with APN integration permissions. To create synchronization schedules, you must sign Creating synchronization schedules 89 AWS Partner Central CRM Guide in to Salesforce as the system integration user. Creating a schedule without APN integration user permissions can break the APN integration. To create a system integration user 1. Sign in to your Salesforce organization as a system administrator. 2. Create a user in your Salesforce organization. Assign a proﬁle to the user with access to the required objects in your Salesforce organization. For more information, refer to Add a single user. 3. Assign the user the APN Integration User permissions set. For more information, refer to Assign permission set to users. Creating a new schedule After completing the prerequisites, you can create synchronization schedules between Salesforce and APN. To create a synchronization schedule with APN 1. Sign in to Salesforce as a user with system integration user permissions. 2. On the Schedules tab, choose New. 3. Choose the objects to schedule. You can set up schedules for both leads and opportunities or for only one object. 4. Choose the schedule frequency, from a minimum of every ﬁve minutes to a maximum of once a day. 5. Choose Schedule. Note • Only one schedule per object can be active at one time. Creating a new schedule for the same object will deactivate the existing schedule. • To disable the inbound integration when creating a schedule, choose Disable Inbound Integration, Schedule. • Creating a schedule without APN integration user permissions can break the APN integration. Creating synchronization schedules 90 AWS Partner Central CRM Guide Deactivating a scheduled job 1. On the Scheduling page, choose Deactivate All Jobs to turn oﬀ any active schedules. 2. Proceed through the conﬁrmation screen to deactivate the synchronization schedule. Viewing all schedules From the Schedules tab, use the list view ﬁlters to toggle between Active, Inactive, and All synchronization schedules. Sync logs and reports Sync logs The Sync Log tab in the connector app shows the status of the synchronization records for inbound and outbound synchronization with the AWS Partner Network (APN). Partners use the tab to verify a successful sync and troubleshoot potential sync errors. AWS Partners can also use the included list views to toggle between Inbound and Outbound synchronization logs. • Inbound Orchestration – Indicates the job that checks for available inbound records from APN to process. • Inbound Orchestration Record Retrieval – Indicates the job that picks up and processes pending inbound records from APN. • Outbound Orchestration – Indicates the job that sends pending outbound transactions from the partners organization to APN. The Sync Log record page shows the status of the synchronization job, the number of records in the payload, the number of records processed successfully, and the number of records in error. The related Sync Log details show the individual record details processed as part of the synchronization job and their individual statuses. The following tables explain each type of log ﬁle and its related contents. Sync logs and reports 91 AWS Partner Central Log types CRM Guide Purpose Deﬁnition
apc-crm-031	apc-crm.pdf	31	from APN. • Outbound Orchestration – Indicates the job that sends pending outbound transactions from the partners organization to APN. The Sync Log record page shows the status of the synchronization job, the number of records in the payload, the number of records processed successfully, and the number of records in error. The related Sync Log details show the individual record details processed as part of the synchronization job and their individual statuses. The following tables explain each type of log ﬁle and its related contents. Sync logs and reports 91 AWS Partner Central Log types CRM Guide Purpose Deﬁnition Outbound File Retrieval Inbound File Retrieval Created when the outbound job runs based on frequency and whether a new set of pending records must be synced with AWS. Logs are created only when records must match the following ﬁlter speciﬁcation for the outbound sync: Updates for AWS is true and Last Sync Date is null or Last Sync Date is before the Last Modified Date and Last Modified By is the user who scheduled the sync jobs. Created based on your inbound sync schedule. The log lists the callouts that check for pending inbound transactions from AWS to be processed. Created only when the parent Inbound File Retrieval job identiﬁes pending inbound Inbound Record Retrieval transactions from AWS. The log contains the details of the ﬁle from AWS containing the opportunity or lead records. Outbound ﬁle retrieval results Direction Purpose Status Deﬁnition From AWS Inbound ﬁle retrieval API Success A list call to the bucket succeeded , The call checked for pending inbound records that must be processed. Sync logs and reports 92 AWS Partner Central CRM Guide Direction Purpose Status Deﬁnition From AWS Inbound ﬁle retrieval Error The list call failed, typically due to invalid credentials or a permission issue. Inbound ﬁle retrieval results Direction Purpose Status Deﬁnition From AWS Inbound record retrieval API success From AWS Inbound record retrieval Partial From AWS Inbound record retrieval Error A get call was made to retrieve the ﬁle listed from the Inbound File Retrieval operation, if one or more ﬁles exist and are pending to be processed. The ﬁle was retrieved, processin g started, but not all of the records were successfully processed. In this case, review the sync log to troublshoot the failure. None of the records were successfully processed due to one of the following reasons: Sync logs and reports 93 AWS Partner Central CRM Guide Direction Purpose Status Deﬁnition • A a connection error prevented ﬁle retrieval. • The ﬁle was retrieved but none of the records in the ﬁle could be written to your Salesforce object, typically due to a validation or permission issue. If one or more ﬁles are present and awaiting processing, a get call is made to retrieve the ﬁle listed from the Inbound File Retrieval operation. The ﬁle was retrieved and processing started, but not all of the records were successfully processed. In this case, review the sync log to troubleshoot the failure. From AWS Inbound record retrieval API success From AWS Inbound record retrieval Partial Sync logs and reports 94 AWS Partner Central CRM Guide Direction Purpose Status Deﬁnition From AWS Inbound record retrieval Error From AWS Inbound record retrieval Processed None of the records were successfully processed due to one of the following reasons: • A connection error prevented ﬁle retrieval. • The ﬁle was retrieved but none of the records in the ﬁle could be written to your Salesforce object (most likely due to a validation or permission issue). Record(s) included in the ﬁle were successfully processed and inserted into your mapped object. Reports The AWS Partner CRM connector package includes reports to allow AWS Partners to track the ongoing status of the synchronization between the AWS Partner's organization and APN. To view reports for synchronization 1. In the AWS Partner CRM connector app, choose the Reports tab. 2. Choose All Folders, then AWS Partner CRM connector. Sync logs and reports 95 AWS Partner Central CRM Guide Available reports include the following: • Inbound Sync Logs – Error: Inbound synchronization record failures by day. • Inbound Sync Logs – Success: Inbound synchronization record successes by day. • Outbound Sync Logs – Error: Outbound synchronization record failures by day. • Outbound Sync Logs – Success: Outbound synchronization record successes by day. • Synchronization Summary – Summary of inbound and outbound synchronization jobs by day. Sending and receiving opportunities and leads To designate an opportunity or lead for synchronization with APN, the Sync with Partner Central ﬁeld must be set to True. Additional key ﬁelds for integration include the Last APN Sync Date and the Eligible to Sync with APN ﬁeld. These ﬁelds are included for standard opportunities and leads; however, they must be created and mapped for the corresponding object when
apc-crm-032	apc-crm.pdf	32	– Error: Outbound synchronization record failures by day. • Outbound Sync Logs – Success: Outbound synchronization record successes by day. • Synchronization Summary – Summary of inbound and outbound synchronization jobs by day. Sending and receiving opportunities and leads To designate an opportunity or lead for synchronization with APN, the Sync with Partner Central ﬁeld must be set to True. Additional key ﬁelds for integration include the Last APN Sync Date and the Eligible to Sync with APN ﬁeld. These ﬁelds are included for standard opportunities and leads; however, they must be created and mapped for the corresponding object when the source objects are set to custom. • Sync with Partner Central—Included in the app for standard opportunities and leads. If a AWS Partner chooses to map to custom objects, a custom boolean ﬁeld must be created and mapped in the opportunity and lead mappings, respectively. • Last Sync Date with APN—Indicates the last time the record was successfully sent to APN or received from APN. This ﬁeld is autoset when the record is successfully sent to APN or an update is received from APN. • Eligible to Sync with APN—A formula ﬁeld that determines if the record is targeted to be sent to APN in the next scheduled job. Calculated based on if the record was modiﬁed since the last time the outbound schedule ran, and it was updated by a user other than the designated integration user for the AWS Partner's organization. Production checklist Follow these steps to complete the production installation of your AWS Partner CRM connector. 1. Conﬁrm that you completed the onboarding process for the CRM integration. In stage 6 of this process, you set up your production environment and perform data migration so you can manage opportunities and leads through the integration. 2. Install and conﬁgure the AWS Partner CRM connector. For details, refer to Guided setup. Production checklist 96 AWS Partner Central CRM Guide 3. Map opportunities and lead objects by choosing one of the following mapping options. For reference, see this list of required ﬁelds on GitHub. • • • Use the AWS ACE opportunity custom object provided with AWS Partner CRM connector to log opportunities and share them with AWS. Using this option, you can automatically map AWS ﬁelds to Salesforce ﬁelds. Use the standard Salesforce object and map the required AWS ﬁelds. Use an ACE custom opportunity object. You ﬁrst create a workﬂow to populate an intermediate table of ACE opportunity objects and then map the Salesforce ﬁelds to AWS. 4. 5. For additional details and guidance about mapping options, refer to ACE object mappings. (Optional) Set up inbound and outbound synchronization schedules between the AWS Partner Network and Salesforce. For details, refer to Creating synchronization schedules. 6. To validate a partner-originated opportunity in production, raise a support case with Partner Central Operations (PCO) in your Partner Central account. In this process, you create a dummy opportunity, sync it with AWS, and ask the AWS support agent to conﬁrm that AWS received the opportunity. At the end of testing, ask your AWS support agent to reject the opportunity request so you can delete it from your side. 7. (Optional) Perform data backﬁll. This process ensures that both AWS Originated and Partner Originated opportunity referrals can be identiﬁed during future updates. For more information, refer to Stage 6: Production approval in the CRM onboarding process. 8. Activate the production integration to allow the exchange of ﬁles through the Amazon S3 bucket. For details, refer to Stage 7: Launch. Upgrading AWS Partner CRM connector to the new data model Important Test and approve the new data model upgrade in your sandbox Salesforce organization before upgrading your production environment. For the new data model and changes between the old and new models, refer to the following aws-samples/partner-crm- integration-samples on GitHub: • Opportunity-FieldsAndStandardValues-DiﬀWithPrevVersion-V14.3.xlsx • Opportunity-Fields.xlsx • Opportunity_-_StandardValues.xlsx Upgrading AWS Partner CRM connector to the new data model 97 AWS Partner Central Prerequisites CRM Guide • Use ﬁeld deﬁnitions for new data model guidelines of the ACE CRM integration, and migrate any required open opportunities and leads to the new data model. • Add or remove columns in your custom or standard objects (objects used in mapping). • Ensure that you're using version 2.0 or later of the AWS Partner CRM connector. To upgrade to the new data model 1. Sign in to your Salesforce organization as a system administrator. 2. Deactivate any active schedules. 3. Choose Setup, Custom Settings, AWS Partner CRM connector Settings, and then update the version to 2.0 or later. Note Starting with version 2.0, the Version ﬁeld is mandatory. This ﬁeld speciﬁes the payload version that partners use to interact with the CRM Integration. When partners move to version 2.0, they must fully adopt its speciﬁcations. Reverting to previous versions
apc-crm-033	apc-crm.pdf	33	in mapping). • Ensure that you're using version 2.0 or later of the AWS Partner CRM connector. To upgrade to the new data model 1. Sign in to your Salesforce organization as a system administrator. 2. Deactivate any active schedules. 3. Choose Setup, Custom Settings, AWS Partner CRM connector Settings, and then update the version to 2.0 or later. Note Starting with version 2.0, the Version ﬁeld is mandatory. This ﬁeld speciﬁes the payload version that partners use to interact with the CRM Integration. When partners move to version 2.0, they must fully adopt its speciﬁcations. Reverting to previous versions isn't permitted. 4. Choose the ACE Mapping tab. 5. Create, review, and update all required ﬁeld mappings and details. For sandbox testing, use the custom ACE opportunity and ACE lead object to test the new data model features. For more information, refer to Sandbox testing with the custom ACE opportunity and ACE lead objects. 6. Activate schedules for opportunities and leads. 7. Review the ACE sync logs for synchronization errors and make any corrections. 8. Review the synced opportunities and leads to ensure that the data transformation is accurate. Alternatively, review the opportunities and leads in ACE to ensure that the new data model changes are captured accurately. 9. Follow your product deployment process to migrate the changes to your production Salesforce environment. Upgrading AWS Partner CRM connector to the new data model 98 AWS Partner Central Note If you need help, refer to Getting help. CRM Guide Sandbox testing with the custom ACE opportunity and ACE lead objects Note If you are an existing CRM connector user, refer to Upgrading AWS Partner CRM connector to the new data model. 1. Sign in to your Salesforce organization as a System Administrator. 2. Choose Setup, Custom settings, AWS Partner CRM connector settings, and update version to 2. 3. Choose the ACE Mapping tab. 4. For Opportunity, map it to the ACE opportunity custom object. 5. Choose Auto Map ACE object. Note For existing AWS Partners upgrading to the new version of the CRM connector that want to use the custom ACE opportunity and ACE lead objects from the connector for sandbox testing, we recommend manually deleting any available records from the Field Mappings and Field Mapping Details objects from the database before using the Auto Map ACE object feature. You only need to do this once. 6. Review ﬁeld mappings and ﬁeld mapping values for picklist and multipicklist. 7. Activate schedules for opportunities and leads. 8. Review the ACE Sync Logs for synchronization errors and make any required corrections. 9. Review the newly synched opportunities and leads to ensure that the data transformation is accurate. Alternatively, review the opportunities and leads in ACE to ensure that the new data model changes have been accurately captured. Sandbox testing with the custom ACE opportunity and ACE lead objects 99 AWS Partner Central CRM Guide Viewing sync log detail records for ACE opportunities You can view sync log details for AWS-delivered ACE opportunities on the Related tab on the ACE opportunity record. Note These steps only apply to AWS-delivered ACE opportunity objects. If you map to standard or custom objects in your Salesforce organization, you can view sync log details on the ACE Sync Log tab. 1. 2. Sign in to your Salesforce organization. In the App Launcher, choose AWS Partner CRM connector. 3. Choose the ACE Opportunities tab. 4. Choose an ACE opportunity record. 5. Choose the Related tab to view details including Sync Log Name, Status, Error Message, and Created Date. Linking AWS Marketplace private oﬀers to ACE opportunities You can link private oﬀers directly from the AWS delivered ACE opportunity record page. 1. 2. Sign in to your Salesforce organiziation. In the App Launcher, choose AWS Partner CRM connector. 3. Choose the ACE Opportunities tab. 4. Choose an ACE opportunity record. 5. Choose Link Private Oﬀer. 6. In Oﬀer ID Look Up, choose the private oﬀer. 7. Choose Save. Sandbox testing with the custom ACE opportunity and ACE lead objects 100 AWS Partner Central CRM Guide AWS Marketplace integration Using the AWS Partner CRM connector, AWS Marketplace sellers can create and manage private oﬀers and resale authorizations directly from their Salesforce organization. For more information, refer to What is AWS Marketplace? Topics • Conﬁguring baseline AWS permissions • Conﬁguring Salesforce core components • Validating AWS Marketplace integration • Additional resources: AWS API calls for the AWS Marketplace integration Note For more information about available features for AWS Marketplace, refer to the section called “AWS Marketplace features”. Conﬁguring baseline AWS permissions Follow the instructions in Creating an IAM user in your AWS account to create the user required for the integration. To install and conﬁgure the AWS Partner CRM connector for Salesforce, the user needs programmatic and AWS Management Console access. Then
apc-crm-034	apc-crm.pdf	34	organization. For more information, refer to What is AWS Marketplace? Topics • Conﬁguring baseline AWS permissions • Conﬁguring Salesforce core components • Validating AWS Marketplace integration • Additional resources: AWS API calls for the AWS Marketplace integration Note For more information about available features for AWS Marketplace, refer to the section called “AWS Marketplace features”. Conﬁguring baseline AWS permissions Follow the instructions in Creating an IAM user in your AWS account to create the user required for the integration. To install and conﬁgure the AWS Partner CRM connector for Salesforce, the user needs programmatic and AWS Management Console access. Then follow the instructions in Creating IAM Policies, and attach the following policies to the user you create. Topics • Available template for baseline permissions • Conﬁguring AWS Marketplace account • Required policies and permissions Available template for baseline permissions Use an AWS CloudFormation template to conﬁgure the AWS conﬁgurations of the AWS Partner CRM connector. To download the ﬁle, refer to AWSPartnerCRMConnectorSetup. AWS Marketplace integration 101 AWS Partner Central CRM Guide Conﬁguring AWS Marketplace account The following components are required to integrate AWS services in AWS Marketplace integration within the connector. AWS seller account You must have an AWS account that’s registered as a seller and have products listed in AWS Marketplace. For more information, refer to Drive revenue by selling in AWS Marketplace. Conﬁrm that you have added the required permissions in your AWS seller account. For more information, refer to Policies and permissions for AWS Marketplace sellers in the AWS Marketplace Seller Guide. Amazon S3 bucket Conﬁgure an Amazon Simple Storage Service (Amazon S3) bucket to store your custom End User License Agreement (EULA). This information is required when onboarding the AWS seller account into the connector. For more information, see Creating a bucket. Amazon SQS Set up an Amazon Simple Queue Service (Amazon SQS) queue in the us-east-1 Region (N. Virginia) to enable buyer notiﬁcation for the private oﬀer. Provide a name for the queue, for example AWSMPSQSQueue. For more information, refer to Getting started with Amazon SQS and Subscribing an Amazon SQS queue to an Amazon SNS topic. Service-linked role setup supporting Channel Partner Private Oﬀer Independent Software Vendors (ISVs) and Channel Partners (CPs) must create a custom AWS Identity and Access Management (IAM) role that provides permissions to AWS for ISVs and CPs to use resale authorizations to create Channel Partner Private Oﬀers (CPPOs). Refer to CPPO prerequisites. Required policies and permissions AWS Marketplace The AWSMarketplaceSellerFullAccess managed policy is required to work with AWS Marketplace Catalog API (CAPI). Conﬁguring baseline AWS permissions 102 AWS Partner Central CRM Guide To create and receive resale authorizations and create AWS Channel Partner private oﬀers, refer to Creating a custom IAM role. Amazon S3 The Amazon S3 policy allows the IAM role or user to see the bucket deﬁned by ${bucketName}, upload objects to the bucket, and create pre-signed URLs for objects in the bucket. This policy is required because the connector uploads a custom EULA to an S3 bucket that’s deﬁned in the conﬁguration and generates a pre-signed URL to pass to the AWS Marketplace CAPI. { "Version": "2012-10-17", "Statement": [ { "Sid": "S3ListBucket", "Effect": "Allow", "Action": [ "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::${bucketName}" ] }, { "Sid": "AllowS3PutObject", "Effect": "Allow", "Action": [ "s3:PutObject" ], "Resource": [ "arn:aws:s3:::${bucketName}/" ] }, { "Sid": "AllowCreatePresignedUrl", "Effect": "Allow", "Action": [ "s3:PutObject", "s3:PutObjectAcl", "s3:GetObject", "s3:GetObjectAcl" ], "Resource": [ Conﬁguring baseline AWS permissions 103 AWS Partner Central CRM Guide "arn:aws:s3:::${bucketName}/" ] } ] } Amazon SQS The following policy is required to extract and delete Amazon SNS notiﬁcations from the Amazon SQS queue. { "Version": "2012-10-17", "Statement": [ { "Action": [ "sqs:ReceiveMessage", "sqs:DeleteMessage", "sqs:GetQueueAttributes", "sqs:GetQueueUrl" ], "Effect": "Allow", "Resource": "arn:aws:sqs:us-east-1:<AWS account ID>:<QUEUENAME>" } ] } Conﬁguring Salesforce core components In this section, you'll learn about conﬁguring AWS Partner personas used in the AWS Partner CRM connector, guided setup of the AWS Marketplace integration, onboarding the AWS seller account, and Salesforce conﬁgurations. Topics • Permissions sets • Guided setup • Onboarding AWS seller account • System conﬁgurations Conﬁguring Salesforce core components 104 AWS Partner Central Permissions sets CRM Guide The following three primary AWS Partner personas are supported in the AWS Partner CRM connector. You can enable these personas by giving the Salesforce user the corresponding permission set included in the application. AWS Marketplace administrator Assign this persona to a systems or business administrator to perform the conﬁguration and manage schedules. This persona provides full access to the AWS Marketplace integration in the Salesforce connector. This persona can do the following: • Read, write, and view records for all objects related to the AWS Marketplace integration. • View all AWS Marketplace sync log records. • Create schedules related to AWS Marketplace entities. Note Certain settings in Salesforce require additional access, speciﬁcally named credentials and custom
apc-crm-035	apc-crm.pdf	35	can enable these personas by giving the Salesforce user the corresponding permission set included in the application. AWS Marketplace administrator Assign this persona to a systems or business administrator to perform the conﬁguration and manage schedules. This persona provides full access to the AWS Marketplace integration in the Salesforce connector. This persona can do the following: • Read, write, and view records for all objects related to the AWS Marketplace integration. • View all AWS Marketplace sync log records. • Create schedules related to AWS Marketplace entities. Note Certain settings in Salesforce require additional access, speciﬁcally named credentials and custom settings that AWS Partners must provide to users. However, if this permission set is paired with a Salesforce systems administrator proﬁle, all permissions needed to fully conﬁgure the application should work. AWS Marketplace user Assign this persona to the user who creates and manages private oﬀers and resale authorization. The AWS Marketplace user can do the following: • Synchronize AWS Marketplace products, oﬀers, and resale authorizations. • Modify expiry dates, and cancel and clone oﬀers and resale authorizations. • Access the AWS Marketplace dashboard. AWS Channel Partner user The AWS Channel Partner user can do the following: Conﬁguring Salesforce core components 105 AWS Partner Central CRM Guide • View available shared resale authorizations created by the Independent Software Vendor (ISV) seller. • View and create AWS Channel Partner private oﬀers from shared resale authorizations. Guided setup The AWS Partner CRM connector provides a guided setup to enable the AWS Marketplace integration. To launch the guided setup 1. 2. Log in to the Salesforce organization as a system administrator. From the App launcher, search for an choose the AWS Partner CRM connector. 3. Choose the AWS Guided Setup tab. 4. At the bottom of the page, choose the AWS Marketplace integration. Onboarding AWS seller account 1. 2. 3. 4. Log in to the Salesforce organization as a system administrator. In the top right corner of the page, choose the gear icon and choose Setup. In the Quick Find search bar, choose Named Credentials, Legacy Named Credentials. Enter the following details: • Label–AWS SELLER CATALOG • Name–AWS_SELLER_CATALOG_<Provide unique account prefix> • URL–https://catalog.marketplace.us-east-1.amazonaws.com • Identity type–Named Principal • Authentication protocol–AWS Signature Version 4 • AWS Access Key ID–Access key of IAM user • AWS Secret Access Key–Secret access key of IAM user • AWS Region–us-east-1 • AWS Service–aws-marketplace 5. Choose Save. 6. Repeat steps 1-6 to onboard other AWS services required for the integration. Conﬁguring Salesforce core components 106 AWS Partner Central CRM Guide The connector supports multiple AWS seller accounts. To use the connector to onboard multiple seller accounts, refer to the following table. Named Credential Label Named Credential Name AWS_SELLE API endpoint AWS Region AWS service R_S3_<Provide https://s AWS SELLER S3 unique account prefix> AWS_SELLE 3.amazona ws.com/ us-east-1 s3 R_STS_<Provide https://sts.us- AWS SELLER STS unique account prefix> AWS_SELLE east-1.amazo naws.com/ us-east-1 sts AWS SELLER SQS AWS SELLER AGREEMENT R_SQS_<Provide https://sqs.us- unique account prefix> AWS_SELLE R_AGREEME NT_<Provide unique account prefix> east-1.amazo naws.com/ us-east-1 sqs https://a greement- marketplace.us- east-1.amazo naws.com/ us-east-1 aws-marketplace After onboarding Named Credentials, go to the AWS Accounts table and choose Refresh Accounts to add the seller accounts to the AWS Accounts table. Conﬁguring Salesforce core components 107 AWS Partner Central System conﬁgurations CRM Guide 1. Log in to the Salesforce organization as a system administrator. 2. Open the AWS Marketplace Integration Settings custom settings. For more information, refer to View and Edit Custom Settings. 3. Choose Manage to add Default Org Level values. 4. Enter values for the following settings. Setting Name Default Value Description Amazon SQS Queue Name NULL Add seller account to buyer list FALSE Are you in any partner programs FALSE AWS Presigned URL Role Name NULL Amazon Simple Queue Service (Amazon SQS) queue used to subscribe to the Amazon Simple Notiﬁcat ion System (Amazon SNS) topic for retrieving notiﬁcat ions on the private oﬀer. Note that the connector requires that the name of the SQS queue be the same across all onboarded AWS accounts. Enables the addition of the seller account to the buyer list so you can view the private oﬀer within your account, similar to how a buyer would view it. The AWS Identity and Access Management (IAM) role in the seller account used for presigning the Amazon Conﬁguring Salesforce core components 108 AWS Partner Central CRM Guide Setting Name Default Value Description Simple Storage Service (Amazon S3) URL for the custom End User License Agreement (EULA) used with the AWS Marketplace catalog API (CAPI). Enables logging on outbound API calls through the connector. Indicates the level of logging for outbound request logs. Log_All_Outbound_R equests FALSE Log Level ERROR 5. Choose Save. 6. Return to custom settings and choose S3 Bucket Settings. 7. Choose Manage to add the custom setting for Amazon S3.
apc-crm-036	apc-crm.pdf	36	Identity and Access Management (IAM) role in the seller account used for presigning the Amazon Conﬁguring Salesforce core components 108 AWS Partner Central CRM Guide Setting Name Default Value Description Simple Storage Service (Amazon S3) URL for the custom End User License Agreement (EULA) used with the AWS Marketplace catalog API (CAPI). Enables logging on outbound API calls through the connector. Indicates the level of logging for outbound request logs. Log_All_Outbound_R equests FALSE Log Level ERROR 5. Choose Save. 6. Return to custom settings and choose S3 Bucket Settings. 7. Choose Manage to add the custom setting for Amazon S3. 8. Choose New. 9. Enter values for the following settings. Setting Name Default Value Description Name N/A S3 Bucket Name N/A S3 Bucket Preﬁx N/A Name of the Amazon S3 setting. This name should be same as the AWS account name in the AWS accounts table. Amazon S3 bucket name to store the custom EULA. Preﬁx of the Amazon S3 bucket to store the custom EULA. Conﬁguring Salesforce core components 109 AWS Partner Central 10. Choose Save. CRM Guide 11. Repeat steps 6-10 to add Amazon S3 settings for multiple seller accounts. Validating AWS Marketplace integration Topics • AWS Marketplace agreements • Agreement-based oﬀers • Synchronizing your AWS Marketplace products • AWS Marketplace private oﬀers • AWS Marketplace resale authorizations • AWS Marketplace Channel Partner Private Oﬀers • Flexible payment schedule (FPS) • Future dated agreement (FDA) AWS Marketplace agreements With the CRM connector, AWS sellers and Channel Partners can access agreements for private oﬀers and view agreement details. To import an agreement into the AWS Partner CRM connector 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Agreements tab. 4. Choose Import Agreement. 5. Choose the seller account. 6. Enter the agreement ID. 7. Choose Submit. To refresh agreements from AWS Marketplace 1. Log in to the Salesforce organization as an AWS Marketplace user. Validating AWS Marketplace integration 110 AWS Partner Central CRM Guide 2. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Agreements tab. 4. Choose Refresh Agreement. 5. In the Do you want to pull the list of Agreements from AWS Marketplace? dialog box, choose Proceed. Note Available agreements for all private oﬀers are synced and viewable on the Agreements tab. Agreement-based oﬀers AWS Marketplace sellers and Channel Partners can create agreement-based oﬀers (ABOs) to generate new private oﬀers based on existing agreements. Note Before creating an agreement-based oﬀer, Channel Partners should refresh the Shared resale authorization tab. To create an agreement-based oﬀer 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Agreements tab. 4. In the Agreements list, choose the agreement name. 5. Choose Create Agreement Based Oﬀer. 6. On the Create an Oﬀer form, complete the required ﬁelds. 7. Choose Create oﬀer. Synchronizing your AWS Marketplace products 1. Log in to the Salesforce organization as a system administrator. Validating AWS Marketplace integration 111 AWS Partner Central CRM Guide 2. From the App launcher, search for an choose AWS Partner CRM connector. 3. Choose the MP Products tab. 4. Choose Refresh Products to sync the AWS Marketplace products. 5. For the prompt Do you want to pull the list of products from the AWS Marketplace, choose Yes. Note Available AWS Marketplace products are synced and viewable on the MP Products tab. AWS Marketplace private oﬀers Creating an AWS Marketplace private oﬀer 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App launcher, search for an choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. Choose New. 5. On the Create an Oﬀer page, at a minimum, you must complete the required ﬁelds. You can also create a ﬂexible payment schedule and future dated agreement. • To create a ﬂexible payment schedule a. b. c. (Direct private oﬀers of AMI and Container Contract products only) In the Product Pricing section, choose Contract Model. In the Product and Buyers section, choose Enable ﬁxed units and allow buyers to pay for this product in installments. Conﬁgure payments in the Payment Schedule section. For more information, refer to Flexible payment schedule (FPS). • To create a future dated agreement a. b. In the Service Length section, choose New oﬀer starting at future date. Enter Service start date and Service end date (if required). For more information, refer to Future dated agreement (FDA). 6. Choose Create Oﬀer. Validating AWS Marketplace integration 112 AWS Partner Central Private oﬀer required ﬁelds Products and buyers • ISV–Self • Products–Choose from the list of available products synced through the connector. •
apc-crm-037	apc-crm.pdf	37	and allow buyers to pay for this product in installments. Conﬁgure payments in the Payment Schedule section. For more information, refer to Flexible payment schedule (FPS). • To create a future dated agreement a. b. In the Service Length section, choose New oﬀer starting at future date. Enter Service start date and Service end date (if required). For more information, refer to Future dated agreement (FDA). 6. Choose Create Oﬀer. Validating AWS Marketplace integration 112 AWS Partner Central Private oﬀer required ﬁelds Products and buyers • ISV–Self • Products–Choose from the list of available products synced through the connector. • Buyer Accounts–Enter your own seller test account to validate the integration. CRM Guide Oﬀer details • Oﬀer Name–Enter a custom name. • Oﬀer Description–Enter a custom oﬀer description. Service length or contract duration 1. Choose New oﬀer. 2. Choose a service length (for example, 12 months). Oﬀer dimensions 1. Choose the entitlement type that you want to oﬀer. 2. Add oﬀer rates to or update existing rates of your chosen dimensions. 3. To submit an oﬀer in which any of the dimension rates are set at $0, choose I want to enable zero dollar pricing. End User License Agreement (EULA) Choose Standard Contract for AWS Marketplace or Custom EULA. If you choose Custom EULA, you must conﬁgure an Amazon S3 bucket to store the custom EULA when you onboard the AWS seller account. Renewals For Is this oﬀer intended to renew an existing paid subscription with an existing customer for the same underlying product?, choose Yes or No. Validating AWS Marketplace integration 113 AWS Partner Central Expiration information CRM Guide Enter the oﬀer expiration date. For subscription-type products enter the subscription end date. Viewing and refreshing the private oﬀer status 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. From the Private Oﬀers list, choose the Private Oﬀer Name. 5. Choose Refresh Oﬀer Status. The oﬀer status (PREPARING, APPLYING, SUCCEEDED, or FAILED) displays at the bottom of the page. Note Private oﬀer status can take up to two hours to change to SUCCEEDED. Modifying an oﬀer expiration date 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. From the Private Oﬀers list, choose the Private Oﬀer Name. 5. Choose Modify Expiration Date. Canceling a private oﬀer 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. From the Private Oﬀers list, choose the Private Oﬀer Name. 5. Choose Cancel Oﬀer. Validating AWS Marketplace integration 114 AWS Partner Central Copying an oﬀer URL CRM Guide 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. From the Private Oﬀers list, choose the Private Oﬀer Name. 5. Choose Copy URL. Cloning a private oﬀer 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. From the Private Oﬀers list, choose the Private Oﬀer Name. 5. Choose Clone Oﬀer, which creates a new oﬀer based on the oﬀer you selected to clone. The CRM connector automatically inserts the AWS seller account number in the Buyer Accounts list. This helps the seller to refer to the private oﬀer from the buyer's perspective. 6. 7. Edit the Oﬀer Details section of the cloned oﬀer as necessary. If necessary, re-upload the EULA. 8. Choose Create oﬀer. Using the FPS utility to populate payment schedules When creating an AWS Marketplace private oﬀer, use the FPS utility to populate payment schedules with ﬁxed costs and equal payment gaps. 1. On the Payment Schedule tab, choose Yes to generate a payment schedule with ﬁxed cost and equal payment gaps. 2. Choose a Payment Frequency of 15, 30, 90. or 365 days. 3. Choose Remainder Options. To place the remainder of the uneven payment on the ﬁrst payment, choose Frontload. To place the remainder on the last payment, choose Backend. 4. For Calendar Options, to conﬁgure the payment frequency to include weekend days, choose Calendar Day. To not include weekend days, choose Business Day. Validating AWS Marketplace integration 115 AWS Partner Central CRM Guide 5. Enter the payment amount (sum of all payments), payment start date (ﬁrst payment), and approximate payment end date. 6. Choose Generate Schedule. 7. Review and edit the payment amounts and invoice dates as
apc-crm-038	apc-crm.pdf	38	90. or 365 days. 3. Choose Remainder Options. To place the remainder of the uneven payment on the ﬁrst payment, choose Frontload. To place the remainder on the last payment, choose Backend. 4. For Calendar Options, to conﬁgure the payment frequency to include weekend days, choose Calendar Day. To not include weekend days, choose Business Day. Validating AWS Marketplace integration 115 AWS Partner Central CRM Guide 5. Enter the payment amount (sum of all payments), payment start date (ﬁrst payment), and approximate payment end date. 6. Choose Generate Schedule. 7. Review and edit the payment amounts and invoice dates as needed. Importing existing private oﬀer details from AWS Marketplace You can import an existing private oﬀer from AWS Marketplace into Salesforce. 1. 2. Log in to your Salesforce organization as an AWS Marketplace user. In the App Launcher, choose AWS Partner CRM Connector. 3. Choose the Private Oﬀers tab. 4. Choose Import Oﬀer. 5. Enter the oﬀer ID. 6. Choose Submit. Saving an oﬀer as a draft You can save an oﬀer as a draft to complete later without releasing it to the buyer. 1. 2. Log in to your Salesforce organization as an AWS Marketplace user. In the App Launcher, choose AWS Partner CRM connector. 3. Choose the Private Oﬀers tab. 4. Choose New. 5. On the Create an Oﬀer form, complete the mandatory ﬁelds. 6. Choose Save as Draft. AWS Marketplace resale authorizations Creating an AWS Marketplace resale authorization As an ISV, you can authorize an AWS Channel Partner to resell your products by creating a resale authorization. You can specify a ﬁxed rate per product dimension to create a wholesale price for the AWS Channel Partner. The AWS Channel Partner can mark up the wholesale price when creating their private oﬀer for a buyer. Validating AWS Marketplace integration 116 AWS Partner Central CRM Guide To create an AWS Marketplace resale authorization 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. Choose New. 5. On the Create a Resale Authorization page, at a minimum, you must complete the required ﬁelds. You can also create a ﬂexible payment schedule. To create a ﬂexible payment schedule a. b. c. (Direct private oﬀers of AMI and Container Contract products only) In the Product Pricing section, choose Contract Model. In the Product and Buyers section, choose Enable ﬁxed units and allow buyers to pay for this product in installments. Conﬁgure payments in the Payment Schedule section. For more information, refer to Flexible payment schedule (FPS). 6. Choose Create Resale Authorization. 7. View and refresh the resale authorization status. For more information, refer to Viewing and refreshing resale authorization status. Resale authorization required ﬁelds Products and buyers • Products–Choose from the list of available products synched through the CRM connector. • Buyer Accounts–A list of comma-separated buyer accounts to target the private oﬀer, as needed. Resale Authorization Details • Resale Authorization Name–Enter a name. • Description–Enter a description (viewable by the AWS Channel Partner). • Reseller Account–Enter the 12-digit AWS account number of the reseller. Validating AWS Marketplace integration 117 AWS Partner Central Contract duration (if applicable) • Choices include Standard or Custom Duration. • For Custom Duration, enter Custom Service Length. Product pricing (if applicable) CRM Guide • Choices include Usage model or Contract model. • For Contract model, you can enable FPS in the Buyers and Products section. Product dimensions • Add or update oﬀer rates and units to the chosen dimensions. • Choose I want to enable zero-dollar pricing, to create a resale authorization in which any of the dimension rates are set to $0. Legal terms • Choose Standard Contract for AWS Marketplace or Custom EULA for End User License Agreement for the buyer. • Optionally, choose Reseller Contract for AWS Marketplace or Custom Contract for Reseller Agreement. • For Custom EULA (Buyer) and Custom Contract (Reseller), ensure that you have conﬁgured the Amazon S3 bucket for the seller account to store the custom EULA. Resale Authorization Duration Choose Duration Type and provide details for the Resale Authorization Expiration Date as required. Renewals For Is this oﬀer intended to renew an existing paid subscription with an existing customer for the same underlying product?, choose Yes or No, and enter the required details. Deactivating a resale authorization 1. Log in to the Salesforce organization as an AWS Marketplace user. Validating AWS Marketplace integration 118 AWS Partner Central CRM Guide 2. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. From the list of resale authorizations, choose the Resale Authorization Name. 5. Choose Deactivate Resale Authorization. 6. Choose Refresh Resale Authorization Status. Note The status is Restricted for
apc-crm-039	apc-crm.pdf	39	oﬀer intended to renew an existing paid subscription with an existing customer for the same underlying product?, choose Yes or No, and enter the required details. Deactivating a resale authorization 1. Log in to the Salesforce organization as an AWS Marketplace user. Validating AWS Marketplace integration 118 AWS Partner Central CRM Guide 2. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. From the list of resale authorizations, choose the Resale Authorization Name. 5. Choose Deactivate Resale Authorization. 6. Choose Refresh Resale Authorization Status. Note The status is Restricted for a successfully deactivated resale authorization. Cloning a resale authorization 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. From the list of resale authorizations, choose the Resale Authorization Name. 5. Choose Clone Resale Authorization 6. Review and edit the Resale Authorization Details section of the cloned authorization. If you use a custom EULA or a custom contract (reseller agreement) in the cloned authorization, you must re-upload the legal terms. 7. Choose Create Resale Authorization. Viewing and refreshing resale authorization status 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. From the Resale Authorizations list, choose the Resale Authorization Name. 5. Choose Refresh Resale Authorization Status. 6. Choose Proceed. 7. Repeat steps 5 and 6 until the resale authorization status is SUCCEEDED. Validating AWS Marketplace integration 119 AWS Partner Central Note CRM Guide It is recommended to allow a 30-second interval before choosing the Refresh Resale Authorization Status button again. This ensures that each refresh request is fully processed and preserves data integrity by preventing potential record duplication. Saving a resale authorization as a draft You can save a resale authorization in draft form for completion later without releasing it to the Channel Partner. 1. 2. Log in to your Salesforce organization as an AWS Marketplace user. In the App Launcher, choose AWS Partner CRM connector. 3. Choose the Resale Authorizations tab. 4. Choose New. 5. On the Create a Resale Authorization form, complete the mandatory ﬁelds. 6. Choose Save as Draft. AWS Marketplace Channel Partner Private Oﬀers Creating an AWS Marketplace Channel Partner Private Oﬀer For recurring discount private oﬀers, an ISV authorizes an AWS Channel Partner to resell one or more of their products on AWS Marketplace. The discount, called the wholesale price, is an agreed- to price or percentage discount oﬀ the product’s list price. AWS Channel Partners can use the discount with buyers to the extent speciﬁed by the ISV in the resale authorization. The following instructions explain how to create an AWS Channel Partner private oﬀer on the Shared Resale Authorizations tab. You can also create an AWS Channel Partner private oﬀer on the Private Oﬀers tab. 1. 2. Log in to the Salesforce organization as an AWS Marketplace user. From the App Launcher, search for and choose AWS Partner CRM connector. 3. Choose the Shared Resale Authorizations tab. 4. Choose the shared resale authorization. 5. Choose Create oﬀer. Validating AWS Marketplace integration 120 AWS Partner Central CRM Guide 6. On the Create an Oﬀer page, at a minimum, you must complete the required ﬁelds. You can also create a ﬂexible payment schedule and future dated agreement. • To create a ﬂexible payment schedule a. b. c. (Direct private oﬀers of AMI and Container Contract products only) In the Product Pricing section, choose Contract Model. In the Product and Buyers section, choose Enable ﬁxed units and allow buyers to pay for this product in installments. Conﬁgure payments in the Payment Schedule section. For more information, refer to Flexible payment schedule (FPS). • To create a future dated agreement a. b. In the Service Length section, choose New oﬀer starting at future date. Enter Service start date and Service end date (if required). For more information, refer to Future dated agreement (FDA). 7. View and refresh the oﬀer status. For more information, refer to Viewing and refreshing the private oﬀer status. Note To create a Channel Partner Private Oﬀer (CPPO) or an agreement-based oﬀer (ABO) using a shared resale authorization (SRA), review the shared resale authorization record details in the CRM connector. Channel partner private oﬀer required ﬁelds Products and Buyers • Enter the buyer account(s) • Accept the reseller contract. • Enable ﬁxed units and allow buyers to pay for this product in installments. Oﬀer Details Add your desired name. Validating AWS Marketplace integration 121 AWS Partner Central Contract Duration CRM Guide If an applicable product exists, the value defaults to the one used in the shared resale authorization. Usage
apc-crm-040	apc-crm.pdf	40	Note To create a Channel Partner Private Oﬀer (CPPO) or an agreement-based oﬀer (ABO) using a shared resale authorization (SRA), review the shared resale authorization record details in the CRM connector. Channel partner private oﬀer required ﬁelds Products and Buyers • Enter the buyer account(s) • Accept the reseller contract. • Enable ﬁxed units and allow buyers to pay for this product in installments. Oﬀer Details Add your desired name. Validating AWS Marketplace integration 121 AWS Partner Central Contract Duration CRM Guide If an applicable product exists, the value defaults to the one used in the shared resale authorization. Usage Duration Enter a duration for the oﬀer. Price Adjustment Enter your price adjustment. ISV Legal Terms and Documentation Review ISV terms for the buyer. Legal Terms and Other Documentation Upload additional legal terms, if applicable. Expiration Information Enter a date. Related topics • To modify a Channel Partner Private Oﬀer, refer to Modifying an oﬀer expiration date. • To cancel a Channel Partner Private Oﬀer, refer to Canceling a private oﬀer. • To copy the URL of a Channel Partner Private Oﬀer, refer to Copying an oﬀer URL. • To clone a Channel Partner Private Oﬀer, refer to Cloning a private oﬀer. Flexible payment schedule (FPS) You can enable a ﬂexible payment schedule (FPS) for private oﬀers, resale authorizations, agreement-based oﬀers, and Channel Partner Private Oﬀer. FPSs are available for the following product types: • SaaS contract • SaaS contract with consumption • AMI contract Validating AWS Marketplace integration 122 AWS Partner Central • Container contract Future dated agreement (FDA) You can create future dated agreements for the following product types: CRM Guide • SaaS Contract with Consumption • SaaS Contract Note For more information about Future Dated Agreements (FDAs), refer to Working with future dated agreements and private oﬀers in the AWS Marketplace Seller Guide. Additional resources: AWS API calls for the AWS Marketplace integration • Refer to the AWS Marketplace Catalog API Reference to learn about the following APIs: • ListEntities • DescribeEntity • StartChangeSet • DescribeChangeSet • DescribeAgreement • GetAgreementTerms • SearchAgreements • Refer to Amazon S3 REST API Introduction to learn about various API operations, related request and response structures, and error codes. • Refer to Welcome to the Amazon SNS API Reference to learn more about Amazon SNS. • Refer to What is Amazon Simple Queue Service? to learn more about Amazon SQS. Getting help For help with a CRM integration, submit a support case in AWS Partner Central. Additional resources: AWS API calls for the AWS Marketplace integration 123 AWS Partner Central CRM Guide For CRM connector enablement or operations support, complete the following steps: 1. Sign in to AWS Partner Central. 2. From the top menu, choose Support, Contact Support. 3. On the AWS Partner Support page, choose Open New Case. 4. On the Open New Support Case page, choose CRM Integration. 5. From the Type of request dropdown list, select a Type. 6. From the Please specify further dropdown list, select a Subtype. 7. Enter a subject and description. 8. (Optional) Attach ﬁles of up to 3 MB. 9. Choose Submit. AWS Partner CRM connector FAQ The topics in this section help answer frequently asked questions about AWS Partner CRM integration and using the CRM connector. Note The questions and answers in this FAQ assume that you use Salesforce. For more information about using Salesforce, see the Salesforce help. Topics • General questions • Setup issues • Mapping issues • Synchronization and validation issues General questions Expand the following sections for more information about using the AWS Partner CRM connector. AWS Partner CRM connector FAQ 124 AWS Partner Central CRM Guide How do I get started with the AWS Partner CRM connector? Contact your partner development manager (PDM) or your AWS point of contact. Your PDM will verify eligibility, help set up the IAM user required for authentication and submit the request internally to set up the Amazon S3 bucket required for you to exchange ﬁles. After you have access to the Amazon S3 bucket, you can install the connector and set up the integration by following the instructions in the user guide. Partners who already have an AWS Partner integration can get started by installing the connector from the Salesforce AppExchange and following the instructions in Guided setup earlier in this guide. Why move to version 3? Version 3 provides real-time opportunity updates and eliminates the need for schedules. It also provides a set of buttons that enable partners to accept or reject leads and opportunities, update them, and send them to AWS. For information about installing version 3, see Available features earlier in this guide. What is the latest version of connector? Version 3.0.0. You can ﬁnd it in the Salesforce App Exchange. What does it cost to set up
apc-crm-041	apc-crm.pdf	41	get started by installing the connector from the Salesforce AppExchange and following the instructions in Guided setup earlier in this guide. Why move to version 3? Version 3 provides real-time opportunity updates and eliminates the need for schedules. It also provides a set of buttons that enable partners to accept or reject leads and opportunities, update them, and send them to AWS. For information about installing version 3, see Available features earlier in this guide. What is the latest version of connector? Version 3.0.0. You can ﬁnd it in the Salesforce App Exchange. What does it cost to set up the AWS Partner CRM connector? The AWS Partner CRM connector is a no-code solution available for free from the Salesforce App Exchange. It provides the following integration options: • An Amazon S3-based integration where AWS hosts and bears the costs of an Amazon S3 bucket. • A Partner Central API-based integration where the AWS service calls are free. Amazon EventBridge is also free because the events come from an AWS service. However, you may incur additional charges on your AWS account if you forward the events to other event buses from the primary event listener for additional processing. For more information about the AWS Partner CRM connector, see ACE integration. For more information about EventBridge, see What is Amazon EventBridge? in the Amazon EventBridge User Guide. General questions 125 AWS Partner Central CRM Guide What new features does version 3 provide? For a list of the features provided by the AWS Partner CRM connector, see Partner Central API features, earlier in this guide. Can I programmatically access the Amazon S3 bucket used to send and receive ﬁles? Yes. Use the AccessKey and SecretAccessKey credentials of the IAM user from the CRM Integration onboarding request. Remember, ﬁles are no longer be transferred using the Amazon S3 bucket once you port the integration over to the API based approach. However, leads are still shared using the Amazon S3 bucket based integration. I haven't moved to the Salesforce Lightning version. Can I still use the AWS Partner CRM connector? The AWS Partner CRM connector is designed for use with the Salesforce Lightning version, so version 2 may not function as intended. Can I use the package directly on my production systems? We recommend that you install the package on production systems only after thoroughly testing in a sandbox environment. Who are the intended users of the AWS Partner CRM connector? AWS Partner CRM connector is designed for the following user personas: • Salesforce administrators or referral administrators who set up the connector. • Sales operations users who select, accept, and update opportunities and leads. I have an ACE integration. Can I move to the connector? Yes. AWS Partners that have an existing integration with ACE can move to the connector. Because the connector uses the same Amazon S3 bucket in the back end, complete the following steps: 1. Disconnect your custom app or solution from the Amazon S3 bucket. 2. Sign in to the AWS account to set up the integration. Obtain or create a secret key and access key for the IAM user that is authorized to access the Amazon S3 bucket. The user name must General questions 126 AWS Partner Central CRM Guide follow this format: apn-ace-{partnerName}-AccessUser-prod. For more information, see Manage access keys for IAM users in the AWS Identity and Access Management User Guide. Note If you're unable to ﬁnd the AWS account, submit a support request. 3. To conﬁgure the connector to point to the Amazon S3 bucket, choose Setup, then Named Credentials, then APN API connection. 4. Submit a support request to delete existing objects in the Amazon S3 bucket before scheduling a job in the connector. Important You must complete this step before completing the integration and setting a synchronization schedule. 5. If the target object is diﬀerent from the existing object, conduct a data backﬁll for your existing leads and opportunities. For more information, refer to the CRM integration Production setup and backﬁll guide. Note During the integration switchover, all user updates queue in the Outbound folder of the Amazon S3 bucket. After the integration is live, the user-update records are synced. Is the AWS Partner CRM connector safe to use in my Salesforce organization? The Salesforce application has gone through Salesforce and internal AWS security reviews. The Salesforce security review scans include the following threats: • Salesforce Object Query Language (SOQL) and SQL injection • Cross-site scripting • Non-secure authentication and access control protocols • Record-sharing violations and other vulnerabilities speciﬁc to the Salesforce platform General questions 127 AWS Partner Central CRM Guide The code review uses the Salesforce Code Analyzer to inspect Salesforce code. Salesforce Code Analyzer uses multiple code analysis engines, including PMD, ESLint, and RetireJS. It identiﬁes a number of potential
apc-crm-042	apc-crm.pdf	42	Partner CRM connector safe to use in my Salesforce organization? The Salesforce application has gone through Salesforce and internal AWS security reviews. The Salesforce security review scans include the following threats: • Salesforce Object Query Language (SOQL) and SQL injection • Cross-site scripting • Non-secure authentication and access control protocols • Record-sharing violations and other vulnerabilities speciﬁc to the Salesforce platform General questions 127 AWS Partner Central CRM Guide The code review uses the Salesforce Code Analyzer to inspect Salesforce code. Salesforce Code Analyzer uses multiple code analysis engines, including PMD, ESLint, and RetireJS. It identiﬁes a number of potential problems, from inconsistent naming to security vulnerabilities. For more information on the review process, refer to AppExchange Security Review in the Salesforce documentation. Note Partner applications are non-Salesforce.com applications as deﬁned in the Salesforce Main Services Agreement. For more information, refer to the Salesforce Agreements and Terms. Notwithstanding any security requirements set forth herein or any security review of a partner application that may occur, Salesforce makes no guarantees regarding the quality or security of any partner application, and customers are solely responsible for evaluating the quality, security, and functionality of partner applications to determine their adequacy and appropriateness for customers' installation and use. While we cannot share speciﬁcally what our internal security audit covers, it is geared towards the native AWS components of the integration architecture, to which the Salesforce app connects and covers a number of diﬀerent threat modeling scenarios such as man-in-the-middle attacks, distributed denial-of-service mitigations, and encryption standards. For more information, submit a support request. Setup issues Expand the following sections for information about ﬁxing set up issues with the AWS Partner CRM connector. What are the prerequisites for using the AWS Partner CRM connector? For information about the prerequisites for using the AWS Partner CRM connector, see the ACE prerequisites earlier in this guide. How do I set up the named credentials for the package? Follow these steps listed in Setting up named credentials earlier in this guide. Setup issues 128 AWS Partner Central CRM Guide What are implications of moving from version 2 to version 3? Are there any breaking changes? Moving from version 2 to version 3 of AWS Partner CRM connector has no immediate implications. All the functionality is backward compatible and works without interruptions. For opportunity management, if you plan to use the new features, you may need to change some of your sales processes. You should evaluate the following changes and create a transition plan. • Version 3 shares opportunities with AWS in real time. You no longer need to create schedules for sending opportunities to AWS. Opportunity owners on a partner's Salesforce instance must manually send data to AWS. Salesforce users need permissions to push opportunities to AWS. • If you plan to use multi-object mapping, you need a transition plan for getting and posting data from new objects in your Salesforce instance. As a Salesforce admin, you should be aware of consequences of moving from object mapping with all ﬁelds mapped in a single object versus ﬁelds from a diﬀerent object mapped to a single object. Moving from an Amazon S3 connection (Asynchronous) to an API based connection (Synchronous), are there additional set up steps? Yes. You must complete the following items: • Link an AWS account to Partner Central. • Create named credentials for the new Partner Central APIs We have not moved to the Salesforce Lightning version. Can we still use the AWS Partner CRM Connector? No. The connector is designed for use with the Salesforce Lightning version, and the app may not function as intended without it. We are reaching the limit on scheduled jobs in our Salesforce environment. Can we use external schedulers to trigger synching with AWS? NEED TO VALIDATE - AWS Partner CRM Connector is managed package. You can create custom schedule invocation with third party apps against the InboundSyncScheduler and OutboundSyncScheduler apex classes. Note - With new API based integration, these classes might not work. Setup issues 129 AWS Partner Central Mapping issues CRM Guide Expand the following sections as needed for information about ﬁxing object-mapping issues with the AWS Partner CRM connector. How does multi object mapping work? For version 3, partners can select the ﬁelds of referenced objects one level down while mapping. For example, if your Salesforce standard opportunity object has an internal reference pointing to an account object and a custom AWS sales object, you can select the standard opportunity as the parent object, then map ﬁelds from the account and sales objects. Can I select more than one object in the mapping tab? No. Instead, you map multiple ﬁelds from a selected object. How does the connector track the objects it uses to marshal data? Version 3 uses the APNCrmUniqueIdentifier ﬁeld to reference a single parent
apc-crm-043	apc-crm.pdf	43	3, partners can select the ﬁelds of referenced objects one level down while mapping. For example, if your Salesforce standard opportunity object has an internal reference pointing to an account object and a custom AWS sales object, you can select the standard opportunity as the parent object, then map ﬁelds from the account and sales objects. Can I select more than one object in the mapping tab? No. Instead, you map multiple ﬁelds from a selected object. How does the connector track the objects it uses to marshal data? Version 3 uses the APNCrmUniqueIdentifier ﬁeld to reference a single parent object for mapping. The ﬁeld contains the AWS record ID. After querying the parent object, the values of all other related objects are marshalled or unmarshalled based on the reference link from the parent object. Where can I ﬁnd the types ﬁeld for a particular ﬁeld? Version 3 of the connector works on the version 2 data model. For complete payload information, see the AWS Partner CRM Integration Samples on GitHub. Does the managed package help set up validation rules on my standard Salesforce object? No. The package comes with the ACE custom opportunity object, which includes the ﬁeld types and validation rules that run against the standard ACE payload. You can copy the validation rules and ﬁelds from an ACE custom opportunity object in your standard object. NEED TO VALIDATE - With multi-object mapping, you can try adding a reference to an ACE opportunity object inside your standard opportunity object, then copying data into those ﬁelds using triggers to kick oﬀ validations. Why can't I edit the mapping for the Sync with AWS ﬁeld? The Sync with AWS checkbox determines whether a lead or opportunity synchronizes with AWS when the next scheduled job runs. The Sync with Partner Central ﬁeld is included with the app for Mapping issues 130 AWS Partner Central CRM Guide standard opportunities and leads. If your target object is a custom object, you must map the Sync with AWS ﬁeld to a custom non-formula boolean ﬁeld in each object. How does the Has Updates for AWS ﬁeld work? The Has Updates for AWS formula ﬁeld determines if a record is sent to AWS Partner in the next scheduled job. Has Updates for AWS is set to True when the following conditions are true: • Last Modiﬁed Date of the record is later than Last APN Sync Date. • Last Modiﬁed User is not the user that scheduled the integration jobs. Why can't I map the required APN CRM Unique Identiﬁer ﬁeld? The menu is unavailable, and I receive the message "No valid ﬁeld to map" You must use the Text data type with a length of 18 characters to match the length of the API ﬁeld. • Conﬁguration: Text (18) (External ID) (Unique Case Insensitive) What are the connector app's troubleshooting checkpoints for outbound ﬁle push from Salesforce to AWS Partner? The app uses the following checkpoints: • Sync to AWS must be checked in order to sync with AWS. • Has Update to AWS must be checked in order to sync with AWS. • The user persona for creating the scheduling job must be diﬀerent from the user persona for used to create and update leads or opportunities. • If the previous checks are true but the outbound batch still doesn't run, check the AWS Partner sync logs and add the outbound IDs column. Conﬁrm that the sync log contains the ID of the opportunity that you want to push. If the sync log is stuck in the API Success state, delete the sync log record and try again. When Expected Monthly AWS Revenue is not an integer, such as 1041.67 instead of 1041, the mismatch in data type causes a processing error. To resolve this, delete the sync log stuck in the API Success state and correct the data before the next job run. Mapping issues 131 AWS Partner Central CRM Guide Can I conﬁgure ﬁlters and subscriptions to sync leads and opportunities? Can we add custom ﬁlters on status or stage ﬁelds? In Salesforce, you can create or update the formula ﬁeld to add the dependency from the status or stage ﬁelds for a speciﬁc value. For example, you can set Has Updates for AWS to True. You can use the included ﬁeld on the opportunity as a reference. The following example shows how: IF( OR( AND ( OR(LastModifiedDate > awsapn_Last_APN_Sync_Date_c,LastModifiedDate = awsapn_Last_APN_Sync_Date_c), awsapn_Sync_with_Partner_Central_c, NOT(ISNULL(awsapn_Last_APN_Sync_Date_c)) ), AND(ISNULL(awsapn_Last_APN_Sync_Date_c),awsapn_Sync_with_Partner_Central_c) ) , true , false ) Do I have to map the mandatory ﬁelds? Yes. You must map all mandatory ﬁelds in order to schedule an inbound or outbound integration job. Can I map lookup ﬁelds? We recommend reviewing the ﬁelds that you currently enter in Partner Central to determine the most relevant ﬁelds (in
apc-crm-044	apc-crm.pdf	44	for a speciﬁc value. For example, you can set Has Updates for AWS to True. You can use the included ﬁeld on the opportunity as a reference. The following example shows how: IF( OR( AND ( OR(LastModifiedDate > awsapn_Last_APN_Sync_Date_c,LastModifiedDate = awsapn_Last_APN_Sync_Date_c), awsapn_Sync_with_Partner_Central_c, NOT(ISNULL(awsapn_Last_APN_Sync_Date_c)) ), AND(ISNULL(awsapn_Last_APN_Sync_Date_c),awsapn_Sync_with_Partner_Central_c) ) , true , false ) Do I have to map the mandatory ﬁelds? Yes. You must map all mandatory ﬁelds in order to schedule an inbound or outbound integration job. Can I map lookup ﬁelds? We recommend reviewing the ﬁelds that you currently enter in Partner Central to determine the most relevant ﬁelds (in addition to the required ﬁelds). For a list of available ﬁelds and their purposes, see the Field Deﬁnition Guide included in the ACE CRM Development Kit on Partner Central. Should I update the record with derived ﬁelds or create them during the mapping process? Complex logic and derivations should be done in your Salesforce organization based on your own business logic, then populate the mapped ﬁeld based on it. Synchronization and validation issues Expand the following sections as needed for information about ﬁxing synchronization and validation issues with the AWS Partner CRM connector. Synchronization and validation issues 132 AWS Partner Central CRM Guide What causes the STORAGE_LIMIT_EXCEEDED error? This issue happens when you test the connector in a development organization with limited storage. To ﬁx it, clear the sync logs from the console by running the following query: Listawsapn_Sync_Log_c syncLogs = [SELECT Id FROM awsapn_Sync_Log_c WHERE Status IN ('API Success', 'Processed') LIMIT 4000]; delete syncLogs; You can also set the sync log retention period to automatically clean up sync log records older than the retention period. For more information about setting the retention period, see AWS referred leads or opportunities don't comply with the validation imposed on my custom object. How can I ﬁx this issue? Some leads and AWS originated opportunities don't comply with the validation rules for each ﬁeld. To allow partners to accept or reject such referrals, you can correct the data before accepting a record. To accept or reject an object that is non-compliant with the data validations, complete the following steps: 1. Navigate to the sync log details of the failed record. 2. Choose Edit Payload to access the JSON view. 3. Update the values of non-compliant ﬁelds. 4. Choose Save Payload to set up the record for sync for the next job. If the record is accepted, you must repeat steps 1–4 again after receiving the remaining ﬁelds from AWS. For subsequent syncs, the corrected values are used. As an alternative, you can correct the values in the ACE pipeline manager on Partner Central. How often does AWS upload leads and opportunities? AWS uploads leads and opportunities to the Amazon S3 bucket every hour. As a result, actions that require a data update through the integration can take up to an hour to synchronize. Why do I get a setFieldLengthWarning message when using the mapping screen? The following warning appears when a user performing object mapping doesn't have read access to the required ﬁelds: pe.setFieldLengthWarning()@ - /modules/awsapn/fieldMappingRow.js:1:7831 Synchronization and validation issues 133 AWS Partner Central CRM Guide set salesforceFields()@- /modules/awsapn/fieldMappingRow.js:1:5624 You must use a system administrator user with permissions to the source and target ﬁelds, or a user with the APN integration permission set. What do the Status and Purpose ﬁelds in the sync log mean? To determine the state and action on each sync log record, refer to the tables in the section called “Sync logs”. Do you provide auditing or archiving? The sync log object tracks all inbound and outbound transactions. You can also specify a retention period for log records in the app conﬁguration. Why do I get a throttling exception? The Partner Central APIs have a set of quotas that ensure fair use and avoid service misuse. You might see the throttling exception when rate limiting kicks in after you reach a quota. Daily quotas reset on a rolling 24-hour cycle. If the default quotas do not meet your requirements, you can use the Service Quotas page to request a quota increase. I don't see the Send to AWS button on my standard opportunity The Send to AWS button only appears for the Partner referral opportunity type. Synchronization and validation issues 134 AWS Partner Central CRM Guide Custom integration using Amazon S3 Partners can integrate their customer relationship management (CRM) with AWS Partner Network (APN) Customer Engagement (ACE) Pipeline Manager in Partner Central. You can do this by using a CRM-agnostic and ﬁle-based transfer mechanism, facilitated by Amazon Simple Storage Service. The following sections explain how. Topics • Integration resources • Implementing a custom integration • Lead sharing • Opportunity sharing • Field mapping • Best practices • Quotas • Version history • FAQs Integration resources AWS provides the following
apc-crm-045	apc-crm.pdf	45	appears for the Partner referral opportunity type. Synchronization and validation issues 134 AWS Partner Central CRM Guide Custom integration using Amazon S3 Partners can integrate their customer relationship management (CRM) with AWS Partner Network (APN) Customer Engagement (ACE) Pipeline Manager in Partner Central. You can do this by using a CRM-agnostic and ﬁle-based transfer mechanism, facilitated by Amazon Simple Storage Service. The following sections explain how. Topics • Integration resources • Implementing a custom integration • Lead sharing • Opportunity sharing • Field mapping • Best practices • Quotas • Version history • FAQs Integration resources AWS provides the following resources to help you create a custom integration. Topics • Field deﬁnitions • Standard values • Sample inbound ﬁles • Sample outbound ﬁles • Sample processed results • Sample test cases • Sample code snippets Integration resources 135 AWS Partner Central Field deﬁnitions CRM Guide These are comprehensive lists of all the ﬁelds, explaining their data types, usage, and any constraints or formatting rules that apply. They serve as a reference to ensure that when partners and AWS exchange data, it’s correctly formatted and understood. The following links take you to GitHub. • Opportunity • Lead Standard values These lists outline the standard values and enumerations for various ﬁelds. They help to maintain consistency in the data exchanged, and ensure that both parties have a common understanding of the values used. The following links take you to GitHub. • Opportunity • Lead Sample inbound ﬁles The following sample ﬁles show the structure of the JSON payload for a ﬁle sent from a partner to AWS. The following links take you to GitHub. • Opportunity • Lead Sample outbound ﬁles The following sample ﬁles show the structure of the JSON payload for a ﬁle sent from AWS to a partner. The following links take you to GitHub. Field deﬁnitions 136 AWS Partner Central • Opportunity • Lead Sample processed results CRM Guide The following ﬁles show a typical result after AWS processes a payload sent by a partner. The following links take you to GitHub. • Opportunity • Lead Sample test cases The following links take you to GitHub. • Opportunity • Lead Sample code snippets The following links take you to GitHub. • ace_read_s3.py • Apex_Sample_REST_API_Code.cls • S3_Authentication.cls • Sample_AceOutboundBatch.cls • SFDC apex s3 sample.txt • Apex_get_ﬁles_from_s3_ace_partner_test.cls • s3_ace_partner_test.cls Implementing a custom integration The topics in this section assume that you've followed the instructions in AWS Partner CRM integration, and completed the ﬁrst three stages. We also assume that you have your AWS account, Sample processed results 137 AWS Partner Central CRM Guide AWS Identity and Access Management (IAM) setup, sandbox created, and policies attached to access the bucket. To implement a custom integration • Follow the steps in the section called “Stage 4: Implementation”, earlier in this guide. For more information, refer to the Production checklist, the section called “Opportunity sharing”, and the section called “Lead sharing”. Lead sharing How AWS shares leads 1. Incremental exports: Amazon Web Services (AWS) exports new leads (and updates) referred by AWS, on an hourly basis. 2. File creation: AWS generates lead ﬁles adhering to a speciﬁc format. For detailed ﬁle speciﬁcations, refer to the section called “Field deﬁnitions”. 3. File upload: The lead ﬁles are uploaded to the lead-outbound folder. Consuming leads from AWS To eﬀectively consume leads from AWS, build custom integration with the following functionalities. 1. File retrieval: • Regularly scan the lead-outbound folder using a scheduled job at an interval you choose. • Retrieve the lead ﬁles for processing. 2. Data transformation and mapping: • After you read the content of each ﬁle, transform and map the data to the lead records in your customer relationship management (CRM) system. • For guidance on ﬁeld mapping, refer to the section called “Field mapping”. 3. Lead identiﬁcation: • Uniquely identify each lead using either partnerCrmLeadId or apnCrmUniqueIdentifier. • If partnerCrmLeadId is blank and apnCrmUniqueIdentifier is present, the lead is a new referral from AWS Partner Network (APN) Customer Engagement (ACE). • If both identiﬁers are present, the record is treated as an update from ACE. Lead sharing 138 AWS Partner Central 4. Lead ingestion: CRM Guide • Ingest new leads or update existing leads in the CRM system. 5. File management: • After you successfully process each lead and the complete ﬁle data, delete the ﬁles from the outbound folder. • Each ﬁle is automatically archived in the lead-outbound-archive folder. Integration and code reference: • For reading ﬁles uploaded to the Amazon Simple Storage Service (Amazon S3) bucket, you can use AWS Lambda or read directly from your CRM system. • Use the sample codes below for Lambda and Salesforce REST API to validate and update CRM records. • Lambda for validating ﬁles: ace_read_s3.py. • Salesforce REST API: Apex_Sample_REST_API_Code.cls. • If
apc-crm-046	apc-crm.pdf	46	update existing leads in the CRM system. 5. File management: • After you successfully process each lead and the complete ﬁle data, delete the ﬁles from the outbound folder. • Each ﬁle is automatically archived in the lead-outbound-archive folder. Integration and code reference: • For reading ﬁles uploaded to the Amazon Simple Storage Service (Amazon S3) bucket, you can use AWS Lambda or read directly from your CRM system. • Use the sample codes below for Lambda and Salesforce REST API to validate and update CRM records. • Lambda for validating ﬁles: ace_read_s3.py. • Salesforce REST API: Apex_Sample_REST_API_Code.cls. • If you use a CRM system other than Salesforce, you must provide code speciﬁc to your system to update your data. Sharing updates on leads with AWS 1. Identify leads: Locate the leads with updates to be shared with AWS. 2. Data transformation: Convert the data into the AWS format, as outlined in the section called “Field deﬁnitions”. 3. File creation: • Generate lead ﬁles in JSON format. • Append a timestamp to each ﬁle, ensuring all ﬁle names are unique and follow the format: {name}_MMDDYYYY24HHMMSS.json. 4. Authenticate and upload: • Authenticate to the ACE Amazon S3 bucket. • Upload the ﬁle to the lead-inbound folder. All ﬁles shared with AWS are automatically archived in the lead-inbound-archive folder. • When you upload ﬁles to S3, ensure you provide full access to the bucket owner. aws s3 cp example.jpg s3://awsexamplebucket --acl bucket-owner-full-control Sharing updates on leads with AWS 139 AWS Partner Central CRM Guide See a sample result of running this command in "Results Sample ﬁle.json". 5. File processing: • Upon receipt, AWS automatically processes the ﬁles. • The results of the processing is uploaded to the lead-inbound-processed-results folder in the S3 bucket. This includes the status of successes and errors, as well as any error messages for each lead. • These processed results are also archived in the lead-inbound-processed-results- archive folder. • For more information, refer to the the section called “Technical FAQ—leads and opportunities”. 6. Response handling: • You must develop logic to consume these responses, review erroneous records, correct any errors, and resend the data to ACE. • You can ﬁnd sample errors in the FAQ and Troubleshooting sections. • To upload a ﬁle to Amazon S3 from CRM: • Reference the version of the AWS signature. • Use an HTTPS request to upload the ﬁle. • For reference, use the following ﬁles to upload a ﬁle to the S3 bucket: • For authenticating an S3 bucket: S3_Authentication.cls • For uploading ﬁles to an S3 bucket: Sample_AceOutboundBatch.cls • NOTE: Files must not exceed 1 MB in size, and duplicate ﬁles won’t be processed. Opportunity sharing How AWS shares opportunities 1. Incremental exports: Amazon Web Services (AWS) exports new opportunities (and updates) referred by AWS, on an hourly basis. 2. File creation: AWS generates opportunity ﬁles that adhere to a speciﬁc format. For detailed ﬁle speciﬁcations, refer to Opportunity ﬁeld deﬁnitions. 3. File upload: Opportunity ﬁles are uploaded to the opportunity-outbound folder. Opportunity sharing 140 AWS Partner Central CRM Guide Consuming opportunities from AWS To eﬀectively consume opportunities from AWS, you need to build custom integration with these functionalities. 1. File retrieval: • Use a scheduled job to regularly scan the opportunity-outbound folder, at an interval you choose. • Retrieve the opportunity ﬁles for processing. 2. Data transformation and mapping: • After you read the content of each ﬁle, transform and map the data to the opportunity records in your customer relationship management (CRM) system. • For guidance on ﬁeld mapping, refer to the section called “Field mapping”. 3. Opportunity identiﬁcation: • Uniquely identify each opportunity using either partnerCrmOpportunityId or apnCrmUniqueIdentifier. • If partnerCrmOpportunityId is blank and apnCrmUniqueIdentifier is present, the opportunity is a new referral from AWS Partner Network (APN) Customer Engagement (ACE). • If both identiﬁers are present, the record is treated as an update from ACE. 4. Opportunity ingestion: Ingest new opportunities or update existing opportunities in the CRM system. 5. File management: • After you successfully process each opportunity and the complete ﬁle data, delete the ﬁles from the outbound folder. • Each ﬁle is automatically archived in the opportunity-outbound-archive folder. Integration and code reference: • For reading ﬁles uploaded to the Amazon Simple Storage Service (Amazon S3) bucket, you can use AWS Lambda or read directly from your CRM system. • Use the sample codes below for Lambda and Salesforce REST API to validate and update CRM records. • Lambda for validating ﬁles: ace_read_s3.py. • Salesforce REST API: Apex_Sample_REST_API_Code.cls. • If you use a CRM system other than Salesforce, you must provide code speciﬁc to your system to update your data. Consuming opportunities from AWS 141 AWS Partner Central CRM Guide Sharing updates to opportunities with AWS 1. Identify opportunities: Locate the opportunities with updates
apc-crm-047	apc-crm.pdf	47	For reading ﬁles uploaded to the Amazon Simple Storage Service (Amazon S3) bucket, you can use AWS Lambda or read directly from your CRM system. • Use the sample codes below for Lambda and Salesforce REST API to validate and update CRM records. • Lambda for validating ﬁles: ace_read_s3.py. • Salesforce REST API: Apex_Sample_REST_API_Code.cls. • If you use a CRM system other than Salesforce, you must provide code speciﬁc to your system to update your data. Consuming opportunities from AWS 141 AWS Partner Central CRM Guide Sharing updates to opportunities with AWS 1. Identify opportunities: Locate the opportunities with updates to be shared with AWS. 2. Data transformation: Convert the data into the AWS format, as outlined in the section called “Field deﬁnitions”. 3. File creation: • Generate opportunity ﬁles in JSON format. • Append a timestamp to each ﬁle, ensuring all ﬁle names are unique and follow the format: {name}_MMDDYYYY24HHMMSS.json. 4. Authenticate and upload: • Authenticate to the ACE Amazon S3 bucket. • Upload the ﬁle to the opportunity-inbound folder. All ﬁles shared with AWS are automatically archived in the opportunity-inbound-archive folder. • When you upload ﬁles to S3, ensure you provide full access to the bucket owner: aws s3 cp example.jpg s3://awsexamplebucket --acl bucket-owner-full-control See a sample result of running this command in Opportunity Results Success Sample.json. 5. File processing: • Upon receipt, AWS automatically processes the ﬁles. • The results of the processing is uploaded to the lead-inbound-processed-results folder in the S3 bucket. This includes the status of successes and errors, as well as any error messages for each opportunity. • These processed results are also archived in the opportunity-inbound-processed- results-archive folder. • For more information, refer to the the section called “Technical FAQ—leads and opportunities”. 6. Response handling: • You must develop logic to consume these responses, review erroneous records, correct any errors, and resend the data to ACE. • You can ﬁnd sample errors in the FAQ and Troubleshooting sections. • To upload a ﬁle to Amazon S3 from CRM: • Reference the version of the AWS signature. • Use an HTTPS request to upload the ﬁle. • For reference, use the following ﬁles to upload a ﬁle to the S3 bucket: Sharing updates to opportunities with AWS 142 AWS Partner Central CRM Guide • For authenticating an S3 bucket: S3_Authentication.cls • For uploading ﬁles to an S3 bucket: Sample_AceOutboundBatch.cls • NOTE: Files must not exceed 1 MB in size, and duplicate ﬁles won’t be processed. Field mapping Field mapping is an essential step in the integration process where partners align their customer relationship management (CRM) system’s ﬁelds with those deﬁned by Amazon Web Services (AWS). This ensures that both parties accurately exchange and understand data. Below are guidelines to assist in this process. Mandatory ﬁeld mapping • Map each mandatory ﬁeld to its corresponding ﬁeld in your CRM system. It’s essential for successful data exchange when you ensure all required ﬁelds are mapped. For more information, refer to the section called “Field deﬁnitions” • Opportunity • Lead Handling optional ﬁelds • Understand the role of optional ﬁelds in the integration process. Decide if you want to map these ﬁelds based on your business requirements, and be aware of any possible implications from leaving them unmapped. Value mapping • Align each ﬁeld value in your CRM with the required AWS Partner Network (APN) Customer Engagement (ACE) list value, as speciﬁed in the section called “Field deﬁnitions”. This is important to maintain data consistency and integrity. Field mapping 143 AWS Partner Central CRM Guide Data type and format validation • Verify that the data types and formats of the ﬁelds in your CRM system align with those speciﬁed in the AWS Field deﬁnitions. It’s essential to maintain consistency in data types and formats to prevent data corruption and ensure seamless integration. Field length and limitations • Notice ﬁeld length restrictions and other limitations. Ensure that the data from your CRM system ﬁts into the corresponding ﬁelds in AWS without being truncated or causing errors. Data type and format validation • Verify that the ﬁeld data types and formats in your CRM system align with those speciﬁed in the section called “Field deﬁnitions”. It’s crucial to prevent data corruption and ensure seamless integration with consistency in data types and formats. Periodic review and update • Regularly review and update your ﬁeld mappings to accommodate changes in your CRM system or AWS requirements. This proactive approach ensures ongoing data exchange accuracy and eﬃciency. Field mapping documentation • Maintain comprehensive ﬁeld mapping documentation. This practice aids in troubleshooting, future updates, and ensuring clarity in how data is transferred between systems. Testing and validation • Conduct thorough ﬁeld mappings testing to validate that data is being transferred and transformed accurately. Address any discrepancies or issues immediately to ensure data integrity.
apc-crm-048	apc-crm.pdf	48	data corruption and ensure seamless integration with consistency in data types and formats. Periodic review and update • Regularly review and update your ﬁeld mappings to accommodate changes in your CRM system or AWS requirements. This proactive approach ensures ongoing data exchange accuracy and eﬃciency. Field mapping documentation • Maintain comprehensive ﬁeld mapping documentation. This practice aids in troubleshooting, future updates, and ensuring clarity in how data is transferred between systems. Testing and validation • Conduct thorough ﬁeld mappings testing to validate that data is being transferred and transformed accurately. Address any discrepancies or issues immediately to ensure data integrity. Data type and format validation 144 AWS Partner Central CRM Guide Handling unwanted overwrites • To prevent AWS data from overwriting speciﬁc CRM ﬁelds, consider the following: • Creating a custom CRM ﬁeld for the data you want to protect. • Having this custom ﬁeld reviewed by a sales representative. • Once the custom ﬁeld is approved, adding it to the opportunity record and pipeline. • This is particularly important for ﬁelds like MRR or Stage, especially if they signify that a product has launched. Managing downstream dependencies • If there are downstream dependencies in your system that rely on data exchange, consider the following: • Creating new ﬁelds in your CRM to accommodate the AWS data. • Realigning your business processes as necessary to ensure seamless integration and data ﬂow. Best practices Use these best practices to optimize your custom integration development and maintenance. General best practices 1. Map all mandatory ﬁelds because they are the required ﬁelds in the AWS Partner Network (APN) Customer Engagement (ACE) submission form. 2. Connect with your current ACE Pipeline Manager user to understand what the process looks like. Capture any unique processes/ﬁeld uses, so you can build it into your experience. 3. Consider creating separate sales pipeline stages for Amazon Web Services (AWS)-reported sales stages (example: Stage, Target Close Date, Expected Monthly AWS revenue, Next Steps). If we have diﬀerent stage deﬁnitions, we might override your sales stages. When you create separate sales stages, it allows you to manage your pipeline appropriately, but still have visibility into what AWS is projecting. 4. For partner referred opportunities, the ACE team must approve/reject them before we accept any updates. 5. For AWS referred opportunities, the partner must accept or reject the opportunities. Handling unwanted overwrites 145 AWS Partner Central CRM Guide Data exchange protocols 1. Input conventions: Separate multi-select picklist entries with semicolons and omit spaces. 2. Attention to detail: Field names and values are case-sensitive, so maintain accuracy. 3. Deletion procedures: Execute ﬁeld removal by transmitting the value null for the chosen ﬁeld. 4. Synchronization: The synchronization processes operate on an hourly basis, causing potential delays in data reﬂections. Updates to AWS can take up to one hour to reﬂect in the AWS customer relationship management (CRM). Avoid sending multiple documents per hour. Field-speciﬁc best practices 1. Inbound modiﬁcations: To protect the integrity of your data, disable modiﬁcations for ﬁelds such as stage, closedDate, and closedLostReason. To track AWS values without aﬀecting your local Salesforce values, use these read-only ﬁelds: awsStage, awsCloseDate, and awsClosedLostReason. 2. Customer mapping and validation: Ensure customer website accuracy because it’s pivotal for AWS CRM mapping. Pair it with the customer name for superior CRM account mapping. 3. Project description clarity: Furnish a clear description detailing customer challenges and solution alignments. AWS uses this to validate the opportunity. 4. Provisioning: (Optional) When you provision end-customer contact speciﬁcs, it enables AWS to retrace leads and campaigns. This leads to enhanced funding verdicts. Additional best practices 1. Adhere to the latest payload ﬁeld deﬁnition guidelines. 2. Maintain sandbox bucket naming consistency with the speciﬁed format. 3. Use the recommended naming pattern for the production bucket. 4. Prioritize sandbox environment testing before live deployment. 5. Maintain distinct identiﬁers for records between AWS and partner CRMs. 6. Post-processing, delete ﬁles in the outbound Amazon Simple Storage Service (Amazon S3) folder. Originals remain in the archives. 7. To prevent errors, set up ﬁeld level validations at the source. Data exchange protocols 146 AWS Partner Central Quotas CRM Guide Inbound ﬁle to Amazon Web Services (AWS) Operation Maximum opportunities Maximum ﬁle size Limit 500 per ﬁle 1 MB Frequency of synchronization Near real-time Maximum number of submitted ﬁles 10,000 per 24-hour period Outbound ﬁle to partner Operation Maximum ﬁle size Frequency of synchronization Version history Limit 5 MB Hourly Current ﬁelds version: 14 (November 15, 2023) The following table describes important changes to the custom integration ﬁelds for leads and opportunities after 2020. To be notiﬁed of future updates, subscribe to the RSS feed. Change Version Date Update S3 quotas Changes to integration opportunity ﬁelds: 14 14 1/17/2024 11/15/2023 Quotas 147 AWS Partner Central CRM Guide Change Version Date 1. Update validation for the following
apc-crm-049	apc-crm.pdf	49	ﬁle 1 MB Frequency of synchronization Near real-time Maximum number of submitted ﬁles 10,000 per 24-hour period Outbound ﬁle to partner Operation Maximum ﬁle size Frequency of synchronization Version history Limit 5 MB Hourly Current ﬁelds version: 14 (November 15, 2023) The following table describes important changes to the custom integration ﬁelds for leads and opportunities after 2020. To be notiﬁed of future updates, subscribe to the RSS feed. Change Version Date Update S3 quotas Changes to integration opportunity ﬁelds: 14 14 1/17/2024 11/15/2023 Quotas 147 AWS Partner Central CRM Guide Change Version Date 1. Update validation for the following ﬁelds: country, postalCod e , partnerPr imaryNeedFromAws , projectDescription , campaignName , useCase, version, spmsId 2. Add a text area for the following ﬁelds: awsProducts , otherSolutionOffer ed , parentOppId , solutionOffered , primaryContactTitl e , recommend edNextBestActions , offers, backwards CompatibilityChang es 3. Add new number ﬁeld: customerDuns 4. Add new select and multiselect picklist ﬁelds: opportunityType , salesActivities , engagementScore , rejectionReason , cosellConvertReaso n 5. Deprecate ﬁelds: awsFieldEngagement , contractVehicle , Version history 148 AWS Partner Central CRM Guide Change Version Date partnerPrimaryNeed FromAwsOther , isThisAPublicRefer ence , isThisFor Marketplace leadSource , , isNetNewBusinessFo rCompany , publicRef erenceTitle publicReferenceUrl , , rfxSolicitationNum ber , subUseCase Changes to integration opportunity ﬁelds: 13 03/29/2023 1. Update validation for the following ﬁelds: IsOppFromMarketing Activity , marketing ActivityChannel , marketingActivityU secase , awsSFCamp aignName , isMarketi ngDevelopmentFunde d 2. Add new ﬁelds: apnReviewerComment s , acceptBy, apnCrmLea dUniqueIdentifier 3. Update FAQ Version history 149 Version 12 Date 09/01/2022 CRM Guide AWS Partner Central Change Changes to integration opportunity ﬁelds: 1. Update descriptions for the following ﬁelds: aWSStage, aWSCloseD ate , aWSClosed LostReason 2. Update validation: isMarketingDevelop mentFunded 3. Add new ﬁelds: procurementType , customerSoftwareVa lue , contractS tartDate , contractE ndDate , customerS oftwareValueCurren cy , IsOppFrom MarketingActivity , marketingActivityC hannel , marketing , ActivityUsecase awsSFCampaignName Changes to standard values on opportunity: 1. Update standard values to align with Amazon Partner Network (APN) production: i. Remove the following picklist values from campaignName : APN Version history 150 AWS Partner Central CRM Guide Change Version Date Marketing Central, AWS Field Event, Integrate d Partner Campaign, Partner Led Event, Partner Prospecting, WWPS Marketing, Windows RMP, VMware Cloud ii. Add the following picklist values to campaignName : ATO (Authority to Operate), ISV Immersion Day SFID Program, VMware Cloud on AWS, Windows 2. Add new picklist ﬁelds: IsOppFromMarketing Activity , marketing ActivityChannel , marketingActivityU secase , Procureme ntType , customerS oftwareValueCurren cy Version history 151 Version 11 Date 03/21/2022 CRM Guide AWS Partner Central Change Changes to integration opportunity ﬁelds: 1. Add new ﬁeld: aWSClosed LostReason —type is text and length is 255 2. Provide context about "inbound" versus "outbound" and "not required" versus "optional" information Changes to standard values on opportunity ﬁelds: 1. Update standard values for the following ﬁelds to align with APN production: i. Rename industry/ vertical Oil & Gas to Energy—Oil & Gas; rename Power & Utilities to Energy—Power & Utilities ii. Add country values: Democratic Republic of the Congo; Iran, Islamic Republic of; update Bonaire, Sint Eustatius and Saba to Bonaire, Sint Eustatius, and Saba; update Saint Martin (French Part ) to Saint Martin (French Part) Version history 152 Version 10 Date 01/26/2022 CRM Guide AWS Partner Central Change Changes to integration opportunity ﬁelds: 1. Update validation for the following ﬁelds: contractVehicle , isThisForMarketpla ce , isNetNewB usinessForCompany , deliveryModel , awsFieldEngagement , additionalComments 2. Add new ﬁeld: rfxSolici tationNumber —type is text and length is 255 3. Delete ﬁeld: partnerDe veloperManagerPhon e Changes to standard values on opportunity: 1. Update standard values for the following ﬁelds to align with APN productio n: UseCase Training; Closedlostreason Financial/Commercial 2. Remove ﬁelds: isThisFor Resell , isManaged ServicesIncluded Version history 153 AWS Partner Central CRM Guide Change Version Changes to standard values on lead ﬁelds: 9 1. Remove Other value for Industry Vertical Date 9/16/2021 Changes to integration lead ﬁelds: 1. Update city ﬁeld length from 255 to 40 2. Update ﬁeld name from Current Lead Stage to currentLeadStage 3. Update ﬁeld name from Lead Source to leadSource 4. Update ﬁeld name from Lead Age to leadAge 5. Update ﬁeld name from Level of AWS Usage to levelofAWSUsage Changes to integration opportunity ﬁelds: 1. Update customerC ﬁeld ompanyName length from 255 to 120 2. Update customerPhone ﬁeld length from blank to 40 Version history 154 AWS Partner Central CRM Guide Change Version Date 3. Update expectedM onthlyAwsRevenue from Currency (16,2) to Currency (18,0) Update Closed Lost reason codes 8 6/24/2021 FAQs Use these common questions and answers to assist in the custom integration. Topics • General FAQ • Technical FAQ—ﬁelds • Technical FAQ—Amazon S3 • Technical FAQ—leads and opportunities • Technical FAQ—versioning and backward compatibility General FAQ How does the integration work? Q:
apc-crm-050	apc-crm.pdf	50	of AWS Usage to levelofAWSUsage Changes to integration opportunity ﬁelds: 1. Update customerC ﬁeld ompanyName length from 255 to 120 2. Update customerPhone ﬁeld length from blank to 40 Version history 154 AWS Partner Central CRM Guide Change Version Date 3. Update expectedM onthlyAwsRevenue from Currency (16,2) to Currency (18,0) Update Closed Lost reason codes 8 6/24/2021 FAQs Use these common questions and answers to assist in the custom integration. Topics • General FAQ • Technical FAQ—ﬁelds • Technical FAQ—Amazon S3 • Technical FAQ—leads and opportunities • Technical FAQ—versioning and backward compatibility General FAQ How does the integration work? Q: Can I access the Amazon Simple Storage Service (Amazon S3) bucket used for sending and receiving the ﬁles? Yes. Partners can programmatically access the Amazon S3 bucket using the secret/access key of the AWS Identity and Access Management (IAM) that has access to the bucket. Partners won’t have console access to the S3 buckets because these buckets are in Amazon Web Services (AWS)’s own account. Q: What skill set does the partner's developer need? The partner’s developer needs to be familiar with their customer relationship management (CRM) system and Amazon S3. FAQs 155 AWS Partner Central CRM Guide Q: Do the sample code ﬁles include complete code or does the partner have to write the code? The partner needs to write the code based on the provided sample code ﬁles. Q: If the partner develops their solution in Python, Golang, or any other language, does AWS Partner Network (APN) Customer Engagement (ACE) provide any software development kit (SDK) in those languages for this integration? No. Q: What is the sync process from the Amazon S3 bucket to internal ACE? Every hour, a batch process runs to pick up the ﬁles and synchronize information. Any update the AWS sales team makes on the record can take up to one hour to be sent to the partner’s bucket. Partners may receive an email notiﬁcation about updates immediately, but the updates from AWS may still be delayed by one hour. Q: What is the frequency of lead and opportunity ﬁle uploads by ACE? ACE sends the leads and opportunities data every one hour. Q: Is there a sandbox environment for ACE? Yes. We do have a sandbox environment for ACE, but we can’t provide access to partners due to security reasons. Raise a support case on Partner Central if you want to have new opportunities or leads pushed into your bucket. Q: How do we maintain identiﬁers across the partner’s CRM and APN? To provide more ﬂexibility for our partners, we use two sets of identiﬁers in our system. 1. apnCrmUniqueIdentifier: AWS manages this identiﬁer. It starts with OXXXXXX for opportunities and LXXXXXX for leads. 2. PartnerCrmUniqueIdentifier/partnerCrmLeadId: The partner manages this identiﬁer on opportunities and leads, respectively, within their CRM. Partners should add this identiﬁer while ingesting new opportunities to trace updates back to their CRM. When an opportunity is sent without apnCrmUniqueIdentifier or partnerCrmUniqueIdentifier, AWS treats it as a new opportunity and assigns a new apnCrmUniqueIdentifier for the opportunity. General FAQ 156 AWS Partner Central CRM Guide When an opportunity is sent with a apnCrmUniqueIdentifier or partnerCrmUniqueIdentifier, AWS treats it as an update action and updates the existing opportunity with the payload data. Q: How do I prevent duplicate records from getting created in both systems? From the partner CRM side, there must be a unique identiﬁer for each record that’s sent to ACE, which is called partnerCrmUniqueIdentifier. Similarly, ACE also maintains a unique identiﬁer for each record, which is called apnCrmUniqueIdentifier. When the data is sent, both ACE and the partner have to include these two ﬁelds, which helps to identify if the record is a new opportunity (if blank) or an existing opportunity (if populated). Technical FAQ—ﬁelds Q: Does the integration support CSV format? No. The integration accepts only JSON ﬁle formats. Q: When do the ﬁles have to be deleted from outbound folders? Delete the ﬁles only after you successfully process them. Q: If I accidentally delete the ﬁles from outbound folders, where can I ﬁnd the original ﬁles? The ﬁles are available in the opportunity-outbound-archive and lead-outbound-archive folders. Q: What do I do for support during development? For assistance during development, reach out to AWS Partner Network (APN) support on Partner Central. Q: What is the diﬀerence between opportunityOwnerName and opportunityOwnerEmail? • opportunityOwnerName: The opportunity owner’s name in the partner organization. This needs to be a Partner Central user. • opportunityOwnerEmail: The opportunity owner’s email in the partner organization. This needs to be a Partner Central user. If not provided, the opportunity is created with the Partner Central Alliance Lead as the owner. Q: What's the time zone for all the date ﬁelds (targetCloseDate, lastModified Date, createdDate, and acceptBy)? Technical FAQ—ﬁelds 157 AWS Partner Central CRM Guide The
apc-crm-051	apc-crm.pdf	51	assistance during development, reach out to AWS Partner Network (APN) support on Partner Central. Q: What is the diﬀerence between opportunityOwnerName and opportunityOwnerEmail? • opportunityOwnerName: The opportunity owner’s name in the partner organization. This needs to be a Partner Central user. • opportunityOwnerEmail: The opportunity owner’s email in the partner organization. This needs to be a Partner Central user. If not provided, the opportunity is created with the Partner Central Alliance Lead as the owner. Q: What's the time zone for all the date ﬁelds (targetCloseDate, lastModified Date, createdDate, and acceptBy)? Technical FAQ—ﬁelds 157 AWS Partner Central CRM Guide The time zone for the date ﬁelds is Greenwich Mean Time (GMT). Q: Are the inbound JSON ﬁles versioned? No. Amazon Web Services (AWS) doesn’t support versioning of the ﬁles. APN Customer Engagement (ACE) processes the ﬁle immediately after receiving and then deletes the ﬁle after successful processing. If we receive the same ﬁle name again, it’s rejected. Q: What ﬁelds in the Amazon Simple Storage Service (Amazon S3) JSON ﬁle indicate the creation and latest update date of a particular lead and opportunity? createdDate and lastModifiedDate. Q: How do you determine if an opportunity is new or existing? The ﬁeld PartnerCrmUniqueIdentifier is a unique identiﬁer on each opportunity that we require from the partner. This identiﬁer must be deﬁned in the source CRM of the partner’s system. We use this to determine if an opportunity already exists in AWS. If the PartnerCrmUniqueIdentifier is available in AWS, we use the information shared to update the opportunity. If PartnerCrmUniqueIdentifier is not available in AWS, we use the information shared to create a new opportunity. Similarly, when we send data to the partner, we include both PartnerCrmUniqueIdentifier and apnCrmUniqueIdentifier. If the opportunity shared by AWS is being sent for the ﬁrst time, you won’t see any value for PartnerCrmUniqueIdentifier. This helps you to treat the opportunity as new from ACE. Once you ingest it into your CRM, you send the updates back to us with both PartnerCrmUniqueIdentifier and apnCrmUniqueIdentifier. Q: Is it possible to have more than one outbound and result JSON ﬁle in Amazon S3? Yes. Sometimes we may generate more ﬁles in the outbound folder. Similarly, if you send ﬁles to the inbound folder, we process them and keep the results ﬁles in the result folder. You must tag/ delete the result ﬁles after processing. Q: Does the outbound ﬁle contain more than one record? Yes. The outbound ﬁle can contain multiple records. Q: If 20 inbound opportunities are sent in a single input JSON ﬁle under the opportunities section, and one of the opportunities doesn’t comply with APN standard, what happens? Technical FAQ—ﬁelds 158 AWS Partner Central CRM Guide If the format is incorrect, regardless of the case, the entire ﬁle is rejected. If the format is correct but only one opportunity can’t be processed on our end, the results ﬁle includes all 20 opportunities and their status, along with the error message for the failed opportunity. Q: What are the key attributes to validate if the JSON ﬁle was processed successfully? These are the key attributes to help you understand if the JSON ﬁle processed successfully. { "inboundApiResults": [ { "warnings": null, // no warnings "partnerCrmUniqueIdentifier": "XXXX", //uniqueId from Partner side "isSuccess": true, // file successfully processed "errors": null, //no errors reported "apnCrmUniqueIdentifier": "OXXXX" //uniqueId from AWS side } ] } Q: What happens if I send an invalid JSON? You receive this error response: "[{input JSON}] is not of type object". Q: How many lead/opportunity records can be included in a single inbound JSON ﬁle? A maximum of 50 records can be in one ﬁle. Technical FAQ—Amazon S3 Q: Where can I get the Amazon Simple Storage Service (Amazon S3) REST API documentation? For more information, refer to the Amazon S3 REST API Introduction. Q: How do I get the Amazon Web Services AWS Key Management Service (AWS KMS) key details to authenticate to access the Amazon S3 bucket? AWS Partner Network (APN) shares a policy that includes the key name. Q: How do I authenticate Amazon S3 from Salesforce.com (SFDC)? Use the sample code ﬁle S3_Authentication.cls to authenticate the S3 from SFDC. Technical FAQ—Amazon S3 159 AWS Partner Central CRM Guide Q: How do I upload the ﬁle from the AWS software development kit (SDK) to S3? Use the following AWS CLI command to upload the ﬁle to S3. aws s3 cp example.json s3://awsexamplebucket/opportunity- inbound/filename.json --acl bucket-owner-full-control The sample code ﬁle Sample_AceOutboundBatch.cls contains code to upload the data ﬁle from SFDC. Q: Who owns the Amazon S3 bucket? AWS owns and manages the Amazon S3 bucket. You have programmatic access to your own S3 bucket with the AWS Identity and Access Management (IAM) user. Q: Are there separate folders or buckets for receiving and sending ﬁles? There
apc-crm-052	apc-crm.pdf	52	Partner Central CRM Guide Q: How do I upload the ﬁle from the AWS software development kit (SDK) to S3? Use the following AWS CLI command to upload the ﬁle to S3. aws s3 cp example.json s3://awsexamplebucket/opportunity- inbound/filename.json --acl bucket-owner-full-control The sample code ﬁle Sample_AceOutboundBatch.cls contains code to upload the data ﬁle from SFDC. Q: Who owns the Amazon S3 bucket? AWS owns and manages the Amazon S3 bucket. You have programmatic access to your own S3 bucket with the AWS Identity and Access Management (IAM) user. Q: Are there separate folders or buckets for receiving and sending ﬁles? There is one bucket with diﬀerent folders for receiving and sending the ﬁles. Refer to the user guide for further details on the folders. Q: Do I need to access the S3 bucket using AWS Lambda, or can I access it directly using the customer relationship management (CRM) system? You can access it both ways. Q: Is the Amazon S3 bucket secured or encrypted? Yes. We enable the default encryption mechanism that Amazon S3 oﬀers. Q: Is it possible to enable Amazon Simple Notiﬁcation Service (Amazon SNS) listening to the S3 bucket, so I can only act on the event, instead of polling periodically? No. Currently, APN Customer Engagement (ACE) doesn’t support this feature. Q: What folders do I have access to and what is the purpose of each folder? You can ﬁnd the list of S3 folders in the section called “Setting up”. Technical FAQ—leads and opportunities Send and receive leads and opportunities Q: Is there a ﬁle naming convention? Technical FAQ—leads and opportunities 160 AWS Partner Central CRM Guide Each ﬁle name needs to be unique. We recommend the ﬁle name PartnerProvided FileName +{timestamp}.json. Q: What's the structure of the results? Sample ﬁles for the results (success and error) can be downloaded from the following locations: • Lead Results Success Sample.json • Opportunity Results Success Sample.json • Lead Results With Errors Sample.json • Opportunity Results With Errors Sample.json Q: What's the naming convention of the results? PartnerProvidedFileName_result.json Q: What if I submit a second JSON ﬁle with the same name? We won’t process the ﬁle, and the ﬁle is moved to the archive folder. Q: What is the inbound ﬁle size limit? The inbound ﬁle size limit is 1MB. Q: Is there a maximum number of opportunities and leads that can be batched into one JSON ﬁle? Given the 1MB limit, we recommend you have one opportunity or lead per ﬁle. Q: I’m getting an access denied error message, so I’m not able to upload the ﬁles. What should I do? Partners receive an Access denied message for two reasons. 1. You uploaded the ﬁle into the outbound folder instead of the inbound folder. Upload the ﬁle into the inbound folder. 2. You need to provide a access control list (ACL). Use the following Amazon Web Services (AWS) CLI command for uploading the data ﬁle: Technical FAQ—leads and opportunities 161 AWS Partner Central CRM Guide aws s3 cp example.json s3://awsexamplebucket --acl bucket-owner-full-control Q: What happens if ﬁles with extensions such as .pdf, .docx, or anything other than .json are uploaded? We reject the ﬁles and generate a *.error.json ﬁle with the reason details. Q: What do I do after I receive a data issue error message in production? 1. If the data needs to be corrected in the partner’s customer relationship management (CRM) system, after you correct the data, send the revised ﬁle to Amazon Simple Storage Service (Amazon S3). 2. If any clariﬁcations are required for the data, reach out to your Partner Development Manager (PDM). 3. For any other technical support, raise an AWS Partner Network (APN) support case in the APN Portal. Q: Where can I ﬁnd the results ﬁles and how long are they available? The results ﬁles are in the lead-inbound-results and opportunity-inbound-results folders. They're available until you delete them. You can delete the ﬁles after successful pull. Q: If I need to ﬁnd a results ﬁle after I delete it, where can we ﬁnd it? You can ﬁnd the results ﬁles in the lead-inbound-results-archive/YYYY/MM/DD and opportunity-inbound-results-archive/YYYY/MM/DD folders. Q: If there is any failure in APN processing the ﬁle, how am I notiﬁed? APN has alarms that automatically create Sev2 tickets to track the processing errors. We review, resolve, and communicate these to partners. Q: What ﬁelds can be updated after the opportunity is launched? The following ﬁelds can be updated only by Independent Software Vendor (ISV) Accelerate Partners: • isThisForMarketplace • isNetNewBusinessForCompany • deliveryModel Technical FAQ—leads and opportunities 162 AWS Partner Central • awsFieldEngagement • additionalComments CRM Guide Q: I received a Record not editable error. What does it mean? When a you send a new partner referred opportunity, it goes through the validation process and the APN Customer Engagement (ACE) team must
apc-crm-053	apc-crm.pdf	53	has alarms that automatically create Sev2 tickets to track the processing errors. We review, resolve, and communicate these to partners. Q: What ﬁelds can be updated after the opportunity is launched? The following ﬁelds can be updated only by Independent Software Vendor (ISV) Accelerate Partners: • isThisForMarketplace • isNetNewBusinessForCompany • deliveryModel Technical FAQ—leads and opportunities 162 AWS Partner Central • awsFieldEngagement • additionalComments CRM Guide Q: I received a Record not editable error. What does it mean? When a you send a new partner referred opportunity, it goes through the validation process and the APN Customer Engagement (ACE) team must approve or reject it. While the opportunity is in review and has not yet been validated, you can’t update the record, and you receive this error. Q: What happens if there is no activity on the my side (example: I'm not processing the ﬁle or not sending any inbound opportunity)? If you don't send any information or aren't processing the ﬁles we provide, we currently don’t have a mechanism in place to alert you. We encourage you to monitor your system to ensure the information is ﬂowing to APN. Q: How soon are the JSON results available in the results folder following the submission of a new/updated inbound opportunity/lead? The processing is almost real time. You should receive the ﬁles in less than ﬁve minutes. Q: If I send an inbound opportunity CRM that doesn’t comply with the format/length restriction of the APN standard, how does the system handle it? Does it generate the error report? If the ﬁle isn't in the ﬁeld deﬁnition format, the result ﬁle from APN calls out the ﬁle. Q: I don’t have an AWS account ID at the time of launching. What do I do? Per the ACE process, Launched means workload completed and billing started. This requires an AWS account ID. For more information, refer to the ACE Program FAQs. Q: Following User Acceptance Testing (UAT), how should the historical data be handled during the move to production? By default, when any updates happen in ACE, we send those opportunities to the Amazon S3 bucket. For historical data that you don’t want to process, you need to provide the partnerCrmUniqueIdentifier with dummy values such as X0001, X0002….X000N in the extract for what you don’t want to process in your system. You need to write code to recognize these identiﬁers and process them accordingly. The rest of the opportunities provide the correct Technical FAQ—leads and opportunities 163 AWS Partner Central CRM Guide partnerCrmUniqueIdentifier value. This ensures that you have full control on what to process and what not to process in your system. Q: Does the outbound ﬁle contain more than one record? Yes. The outbound ﬁle can contain more than one record. Q: Why does the data send Accept to view for some ﬁelds? For an AWS referred opportunity or lead, all PII ﬁelds are masked with the label Accept to view until the opportunity or lead is accepted by you. Once accepted, you receive all data ﬁelds in the next sync cycle. Q: What do I do when a new AWS referred opportunity or lead is synced for the ﬁrst time? When a new opportunity or lead is synced for the ﬁrst time, you need to accept or reject it to get additional data (example: customer contacts). Creating and updating opportunities/leads Q: How do I ingest new Partner Referred (Originated) opportunities into ACE through the integration? To create new opportunities in ACE through the integration, you need to ingest the required opportunity information in the deﬁned JSON format into the opportunity-inbound folder. AWS processes this information, creates a new opportunity in ACE, and shares results of a successful/ failed create operation in the opportunity-inbound-processed-results folder. Q: How does the integration diﬀerentiate between new opportunity submissions and updates? The ﬁeld PartnerCrmUniqueIdentifier on each opportunity is a required unique identiﬁer required. This identiﬁer must be deﬁned in the your system source CRM. AWS uses this to determine if an opportunity already exists in ACE. If it's available in ACE, we use the information shared to update the opportunity, but if it's not available in ACE, we use the information shared to create a new opportunity. Q: If I’ve already implemented the update functionality through the integration, what do I need to do to use the integration to submit (create) new opportunities? You need to make the following changes to the existing integration: Technical FAQ—leads and opportunities 164 AWS Partner Central CRM Guide 1. Start ingesting new opportunities for creation in the opportunity-inbound folder. Provide updates in the same folder. 2. Ensure that the mandatory ﬁelds required to create are available in the Opportunity JSON shared. 3. Verify each new opportunity has a unique PartnerCrmUniqueIdentifier that doesn’t exist in ACE/Partner Central. An important go-live best
apc-crm-054	apc-crm.pdf	54	opportunity. Q: If I’ve already implemented the update functionality through the integration, what do I need to do to use the integration to submit (create) new opportunities? You need to make the following changes to the existing integration: Technical FAQ—leads and opportunities 164 AWS Partner Central CRM Guide 1. Start ingesting new opportunities for creation in the opportunity-inbound folder. Provide updates in the same folder. 2. Ensure that the mandatory ﬁelds required to create are available in the Opportunity JSON shared. 3. Verify each new opportunity has a unique PartnerCrmUniqueIdentifier that doesn’t exist in ACE/Partner Central. An important go-live best practice is to map and update the existing data in ACE to each PartnerCrmUniqueIdentifier in your CRM so we don’t create duplicates when we receive updates. For assistance, contact ACE. Q: As part of the go-live process, how do I update existing opportunities in ACE with my PartnerCrmUniqueIdentifier? The ACE team supplies you with a list of all open opportunities to aid in preparation for the production launch. You must map these existing opportunities in ACE to their respective PartnerCrmUniqueIdentifier, and return the updated ﬁle to ACE for integration into AWS’s CRM. If you choose to sync only a subset of the opportunities AWS provides, you must develop logic to bypass AWS updates for any opportunities you don’t want to process. This approach should also be applied to future opportunities, post-onboarding. You must supply the associated partnerCrmUniqueIdentifier for opportunities that need alignment across both CRMs. Additionally, you should indicate which opportunities you won’t be updating (example: Marking closed-lost or closed-won opportunities) to exclude them from updates. It’s important that all open/active opportunities that AWS shares, and you accept, are assigned a partnerCrmUniqueIdentifier. Q: Can I update only speciﬁc ﬁelds in the opportunity or lead? Yes. You can provide only the ﬁelds that require updates, along with the necessary identiﬁers. Q: Is it possible to change the ApnCrmUniqueIdentiﬁer? No. This identiﬁer remains constant for AWS and uniquely identiﬁes each opportunity. Q: What if I provide an incorrect partnerCrmUniqueIdentiﬁer? If you provide an incorrect identiﬁer, a new opportunity is created. Ensure accuracy to avoid data duplication. Q: Can I update opportunities that AWS submitted? Technical FAQ—leads and opportunities 165 AWS Partner Central CRM Guide Yes. You can update opportunities AWS submitted using the correct partnerCrmUniqueIdentifier. Q: How soon can I expect results for submitted opportunities? The processing is almost real time, and results are usually available within a few minutes in the opportunity-inbound-processed-results folder. Q: What should I do if there are processing errors for opportunities submitted? Review error details in the results ﬁles, address issues, and seek further assistance from the ACE support team. Q: Can I delete an opportunity through the integration? No. Direct deletion is not supported. You can update an opportunity to reﬂect a Closed status. Q: What does the Record not editable error mean? This error occurs if you try to update an opportunity in ACE review. These opportunities can’t be edited until validated. Q: What if don't send updates or new opportunities? No new data is received and processed if you don't send updates or new opportunities through the integration. Q: How long are the results ﬁles available? Results ﬁles are available for a reasonable duration. You should retrieve and manage them promptly. Technical FAQ—versioning and backward compatibility Q: What is a payload in Amazon Web Services (AWS) data exchange? A payload is a structured piece of data formatted in JSON, sent either inbound to AWS or outbound from AWS. Each key in this JSON structure is referred to as a ﬁeld, and each ﬁeld has an associated value. Q: How is the payload version determined? Technical FAQ—versioning and backward compatibility 166 AWS Partner Central CRM Guide Payload version is speciﬁed within the version ﬁeld of the payload itself. Payloads adhering to ﬁeld deﬁnition v13 are considered Payload Version 1.0, while those following the format deﬁned in ﬁeld deﬁnition v14 or higher are referred to as Payload Version 2.0. Q: What does backward compatibility mean in this context, and how is it handled? Backward compatibility ensures that existing opportunities don’t fail when new and mandatory ﬁelds are introduced in newer payload versions. AWS maintains this by auto-assigning default values to ﬁelds required in the new version. You might notice values in the AWS Partner Network (APN) Customer Engagement (ACE) UI that you did not explicitly provide through the Customer Relationship Management (CRM) Integration. Details and conditions for each ﬁeld are explained in the ﬁeld description or additional details about the ﬁeld. Q: Is backward compatibility a permanent feature? No. Backward compatibility is time-bound, designed to provide ﬂexibility for you to plan and implement upcoming changes. It stops working beyond a speciﬁed cut-oﬀ date, which will be announced later in the year as part of a wider
apc-crm-055	apc-crm.pdf	55	auto-assigning default values to ﬁelds required in the new version. You might notice values in the AWS Partner Network (APN) Customer Engagement (ACE) UI that you did not explicitly provide through the Customer Relationship Management (CRM) Integration. Details and conditions for each ﬁeld are explained in the ﬁeld description or additional details about the ﬁeld. Q: Is backward compatibility a permanent feature? No. Backward compatibility is time-bound, designed to provide ﬂexibility for you to plan and implement upcoming changes. It stops working beyond a speciﬁed cut-oﬀ date, which will be announced later in the year as part of a wider launch. Q: What happens when I start sending payloads with version 2.0? Once you send a payload with version 2.0, the system assumes that all necessary changes have been implemented, and validations for the new payload version apply to all subsequent changes. It’s essential that you don't implement features partially between version 1.0 and version 2.0 payloads. Q: Can I revert back to payload version 1.0 after updating to version 2.0? No. Transitioning to payload version 2.0 is a one-way process. Once you update to version 2.0, you can't revert back to version 1.0 of the payload. Technical FAQ—versioning and backward compatibility 167
apc-gs-001	apc-gs.pdf	1	Getting Started Guide AWS Partner Central Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Partner Central Getting Started Guide AWS Partner Central: Getting Started Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Partner Central Table of Contents Getting Started Guide What is AWS Partner Central? ........................................................................................................ 1 Becoming an AWS Partner .............................................................................................................. 2 Registering in AWS Partner Central ............................................................................................... 3 Inviting new users ........................................................................................................................... 5 .......................................................................................................................................................................... 5 Signing in to AWS Partner Central ................................................................................................. 6 AWS Partner Central home page .................................................................................................... 8 Navigation bar ............................................................................................................................................... 8 Global search ................................................................................................................................................. 8 Tasks ................................................................................................................................................................ 9 Dropdown menus ......................................................................................................................................... 9 Support ...................................................................................................................................................... 9 Language ................................................................................................................................................ 10 My Company .......................................................................................................................................... 10 Company Proﬁle .................................................................................................................................... 10 My Proﬁle ............................................................................................................................................... 11 AWS Partner Central menus and role, path, and stage access ......................................................... 13 Applying to AWS Partner programs ....................................................................................................... 23 Partner walkthroughs ................................................................................................................................ 24 Partner news and events .......................................................................................................................... 24 AWS Partner Assistant .................................................................................................................. 25 Beneﬁts and features of AWS Partner Assistant ................................................................................. 26 Using AWS Partner Assistant ................................................................................................................... 26 Asking questions to AWS Partner Assistant ......................................................................................... 27 Troubleshooting AWS Partner Assistant responses ............................................................................ 27 AWS Partner Assistant FAQ ...................................................................................................................... 27 How do I access AWS Partner Assistant? ......................................................................................... 28 What languages does AWS Partner Assistant support? ................................................................ 28 What can AWS Partner Assistant do? ............................................................................................... 28 Can partners use AWS Partner Assistant to change their account or services? ........................ 28 How does AWS Partner Assistant handle conﬁdential information? .......................................... 29 What should I do if AWS Partner Assistant isn't responding? ..................................................... 29 What should I do if AWS Partner Assistant provides incorrect information? ............................ 29 Can I turn oﬀ AWS Partner Assistant if I don't want to use it? ................................................... 29 iii AWS Partner Central Getting Started Guide Linking AWS Partner Central and AWS accounts ........................................................................ 30 Prerequisites ................................................................................................................................................ 31 User roles and permissions ................................................................................................................. 31 Knowing which accounts to link ........................................................................................................ 31 Granting IAM permissions ................................................................................................................... 32 Understanding the role permissions ................................................................................................. 35 Creating a permission set for SSO .................................................................................................... 37 Linking accounts ......................................................................................................................................... 39 Using custom policies to map users ................................................................................................. 41 Unlinking accounts ..................................................................................................................................... 44 Account linking FAQ .................................................................................................................................. 45 Mapping AWS Marketplace roles to a CRM integration user ...................................................... 52 AWS managed policies for AWS Partner Central users ............................................................... 54 AWSPartnerCentralFullAccess .................................................................................................................. 54 PartnerCentralAccountManagementUserRoleAssociation .................................................................. 55 AWSPartnerCentralOpportunityManagement ...................................................................................... 55 AWSPartnerCentralSandboxFullAccess .................................................................................................. 55 AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy ............................................ 56 Policy updates ............................................................................................................................................. 56 Controlling access in AWS Partner Central account management ............................................. 58 Permissions for AWS Partner Central account management ............................................................ 58 AssociatePartnerAccount ..................................................................................................................... 58 AssociatePartnerUser ........................................................................................................................... 59 DisassociatePartnerUser ...................................................................................................................... 60 Additional resources .................................................................................................................................. 60 Logging AWS Partner Central API calls with AWS CloudTrail ..................................................... 61 AWS Partner Central log ﬁle entry examples ...................................................................................... 62 Related topics ............................................................................................................................................. 63 User management ......................................................................................................................... 65 AWS Partner Central roles ....................................................................................................................... 66 Alliance lead ........................................................................................................................................... 67 Alliance team ......................................................................................................................................... 67 Standard user ........................................................................................................................................ 69 Channel user .......................................................................................................................................... 69 Cloud admin ........................................................................................................................................... 69 Marketing staﬀ ...................................................................................................................................... 71 iv AWS Partner Central Getting Started Guide Technical staﬀ ........................................................................................................................................ 72 ACE manager ......................................................................................................................................... 73 ACE user .................................................................................................................................................. 74 Role comparison .................................................................................................................................... 75 Managing users and role assignments .................................................................................................. 77 Managing role assignments ................................................................................................................ 77 Reassigning the alliance lead role ..................................................................................................... 79 Mapping users to IAM roles ................................................................................................................ 80 Removing users ..................................................................................................................................... 81 Managing your proﬁle ......................................................................................................................... 81 AWS Partner Central permissions best practices ................................................................................. 83 Assign roles according to the principle of least privilege ............................................................. 83 Audit role assignments ........................................................................................................................ 83 Use unique credentials ........................................................................................................................ 83 Avoid generic logins ............................................................................................................................. 84 Multi-factor authentication (MFA) .......................................................................................................... 85 AWS Partner Central tasks ............................................................................................................ 87 My tasks ....................................................................................................................................................... 87 Task summary ........................................................................................................................................ 87 Completing tasks .................................................................................................................................. 88 Dismissing a task .................................................................................................................................. 89 Task management ...................................................................................................................................... 89 Solution growth stage tasks .................................................................................................................... 89 Build stage .............................................................................................................................................. 90 Market stage .......................................................................................................................................... 91 Sell stage ................................................................................................................................................ 93 Grow stage ............................................................................................................................................. 95 AWS Partner Central FAQ ............................................................................................................. 97 How do I open an AWS Support ticket? ............................................................................................... 97 I'm locked out of AWS Partner Central. How do I get support? ....................................................... 97 How do I register for AWS Partner Accreditations? ............................................................................ 97 How do I reset my AWS Partner Central password? ........................................................................... 98 How do I ensure that my Partner Scorecard registers my organization's AWS Certiﬁcations? .... 98 How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? ....................... 99 What is the AWS Direct Connect program? ....................................................................................... 100 Does AWS Partner Central
apc-gs-002	apc-gs.pdf	2	93 Grow stage ............................................................................................................................................. 95 AWS Partner Central FAQ ............................................................................................................. 97 How do I open an AWS Support ticket? ............................................................................................... 97 I'm locked out of AWS Partner Central. How do I get support? ....................................................... 97 How do I register for AWS Partner Accreditations? ............................................................................ 97 How do I reset my AWS Partner Central password? ........................................................................... 98 How do I ensure that my Partner Scorecard registers my organization's AWS Certiﬁcations? .... 98 How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? ....................... 99 What is the AWS Direct Connect program? ....................................................................................... 100 Does AWS Partner Central support the Microsoft Edge Legacy browser? .................................... 100 v AWS Partner Central Getting Started Guide What is the Microsoft Edge Legacy browser? ............................................................................... 100 Why the change? ................................................................................................................................ 101 Can I access the AWS Management Console through AWS Partner Central? .............................. 101 Document history ........................................................................................................................ 102 vi AWS Partner Central Getting Started Guide What is AWS Partner Central? Amazon Web Services (AWS) Partner Central is a self-service portal where AWS Partners manage their engagement with AWS. As an AWS Partner, use AWS Partner Central to access beneﬁts, diﬀerentiate your oﬀerings, and use resources, tools, and training that can help your company increase its marketing impact. 1 AWS Partner Central Getting Started Guide Becoming an AWS Partner The AWS Partner Network (APN) is a global community of partners that oﬀers programs, expertise, and resources to build, market, and sell partner oﬀerings. Whether you are just beginning to build or looking to expand your business, you can join the APN at no cost and use AWS trainings, enablement resources, Well-Architected tools, and more. For instructions to become an AWS Partner, refer to Join the AWS Partner Network. 2 AWS Partner Central Getting Started Guide Registering in AWS Partner Central Before you can use AWS Partner Central, you must ﬁrst register your company. The person who registers the company with the AWS Partner Central and becomes the alliance lead must have the legal authority to accept the AWS Partner Central terms and conditions on behalf of their business. After you register your company, individual users can register. In both cases, registration is based on your company’s unique email domain, such as companyname.com. If multiple companies, such as parent and child companies, share the same business domain and register in the AWS Partner Network, they will still share one single AWS Partner Central account. Additional users who register with their company email address that contains the same domain will be linked to the same AWS Partner Central account. To register your company in AWS Partner Central 1. Navigate to the AWS Partner Central registration form. 2. Enter your name and your email address with the domain of your company, such as companyname.com. Personal email address domains (such as gmail.com, hotmail.com, outlook.com, and .edu) are not accepted. 3. Choose Yes to acknowledge that you are the main point of contact to manage your company's business relationship with AWS and that you agree to become the alliance lead for your company. 4. Retrieve the security code you receive in an email message from apn-no-reply@amazon.com. Enter this code in your registration form. 5. Create a password and complete the CAPTCHA. 6. Enter customer information, contact information, and company information. The primary oﬀering you choose (software products or consulting services) determines your AWS Partner Network path registration. 7. After completing the form and reviewing your entries, choose Register. The AWS Partner Central home page appears. For more information, refer to AWS Partner Central home page. To register as a user in AWS Partner Central 1. Navigate to the AWS Partner Central registration form. 2. Enter your name and email address with the domain of your registered company, such as >companyname.com. Personal email address domains (such as gmail.com, hotmail.com, 3 AWS Partner Central Getting Started Guide outlook.com, and .edu) are not accepted. You will get an error message if you enter an invalid email address. 3. Choose Verify email. 4. Check your email for a message from apn-no-reply@amazon.com. The message contains a security code. 5. Enter the security code in your registration form. You will be registered in a role with standard access to AWS Partner Central. The alliance lead can modify your permissions after you register. 6. Complete the customer and contact information on the registration form. 7. Choose Register. 4 AWS Partner Central Getting Started Guide Inviting new users To give employees AWS Partner Central access, invite them to join. Users with the alliance lead and alliance team roles can invite new users. To invite new users 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Partner Central roles tab. 4.
apc-gs-003	apc-gs.pdf	3	lead can modify your permissions after you register. 6. Complete the customer and contact information on the registration form. 7. Choose Register. 4 AWS Partner Central Getting Started Guide Inviting new users To give employees AWS Partner Central access, invite them to join. Users with the alliance lead and alliance team roles can invite new users. To invite new users 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Partner Central roles tab. 4. Choose Invite users. 5. Enter a user email address. You will get an error message if you enter an invalid email address. 6. Choose one or more roles to assign to them. For more information about roles, refer to AWS Partner Central roles. 7. (Optional) To invite another user, choose Add Another User. 8. Choose Invite. Invited users receive an email message containing a link to register. 5 AWS Partner Central Getting Started Guide Signing in to AWS Partner Central Registered users can sign in to AWS Partner Central portal from a browser. For the best experience, we recommend using a desktop computer. To sign in to AWS Partner Central 1. Open AWS Partner Central at https://partnercentral.awspartner.com/APNLogin. 2. Enter the business email address and password you conﬁgured during registration. 3. Choose Sign in. 4. If your organization's AWS Partner Central account is conﬁgured to use multi-factor authentication (MFA), check your email at the address shown for the veriﬁcation code. 5. Check your email at the address shown for the veriﬁcation code. 6. Enter the veriﬁcation code in the empty text ﬁeld. The code will expire after 15 minutes, at the time shown. • If the code expires before you enter it, choose Resend code to request a new one. • You have three attempts to enter the code. After 3 failed attempts, the code becomes invalid. Choose Resend code to request a new one. • You can only request a new code three times within a one-hour period. • You cannot request a new code before the current one expires. 7. (Optional) To avoid this veriﬁcation step for the next 30 days on this device, choose Trust this device for 30 days. 8. Choose Verify code. Note If you need to start over, choose Back to sign in. Do not use your browser's back button or refresh the page as this may lock your account. If this happens, restart your browser and try again. Important If you are locked out of AWS Partner Central and need support, do the following: 6 AWS Partner Central Getting Started Guide 1. Navigate to the AWS Partner Team contact page of the AWS Partner Network Knowledge Base. 2. Complete the contact form and choose Submit. 7 AWS Partner Central Getting Started Guide AWS Partner Central home page The AWS Partner Central home page displays information relevant to your assigned role. The home page contains a navigation bar and dropdown menus at the top, and an icon in the bottom right corner to access walkthroughs. Topics • Navigation bar • Global search • Tasks • Dropdown menus • AWS Partner Central menus and role, path, and stage access • Applying to AWS Partner programs • Partner walkthroughs • Partner news and events Navigation bar At the top of the AWS Partner Central home page is a navigation bar. The navigation bar contains menus to access AWS Partner Central content related to AWS Partner beneﬁts and path or tier progression. Hover over menu items to view details about their content. You can only access the menu items permitted to your assigned role. For more about AWS Partner Central menu items and the roles that can access them, refer to AWS Partner Central menus and role, path, and stage access. Global search In the center of the navigation bar, enter a term in the search box to search your AWS Partner account and partner-enablement content—including ACE opportunities, oﬀerings, how-to guides, and videos. The search feature does not include index fund requests or partner analytics dashboards. Search results display in tables, organized by record type. In the left panel, you can apply one or more record-type ﬁlters to surface results of a speciﬁc type. Choose Clear ﬁlters to remove ﬁlters. Navigation bar 8 AWS Partner Central Getting Started Guide A maximum of ﬁve results for each record type display in each table. If there are more than ﬁve results for a type, choose View all to expand results. To open a record, choose the record name or title. Tasks AWS Partner Central tasks can help you prioritize and complete activities in AWS Partner Central that are relevant to your AWS goals. AWS Partner Central can recommend the most
apc-gs-004	apc-gs.pdf	4	panel, you can apply one or more record-type ﬁlters to surface results of a speciﬁc type. Choose Clear ﬁlters to remove ﬁlters. Navigation bar 8 AWS Partner Central Getting Started Guide A maximum of ﬁve results for each record type display in each table. If there are more than ﬁve results for a type, choose View all to expand results. To open a record, choose the record name or title. Tasks AWS Partner Central tasks can help you prioritize and complete activities in AWS Partner Central that are relevant to your AWS goals. AWS Partner Central can recommend the most relevant tasks according to your role and company's path. For more information, refer to AWS Partner Central tasks. Dropdown menus At the top right corner of AWS Partner Central are dropdown menus for Support, Language, My Company, and My Proﬁle. You can only access the menu items permitted to your assigned role. For more about AWS Partner Central menu items and the roles that can access them, refer to AWS Partner Central menus and role, path, and stage access. Support In AWS Partner Central, choose Support, Contact Support to submit new cases, view your case history, or correspond with AWS Partner Support. AWS Partner Support is a case-management feature for partners to engage with APN Support. On the Partner Support page, you can open a new case, review your open and previous cases, and read articles related to common issues, questions, and concerns posed by other users. You can track correspondence on open cases, respond directly from AWS Partner Central, and upload ﬁles to help you communicate your issues with AWS Partner support. AWS Partner Support gives you the ability to enter details about your issue so that the support team can help you more eﬃciently. • Type of Case – Choose the type of support case you want to open. This helps to route your request to the right team. • Question Type – Choose the option that best aligns with the type of question you want to ask the support team. • Get Speciﬁc – Choose a more speciﬁc question type. • Subject – Enter a descriptive subject for your support ticket. Tasks 9 AWS Partner Central Getting Started Guide • Description – Describe your issue in detail. • Attachments – Add any attachments to help describe your issue. If you are locked out of AWS Partner Central, you can get support by doing the following: 1. Navigate to the AWS Partner Team contact page of the AWS Partner Network Knowledge Base. 2. Complete the contact form and choose Submit. Language You can choose a diﬀerent language from the Language dropdown menu. My Company The My Company dropdown menu has several items to help you manage your company proﬁle, user management, AWS certiﬁcations, and more. The majority of these menu options are available only to alliance team users. For more information, refer to AWS Partner Central roles. • Partner Scorecard – View your Partner Scorecard to track progression in your AWS Partner path and tier requirements. • Company Proﬁle – Access your company information, products and services, and for eligible partners, your Product Solutions Finder listing information. • User Management – Assign roles to users and invite new users to AWS Partner Central. • Training & Certiﬁcations – View the AWS trainings and certiﬁcations completed by users in your organization. • AWS Educate Job Board – Post jobs to reach candidates with speciﬁc AWS certiﬁed skills. • Request alliance lead Change – Submit a request to change the alliance lead role to a diﬀerent user. Company Proﬁle In the top right menu, choose My Company, Company Proﬁle to open a page where you can update your company’s information, and for Validated or higher stage partners, update your Partner Solutions Finder listing. This page is available only to alliance lead, alliance team, and marketing staﬀ roles. Language 10 AWS Partner Central Getting Started Guide The Company Proﬁle page contains several tabs with unique information. Updates to this page are reﬂected on the AWS Partner Solutions Finder public webpage for eligible partners. For partners in Registered, Enrolled, or Conﬁrmed stages, only a subset of the tabs on Company Proﬁle are visible (only Company, Products & Services, and My Domains), and this information is not listed on AWS Partner Solutions Finder. • Company – Update general information about your business and the type of customers you serve. • Solutions/Practices – View oﬀerings validated by AWS. You can add descriptive content to appear alongside your validated oﬀerings on your AWS Partner Solutions Finder listing. • Qualiﬁcations – View your AWS validated qualiﬁcations (such as AWS Competencies, AWS Services, Programs, and Certiﬁcations). Report your own solution areas to lead customers to your Partner Solutions Finder listing. • Locations – Highlight your organization's location
apc-gs-005	apc-gs.pdf	5	visible (only Company, Products & Services, and My Domains), and this information is not listed on AWS Partner Solutions Finder. • Company – Update general information about your business and the type of customers you serve. • Solutions/Practices – View oﬀerings validated by AWS. You can add descriptive content to appear alongside your validated oﬀerings on your AWS Partner Solutions Finder listing. • Qualiﬁcations – View your AWS validated qualiﬁcations (such as AWS Competencies, AWS Services, Programs, and Certiﬁcations). Report your own solution areas to lead customers to your Partner Solutions Finder listing. • Locations – Highlight your organization's location on your Partner Solutions Finder listing. • Case Studies – View case studies validated by AWS. You can add descriptive content to appear alongside your validated case studies on your AWS Partner Solutions Finder listing. • Products & Services – Choose the types of products and services you oﬀer to customers. This information is used to recommend AWS Partner Paths to you and your listing here is required to enroll in a relevant path. • My Domains – Add domains associated with your organization. When a user registers, if they have an included domain they are automatically added to your organization account and can collaborate with your team. My Proﬁle The My Proﬁle dropdown menu includes links to manage your personal proﬁle and share your AWS certiﬁcation details. Only features permitted to your assigned role appear on the menu. For more information, refer to link to role summaries. • My Proﬁle – View and edit your contact information and change your AWS Partner Central password. • My AWS Certiﬁcations – View your AWS training and certiﬁcations and edit your AWS training and certiﬁcations email address and consent to share your AWS Certiﬁcations with AWS Partner Network. • Partner terms & conditions – Read AWS Partner Network terms and conditions. My Proﬁle 11 AWS Partner Central Getting Started Guide My Proﬁle 12 AWS Partner Central Getting Started Guide AWS Partner Central menus and role, path, and stage access The following table provides descriptions of each menu item in AWS Partner Central and the roles, paths, and stages that can access them. Menu Item Description Role access Path access Stage access Partner Training Learn AWS Self- Paced Training AWS Instructor- Led Training Build your competence, conﬁdence, and credibili ty to better support customers with essential knowledge of the AWS Cloud. Find courses and content on AWS Skill Builder to empower learners across all levels. Learn AWS Cloud skills and best practices with expert AWS instructors. All roles All paths All stages All roles All paths All stages All roles All paths All stages AWS Certiﬁca tion Validate technical skills and All roles All paths All stages AWS Partner Central menus and role, path, and stage access 13 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access cloud expertise with certiﬁcations across role and specialty. List products and services available to your customers. Submit case Alliance lead, alliance team, technical staﬀ, marketing staﬀ Alliance lead, alliance team, Oﬀerings All paths All stages Case Studies Build studies to ACE manager, support your ACE user, oﬀerings technical and program staﬀ, applications. marketing staﬀ All paths All stages AWS Instructor- Device Listing Submit hardware products for AWS Device Qualiﬁca tion and AWS Partner Device Catalog listing. All roles All paths All stages AWS Partner Central menus and role, path, and stage access 14 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Well-Arch itected workloads Oﬀerings Upload Well- Architected Partner Program workloads. List products and services available to your customers. Generate demand for AWS your oﬀerings Market Marketing using the Central AWS Sponsorships AWS self-serv ice marketing portal. Connect with customers and prospects to grow your AWS business. Software, Conﬁrmed or Services higher All paths All stages All paths Conﬁrmed or higher All paths All stages Alliance lead, alliance team, technical staﬀ Alliance lead, alliance team, technical staﬀ, marketing staﬀ Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ AWS Partner Central menus and role, path, and stage access 15 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access APN Marketing Toolkit Access partner creative and messaging Alliance lead, guideline s to create marketing alliance team, ACE manager, ACE user, assets that marketing showcase staﬀ your expertise and relations hip with AWS. View your public AWS All paths All stages My Partner Solutions Finder Listing Partner listing Alliance lead, that highlight alliance team, s your marketing capabilities staﬀ All paths Validated or higher to potential customers. Submit public references to advance through program and tier requireme nts. Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ
apc-gs-006	apc-gs.pdf	6	Getting Started Guide Menu Item Description Role access Path access Stage access APN Marketing Toolkit Access partner creative and messaging Alliance lead, guideline s to create marketing alliance team, ACE manager, ACE user, assets that marketing showcase staﬀ your expertise and relations hip with AWS. View your public AWS All paths All stages My Partner Solutions Finder Listing Partner listing Alliance lead, that highlight alliance team, s your marketing capabilities staﬀ All paths Validated or higher to potential customers. Submit public references to advance through program and tier requireme nts. Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ Public Reference All paths Enrolled or higher AWS Partner Central menus and role, path, and stage access 16 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Find AWS Partners Badge Manager Leads Management Opportunity Management Connect with other partners to grow your business. Create custom partner badges to showcase your relations hip with AWS and earned specializ ations. Manage qualiﬁed leads from the AWS Partner Marketing teams. Manage opportunities from the AWS Sales team and upload opportuni ties for sales support from AWS. Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ All paths All stages Alliance lead, alliance team All paths Validated or higher Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ Alliance lead, alliance team, ACE manager, ACE user, marketing staﬀ All paths All stages All paths All stages Sell AWS Partner Central menus and role, path, and stage access 17 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Discover partner programs to help you All roles All paths All stages build, market, and sell your oﬀerings. Apply to partner Alliance lead, programs to alliance team, All paths technical staﬀ Validated or higher AWS Partner Programs Program Application Solution Provider Resources Programs unlock more beneﬁts. The Solution Provider Resources page is designed to help guide authorize d AWS Solutions Providers through numerous topics and key program requirements. All roles All paths All stages AWS Partner Central menus and role, path, and stage access 18 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Funding Beneﬁts for AWS Partners Funding Discover funding beneﬁts to help you manage training, developme nt, and marketing costs. Access your funding AWS Partner beneﬁts to All roles All paths All stages Funding Portal accelerate All roles All paths All stages your business development with AWS. Get prescript ive guidance Navigate with Navigate All roles All paths All stages Resources Documents enablement tracks. Access guides and help documents on topics around partner programs, AWS Services and more. All roles All paths All stages AWS Partner Central menus and role, path, and stage access 19 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access View videos on-demand across business, sales, and technical content. View our frequentl y asked questions about AWS Partner Central. Search across all resource categories. Videos FAQs View all All roles All paths All stages All roles All paths All stages All roles All paths All stages AWS Partner Central menus and role, path, and stage access 20 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Channel managemen t page from previous version of AWS Partner Central. Includes Program Managemen t Accounts, End User Information, and Partner Growth Rebate tabs. View your Partner Scorecard to track progressi on in your AWS Partner Path and tier requirements. Manage your company information and Partner Solutions Finder listing. Channel My Company Partner Scorecard Company Proﬁle Channel user Services, Enrolled or Distribution higher Alliance lead, alliance team All paths All stages Alliance lead, alliance team, marketing staﬀ All paths All stages AWS Partner Central menus and role, path, and stage access 21 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Manage users in your User organization Alliance lead, Management and assign alliance team All paths All stages AWS Educate Job Board View all Training and Certiﬁcation user roles to users. Find cloud- certiﬁed job seekers to grow your organization. Keep track of your team's learning progress and earned certiﬁcations. Identify your organizations Alliance lead, alliance team All paths All stages Alliance lead, alliance team All paths All stages View alliance alliance lead lead and Request Change My Proﬁle My Proﬁle and request a change if the designate d user has changed. Manage your user proﬁle. All users All paths All stages All roles All paths All stages AWS Partner Central menus and role, path, and stage access 22 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Link your AWS training My Certiﬁca account and tions Logout Partner
apc-gs-007	apc-gs.pdf	7	learning progress and earned certiﬁcations. Identify your organizations Alliance lead, alliance team All paths All stages Alliance lead, alliance team All paths All stages View alliance alliance lead lead and Request Change My Proﬁle My Proﬁle and request a change if the designate d user has changed. Manage your user proﬁle. All users All paths All stages All roles All paths All stages AWS Partner Central menus and role, path, and stage access 22 AWS Partner Central Getting Started Guide Menu Item Description Role access Path access Stage access Link your AWS training My Certiﬁca account and tions Logout Partner Terms and Conditions view your training and certiﬁcation. Log out of AWS Partner Central. View AWS Partner terms and condition s. All roles All paths All stages All roles All paths All stages All roles All paths All stages Applying to AWS Partner programs Alliance lead, alliance team, and technical staﬀ users can apply to AWS Partner Programs in AWS Partner Central. To apply for an AWS Partner program 1. Choose Programs, Program Applications. 2. On the Applications and Programs page, choose Create. 3. On the Apply for Program page, choose Select Designation. 4. In the Select Designation dialog box, search for and choose a program. For example, to apply to the AWS ISV Workload Migration (WMP) program, search for ISV and choose ISV Workload Migration. 5. Choose Select. 6. Select the acknowledgement checkbox and choose Yes, I Agree. 7. Complete the application steps. For more information, refer to the program guidelines. 8. To send your application, choose Submit. To save your application as a draft, choose Submit Later. Applying to AWS Partner programs 23 AWS Partner Central Getting Started Guide Partner walkthroughs Partner walkthroughs are self-service guided tutorials for navigating AWS Partner Central and completing common workﬂows. To access walkthroughs, choose the Partner walkthrough icon at the bottom right corner of the AWS Partner Central home page. Partner news and events The AWS Partner Central home page features Partner news and Partner events feeds. These feeds display curated collections of AWS and AWS Partner news and events relevant to AWS Partners. The Partner news feed features articles related to AWS Partner Central launch announcements, AWS service launch news, and important AWS Partner deadlines. To access a searchable and ﬁlterable list of articles published in the last six months, choose View all partner news. The Partner events feed features events relevant to AWS Partners, including webinars, workshops, summits, and keynote events. Delivery-format tags indicate if an event is in-person, virtual, or both. Choose the title of an event to access more information or register. To access a searchable and ﬁlterable page of all upcoming events curated for AWS Partners, choose View all partner events. Pinned events display at the top of this page, highlighted because of their importance to all AWS Partners. Partner walkthroughs 24 AWS Partner Central Getting Started Guide AWS Partner Assistant AWS Partner Assistant is a generative AI-powered chatbot for AWS Partners. It is accessible from both Partner Central and AWS Marketplace Management Portal (AMMP) and uses Amazon Q Business. It is trained on documentation that's exclusive to registered APN partners. Note To access AWS Partner Assistant, partners must link their AWS Partner Central account with their AWS account. For more information, see Linking AWS Partner Central and AWS accounts. The chatbot provides real-time answers and documentation summaries on a variety of topics related to AWS services, AWS Marketplace seller guidance, and AWS Partner Network incentives, beneﬁts, and programs. If the chatbot is unable to provide a response, it advises you on how to ﬁle a ticket with the support team. You can also provide feedback from within the chatbot using thumbs-up and thumbs-down buttons, which helps improve the chatbot’s accuracy and quality. The following is a typical interaction with AWS Partner Assistant: 1. Ask a question: Open the chatbot from either AWS Partner Central or AMMP, and ask a question using everyday language. 2. AWS Partner Assistant processes the request: The chatbot uses natural language processing (NLP) to interpret your query. 3. AWS Partner Assistant generates a response: The chatbot returns a relevant response, which includes additional resources. 4. Provide feedback: The chatbot prompts you for feedback. Topics • Beneﬁts and features of AWS Partner Assistant • Using AWS Partner Assistant • Asking questions to AWS Partner Assistant • Troubleshooting AWS Partner Assistant responses • AWS Partner Assistant FAQ 25 AWS Partner Central Getting Started Guide Beneﬁts and features of AWS Partner Assistant AWS Partner Assistant has self-service support that improves access to information. • Immediate answers: Partners typically must contact AWS directly for help, but AWS Partner Assistant is always available. • Accurate answers: Partners receive factual, timely information with minimal response variability. • Self-service support: Reduces the time it takes to locate relevant resources.
apc-gs-008	apc-gs.pdf	8	feedback. Topics • Beneﬁts and features of AWS Partner Assistant • Using AWS Partner Assistant • Asking questions to AWS Partner Assistant • Troubleshooting AWS Partner Assistant responses • AWS Partner Assistant FAQ 25 AWS Partner Central Getting Started Guide Beneﬁts and features of AWS Partner Assistant AWS Partner Assistant has self-service support that improves access to information. • Immediate answers: Partners typically must contact AWS directly for help, but AWS Partner Assistant is always available. • Accurate answers: Partners receive factual, timely information with minimal response variability. • Self-service support: Reduces the time it takes to locate relevant resources. • Advanced responses: Provides natural, intuitive, human-like responses. • Contextual understanding: Provides additional information about complex subjects. • Self-learning system: Continuously improves by learning from interactions, reﬁning responses over time, and expanding its knowledge base. • Scalable support: Capable of handling large volumes of inquires simultaneously. Using AWS Partner Assistant 1. Log in to AWS Partner Central or AMMP. 2. Access the chat: a. Choose the purple ﬂoating icon at the bottom-right hand corner. b. Choose from one of the suggested prompts, or begin typing your question in the text ﬁeld. c. The chatbot responds with sources and links. 3. Access the chatbot from Partner Central: a. Choose the Support menu. b. Select Instant chat with AWS Partner Assistant from the dropdown. c. (Optional) Access the chatbot from a support ticket. Before submitting a support ticket, choose Ask AWS Partner Assistant to get an immediate answer. 4. Access the chatbot from AMMP: a. From the Contact Us page, choose Ask AWS Partner Assistant. b. (Optional) Access the chatbot from a support ticket. Before submitting a support ticket, choose Submit support request from the Contact Us page. Choose Ask AWS Partner Assistant to get an immediate answer. 5. (Optional) Provide feedback: Beneﬁts and features of AWS Partner Assistant 26 AWS Partner Central Getting Started Guide a. After each response, you have the option to provide feedback: Choose Thumbs Up if the response meets your needs. b. Choose Thumbs Down if the response wasn’t helpful. c. If you choose Thumbs Down, provide more detail in the text box or choose an option from the picklist that best describes why the response wasn’t helpful. d. Rate your experience by choosing Feedback from the bottom-left corner of the chatbot window: Choose Feedback to open a pop-up with a rating scale. Use the text ﬁeld for any additional comments or feedback. Asking questions to AWS Partner Assistant The chatbot provides real-time answers and documentation summaries about AWS services, AWS Marketplace seller guidance, and AWS Partner Network programs, incentives, and beneﬁts. The chatbot uses a library of published content that’s exclusive to partners. Currently, AWS Partner Assistant provides only general information and guidance. It can’t generate creative content or perform tasks. If AWS Partner Assistant is unable to adequately answer your question, submit feedback. For issues that require in-depth troubleshooting, account veriﬁcation, or access to sensitive data, contact AWS customer support directly. Troubleshooting AWS Partner Assistant responses If AWS Partner Assistant can’t answer your question, try rephrasing it. You can submit thumbs-down feedback directly within AWS Partner Assistant and provide additional context. Your feedback helps us improve AWS Partner Assistant's performance. Optionally, you can provide structured feedback from a picklist of common categories. AWS Partner Assistant FAQ This topic provides answers to the following questions about AWS Partner Assistant. Topics • How do I access AWS Partner Assistant? Asking questions to AWS Partner Assistant 27 AWS Partner Central Getting Started Guide • What languages does AWS Partner Assistant support? • What can AWS Partner Assistant do? • Can partners use AWS Partner Assistant to change their account or services? • How does AWS Partner Assistant handle conﬁdential information? • What should I do if AWS Partner Assistant isn't responding? • What should I do if AWS Partner Assistant provides incorrect information? • Can I turn oﬀ AWS Partner Assistant if I don't want to use it? How do I access AWS Partner Assistant? AWS Partner Assistant is available to both AWS Partners and AWS Marketplace sellers at all times. You can access the chatbot from any page through AWS Partner Central or AWS Marketplace Management Portal (AMMP). Note Partners must link their AWS Partner Central and AWS accounts to access the chatbot. For more information, refer to Linking AWS Partner Central accounts with AWS Marketplace seller accounts. What languages does AWS Partner Assistant support? Currently, AWS Partner Assistant supports only English, but it will support other languages in future releases. What can AWS Partner Assistant do? The chatbot provides real-time answers and documentation summaries about AWS services, AWS Marketplace seller guidance, and AWS Partner programs, incentives, and beneﬁts. The chatbot uses a library of published content that’s exclusive to partners. Can partners use AWS Partner Assistant
apc-gs-009	apc-gs.pdf	9	(AMMP). Note Partners must link their AWS Partner Central and AWS accounts to access the chatbot. For more information, refer to Linking AWS Partner Central accounts with AWS Marketplace seller accounts. What languages does AWS Partner Assistant support? Currently, AWS Partner Assistant supports only English, but it will support other languages in future releases. What can AWS Partner Assistant do? The chatbot provides real-time answers and documentation summaries about AWS services, AWS Marketplace seller guidance, and AWS Partner programs, incentives, and beneﬁts. The chatbot uses a library of published content that’s exclusive to partners. Can partners use AWS Partner Assistant to change their account or services? No, but it can guide you on how to make these changes. How do I access AWS Partner Assistant? 28 AWS Partner Central Getting Started Guide How does AWS Partner Assistant handle conﬁdential information? AWS Partner Assistant is designed to safeguard user privacy and data, but we don’t recommend sharing sensitive information. What should I do if AWS Partner Assistant isn't responding? Try refreshing the page or restarting the application. If the issue persists, report the problem to our support team. What should I do if AWS Partner Assistant provides incorrect information? If you believe AWS Partner Assistant has given you incorrect information, provide feedback at the end of your session using the thumbs-down option. Can I turn oﬀ AWS Partner Assistant if I don't want to use it? AWS Partner Assistant is an optional feature. If you prefer not to use it when you have a question, you can use existing support channels. How does AWS Partner Assistant handle conﬁdential information? 29 AWS Partner Central Getting Started Guide Linking AWS Partner Central and AWS accounts You can streamline your operations by linking AWS Partner Central to the AWS account dedicated to AWS Partner Network engagements. If you sell on AWS Marketplace, you can also link AWS Partner Central to your AWS Marketplace seller account. Note • As of January 2025, new partners who want to join the ISV Accelerate program must link accounts to do so. • The Small Business Acceleration Initiative, a partner-led channel sales motion to drive small business digital customer transformation, requires new and existing partners to link accounts to support partner and program goals. Account linking provides several advantages. • You can use Partner Connections in AWS Partner Central to work on coselling deals with with other partners. Doing so can help deals progress faster and expand your reach. For more information, refer to Partner connections in the AWS Partner Central Sales Guide. • You can integrate Partner Central with your customer relationship management (CRM) system to synchronize engagements, opportunities, solutions, and event notiﬁcations. You no longer need to maintain identical data across systems, and integrations use real-time data from AWS Partner Central. For more information about customer relationship management (CRM) integration, refer to AWS Partner CRM integration in the AWS Partner CRM Integration Guide. • If you sell on AWS Marketplace, you can attach oﬀers to sales opportunities. You can also integrate your AWS Marketplace data into the Partners Analytics dashboard in Partner Central. The following topics explain how to link accounts. Topics • Prerequisites • Linking AWS Partner Central and AWS accounts • Unlinking AWS Partner Central and AWS accounts • Account linking FAQ 30 AWS Partner Central Prerequisites Getting Started Guide The following topics list the prerequisites needed to link AWS Partner Central and AWS accounts. We recommind following the topics in the order listed. Note Due to user interface, feature, and performance issues, account linking does not support Firefox Extended Support Release (Firefox ESR). We recommend using the regular version of Firefox or one of the chrome browsers. Topics • User roles and permissions • Knowing which accounts to link • Granting IAM permissions • Understanding the role permissions • Creating a permission set for SSO User roles and permissions To link your AWS account with an AWS Partner Central account, you must have people in the following roles: • An AWS Partner Central user with the alliance lead or cloud admin role. For more information about assigning a role to a user, refer to Managing users and role assignments later in this guide. • An IT administrator in your organization responsible for the AWS account you're linking to. The admin creates a custom permissions policy and assigns it to an IAM user and role. For information about the custom policy, refer to Granting IAM permissions later in this guide. Knowing which accounts to link Before initiating account linking, an AWS Partner Central alliance lead or cloud admin, and an IT administrator in your organization, must decide on which accounts to link. Use the following criteria: Prerequisites 31 AWS Partner Central Getting Started Guide • AWS recommends linking to an AWS account dedicated to AWS
apc-gs-010	apc-gs.pdf	10	An IT administrator in your organization responsible for the AWS account you're linking to. The admin creates a custom permissions policy and assigns it to an IAM user and role. For information about the custom policy, refer to Granting IAM permissions later in this guide. Knowing which accounts to link Before initiating account linking, an AWS Partner Central alliance lead or cloud admin, and an IT administrator in your organization, must decide on which accounts to link. Use the following criteria: Prerequisites 31 AWS Partner Central Getting Started Guide • AWS recommends linking to an AWS account dedicated to AWS Partner Network (APN) engagements. If you have multiple AWS accounts, we recommend linking an account that: • You use to sign in to AWS Partner Central • Represents your global business • Serves as the primary account for administrative tasks • If you sell on AWS Marketplace, you have the option of linking to an AWS Marketplace seller account. If you own multiple AWS Marketplace accounts, choose your primary account, such as the one with the most transactions. • Partners in the China region should create and link to a global AWS account. Note For help identifying the correct accounts, open a support case. To do so, navigate to AWS Partner Support and choose Open New Case. Granting IAM permissions The IAM policy listed in this section grants AWS Partner Central users limited access to a linked AWS account. The level of access depends on the IAM role assigned to the user. For more information about permission levels, refer to Understanding the role permissions later in this topic. To create the policy, you must be an IT administrator responsible for an AWS environment. When ﬁnished, you must assign the policy to an IAM user or role. The steps in this section explain how to use the IAM console to create the policy. Note If you're an alliance lead or cloud admin, and you already have an IAM user or role with AWS administrator permissions, skip to the section called “Linking accounts”. For more information about AWS Partner Central roles, refer to AWS Partner Central roles later in this guide. Granting IAM permissions 32 AWS Partner Central To create the policy Getting Started Guide 1. Sign in to the IAM console. 2. Under Access management, choose Policies. 3. Choose Create policy, choose JSON, and add the following policy: { "Version": "2012-10-17", "Statement": [ { "Sid": "CreatePartnerCentralRoles", "Effect": "Allow", "Action": [ "iam:CreateRole" ], "Resource": [ "arn:aws:iam:::role/PartnerCentralRoleForCloudAdmin", "arn:aws:iam:::role/PartnerCentralRoleForAce", "arn:aws:iam:::role/PartnerCentralRoleForAlliance" ] }, { "Sid": "AttachPolicyToPartnerCentralCloudAdminRole", "Effect": "Allow", "Action": "iam:AttachRolePolicy", "Resource": "arn:aws:iam:::role/PartnerCentralRoleForCloudAdmin", "Condition": { "ArnLike": { "iam:PolicyARN": [ "arn:aws:iam:::policy/ PartnerCentralAccountManagementUserRoleAssociation", "arn:aws:iam:::policy/AWSPartnerCentralFullAccess", "arn:aws:iam:::policy/AWSMarketplaceSellerFullAccess" ] } } }, { "Sid": "AttachPolicyToPartnerCentralAceRole", "Effect": "Allow", "Action": [ "iam:AttachRolePolicy" ], Granting IAM permissions 33 AWS Partner Central Getting Started Guide "Resource": "arn:aws:iam:::role/PartnerCentralRoleForAce", "Condition": { "ArnLike": { "iam:PolicyARN": [ "arn:aws:iam:::policy/ AWSPartnerCentralOpportunityManagement", "arn:aws:iam:::policy/AWSMarketplaceSellerOfferManagement" ] } } }, { "Sid": "AttachPolicyToPartnerCentralAllianceRole", "Effect": "Allow", "Action": [ "iam:AttachRolePolicy" ], "Resource": "arn:aws:iam:::role/PartnerCentralRoleForAlliance", "Condition": { "ArnLike": { "iam:PolicyARN": [ "arn:aws:iam:::policy/AWSPartnerCentralFullAccess", "arn:aws:iam:::policy/AWSMarketplaceSellerFullAccess" ] } } }, { "Sid": "AssociatePartnerAccount", "Effect": "Allow", "Action": [ "partnercentral-account-management:AssociatePartnerAccount" ], "Resource": "" }, { "Sid": "SellerRegistration", "Effect": "Allow", "Action": [ "aws-marketplace:ListChangeSets", "aws-marketplace:DescribeChangeSet", "aws-marketplace:StartChangeSet", "aws-marketplace:ListEntities", "aws-marketplace:DescribeEntity" Granting IAM permissions 34 AWS Partner Central Getting Started Guide ], "Resource": "*" } ] } 4. Choose Next. 5. Under Policy details, in the Policy name box, enter a name for the policy and an optional description. 6. Review the policy permissions, add tags as needed, and then choose Create policy. 7. Attach your IAM user or role to the policy. For information on attaching, refer to Adding IAM identity permissions (console) in the IAM User Guide. Understanding the role permissions After the IT administrator completes the steps in the previous section, alliance leads and others in AWS Partner Central can assign security policies and map user roles. The following table lists and describes the standard roles created during account linking, and the tasks available to each role. Standard IAM role AWS Partner Central managed policies used Can do Cannot do Cloud Admin • PartnerCentralAcco • Map and assign untManage mentUserR IAM roles to AWS Partner Central oleAssociation users • AWSPartne rCentralFullAccess: • AWSMarket placeSellerFullAcc ess: • Complete the same tasks as alliance and ACE teams Alliance Team • AWSPartne rCentralFullAccess: • Full access to all seller operations on AWS Marketpla Map or assign IAM roles to AWS Partner Central users. Only ce, including the alliance leads and Understanding the role permissions 35 AWS Partner Central Standard IAM role AWS Partner Central managed policies used Can do Cannot do Getting Started Guide • AWSMarket AWS Marketpla cloud admins map or placeSellerFullAcc ess: assign roles. ce Managemen t Portal. You can also manage the Amazon EC2 AMI used in AMI-based products. • Link AWS customer engagement opportunities with AWS Marketplace private oﬀers. • Associate APN solutions with AWS
apc-gs-011	apc-gs.pdf	11	Team • AWSPartne rCentralFullAccess: • Full access to all seller operations on AWS Marketpla Map or assign IAM roles to AWS Partner Central users. Only ce, including the alliance leads and Understanding the role permissions 35 AWS Partner Central Standard IAM role AWS Partner Central managed policies used Can do Cannot do Getting Started Guide • AWSMarket AWS Marketpla cloud admins map or placeSellerFullAcc ess: assign roles. ce Managemen t Portal. You can also manage the Amazon EC2 AMI used in AMI-based products. • Link AWS customer engagement opportunities with AWS Marketplace private oﬀers. • Associate APN solutions with AWS Marketplace product listings. • Access the Partner Analytics dashboard. Understanding the role permissions 36 AWS Partner Central Standard IAM role AWS Partner Central managed policies used Can do Cannot do Getting Started Guide ACE Team • AWSMarket placeSellerOﬀerMa nagement • Create AWS Marketplace private oﬀers • AWSPartne • Link AWS customer rCentralOpportunit engagement yManagement opportunities with AWS Marketplace • Map or assign IAM roles to AWS Partner Central users. Only alliance leads and cloud admins can map or assign roles. private oﬀers. • Use all the AWS Marketplace tools and features. • Use the Partners Analytics dashboard Creating a permission set for SSO The following steps explain how to use the IAM Identity Center to create a permission set that enables single sign-on for accessing AWS Partner Central. For more information about permission sets, refer to Create a permission set in the AWS IAM Identity Center User Guide. 1. Sign in to the IAM Identity Center console. 2. Under Multi-account permissions, choose Permission sets. 3. Choose Create permission set. 4. On the Select permission set type page, under Permission set type, choose Custom permission set, then choose Next. 5. Do the following: A. On the Specify policies and permission boundary page, choose the types of IAM policies that you want to apply to the permission set. Creating a permission set for SSO 37 AWS Partner Central Getting Started Guide By default, you can add any combination of up to 10 AWS managed policies and customer managed policies to your permission set. IAM sets this quota. To raise it, request an increase to the IAM quota Managed policies attached to an IAM role in the Service Quotas console in each AWS account where you want to assign the permission set. B. Expand Inline policy to add custom JSON-formatted policy text. Inline policies don't correspond to existing IAM resources. To create an inline policy, enter custom policy language in the provided form. IAM Identity Center adds the policy to the IAM resources that it creates in your member accounts. For more information, see Inline policies. C. Copy and paste the JSON policy from AWS Partner Central and AWS Account Linking pre- requisite 6. On the Specify permission set details page, do the following: A. Under Permission set name, type a name to identify this permission set in IAM Identity Center. The name that you specify for this permission set appears in the AWS access portal as an available role. Users sign into the AWS access portal, choose an AWS account, and then choose the role. B. (Optional) You can also type a description. The description appears in the IAM Identity Center console only, not the AWS access portal. C. (Optional) Specify the value for Session duration. This value determines the length of time that a user can be logged on before the console logs them out of their session. For more information, see Set session duration for AWS accounts. D. (Optional) Specify the value for Relay state. This value is used in the federation process to redirect users within the account. For more information, refer to Set relay state for quick access to the AWS Management Console. Note The relay state URL must be within the AWS Management Console. For example: https://console.aws.amazon.com/ec2/ E. Expand Tags (optional), choose Add tag, and then specify values for Key and Value (optional). For information about tags, see Tagging AWS IAM Identity Center resources. F. Choose Next. Creating a permission set for SSO 38 AWS Partner Central Getting Started Guide 7. On the Review and create page, review the selections that you made, and then choose Create. By default, when you create a permission set, the permission set isn't provisioned (used in any AWS accounts). To provision a permission set in an AWS account, you must assign IAM Identity Center access to users and groups in the account, and then apply the permission set to those users and groups. For more information, see Assign user access to AWS accounts in the AWS IAM Identity Center User Guide. Linking AWS Partner Central and AWS accounts The following steps explain how to use AWS Partner Central to link your accounts. You must be an alliance lead or cloud admin
apc-gs-012	apc-gs.pdf	12	By default, when you create a permission set, the permission set isn't provisioned (used in any AWS accounts). To provision a permission set in an AWS account, you must assign IAM Identity Center access to users and groups in the account, and then apply the permission set to those users and groups. For more information, see Assign user access to AWS accounts in the AWS IAM Identity Center User Guide. Linking AWS Partner Central and AWS accounts The following steps explain how to use AWS Partner Central to link your accounts. You must be an alliance lead or cloud admin to complete these steps. Also, the IAM permissions policy listed earlier in this guide controls the linking and role mapping tasks you and other AWS Partner Central users can perform. For more information about those tasks, refer to Granting IAM permissions. For more information about account linking, refer to the Account Linking User Guide in Partner Central. Note • AWS Partner Central uses the term AWS Marketplace Account Linking, but all partners can link accounts, including partners without AWS Marketplace accounts. • Partners in Amazon Web Services India Private Limited (AWS India) can link without registering a business name. 1. Sign in to AWS Partner Central as an alliance lead or cloud admin. Note If your organization uses single sign-on (SSO), use those credentials to sign in to your AWS account ﬁrst, then sign in to AWS Partner Central. 2. In the AWS Marketplace section of the AWS Partner Central home page, choose Link Account. 3. On the AWS Marketplace Account linking page, choose Link Account. 4. On the AWS account sign-in page, choose IAM user. Linking accounts 39 AWS Partner Central Getting Started Guide 5. Enter the ID of the AWS account and sign in. Note • If you need account information, contact the administrator who completed the prerequisites listed above. • SSO users automatically skip to the next step. 6. Navigate through the self-service linking experience: A. Review the AWS account ID and the associated AWS Marketplace seller proﬁle legal name and choose Next. Note If your AWS account is not registered as a seller, provide your legal business name to be registered on AWS Marketplace. Partners in Amazon Web Services India Private Limited (AWS India) can link without registering a business name. Proceed by choosing Next. B. Review the IAM roles and the managed policies attached to them, then choose Next. C. (Optional) To bulk map the IAM roles to the partner users with Alliance team and ACE partner roles, select the checkbox under each role section. A partner user cannot access AWS Marketplace features, such as linking private oﬀers to ACE opportunities, without an IAM role mapped to their partner user account. If you choose not to bulk assign, you must manually map an IAM role to a partner user after linking the accounts. D. Review the information, then choose Submit. You are directed to to AWS Partner Central with your account successfully linked and the default IAM roles created in your account. 7. (Optional) To use custom policies that enable access to AWS Marketplace features within AWS Partner Central, refer to the next topic, Using custom policies to map users. Linking accounts 40 AWS Partner Central Getting Started Guide Using custom policies to map users This section explains how to map AWS Partner Central users to AWS Marketplace AWS IAM roles. Mapping enables single sign-on access for users across AWS Partner Central and AWS Marketplace, plus other features such as product and oﬀer linking. Topics • Role mapping prerequisites • Connecting ACE opportunities with AWS Marketplace private oﬀers Role mapping prerequisites Before mapping, you must complete the following: • Create IAM roles in the AWS Marketplace account. For more ionformation, refer to Create a role using custom trust policies in the AWS Identity and Access Management User Guide. • To allow AWS Partner Central to map AWS Marketplace IAM roles, add the following custom trust policy to the roles. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "partnercentral-account-management.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } • For AWS Partner Central users with the ACE user role, grant permissions to perform the ListEntities and SearchAgreements actions. For more information, refer to Controlling access to AWS Marketplace Management Portal in the AWS Marketplace Seller Guide. • Link your AWS Partner Central account to an AWS Marketplace account. Using custom policies to map users 41 AWS Partner Central Getting Started Guide To map IAM roles to your AWS Partner Central users, you must create IAM roles with the permissions you want to provide to your users. For cloud admin users, you can only map the cloud admin IAM role created in your account during the account linking process. You can create one or multiple IAM roles
apc-gs-013	apc-gs.pdf	13	SearchAgreements actions. For more information, refer to Controlling access to AWS Marketplace Management Portal in the AWS Marketplace Seller Guide. • Link your AWS Partner Central account to an AWS Marketplace account. Using custom policies to map users 41 AWS Partner Central Getting Started Guide To map IAM roles to your AWS Partner Central users, you must create IAM roles with the permissions you want to provide to your users. For cloud admin users, you can only map the cloud admin IAM role created in your account during the account linking process. You can create one or multiple IAM roles to associate with your AWS Partner Central users. The role names must start with PartnerCentralRoleFor. You can't choose a role unless the name begins with that text. You can attach custom or managed policies to the IAM role. You can attach the AWS Marketplace managed policies such as AWSMarketplaceSellerFullAccess to the IAM roles and provide access to your AWS Partner Central users. For more information about creating roles, refer to Creating an IAM role (console) in the IAM User Guide. Connecting ACE opportunities with AWS Marketplace private oﬀers To enable ACE users to attach AWS Marketplace private oﬀers to ACE opportunities, map them to an AWS Marketplace IAM role in AWS Partner Central. Using custom policies to map users 42 AWS Partner Central Prerequisites Getting Started Guide Complete the following before mapping users to AWS Marketplace IAM roles: • When you link an AWS Marketplace account to AWS Partner Central, provide AWSMarketplaceSellerFullAccess or, minimally, ListEntities/SearchAgreements to the IAM role assigned to ACE users. This is required to enable ACE users to attach AWS Marketplace private oﬀers to ACE opportunities. • (Optional) To grant minimal permission, add a customer managed policy to your AWS account and to the IAM role you create for ACE managers and users. Refer to the following policy as an example: { "Version": "2012-10-17", "Statement": [ { "Action": [ "aws-marketplace:SearchAgreements", "aws-marketplace:DescribeAgreement", "aws-marketplace:GetAgreementTerms", "aws-marketplace:ListEntities", "aws-marketplace:DescribeEntity", "aws-marketplace:StartChangeSet" ], "Effect": "Allow", "Resource": "*", "Condition": { "StringEquals": { "aws-marketplace:PartyType": "Proposer" }, "ForAllValues:StringEquals": { "aws-marketplace:AgreementType": [ "PurchaseAgreement" ] } } } ] } Using custom policies to map users 43 AWS Partner Central Getting Started Guide Mapping users to AWS Marketplace IAM roles Use the procedures in this section to map and unmap AWS Partner Central users to AWS Marketplace IAM roles. To map an AWS Partner Central user to an AWS Marketplace IAM role 1. 2. Sign in to AWS Partner Central as a user with the alliance lead or cloud admin role. In the Account linking section of the AWS Partner Central homepage, choose Manage linked account. 3. In the Non-cloud admin users section of the Account Linking page, choose a user. 4. Choose Map to IAM role. 5. Choose an IAM role from the dropdown list. 6. Choose Map role. To ummap an AWS Partner Central user from an AWS Marketplace IAM role. 1. 2. 3. Sign in to AWS Partner Central as a user with the alliance lead or cloud admin role. In the Account linking section of the AWS Partner Central homepage, choose Manage linked account. In the Non-cloud admin users section of the Account Linking page, choose the user you want to unmap. 4. Choose Unmap role. Unlinking AWS Partner Central and AWS accounts To unlink an AWS account from AWS Partner Central, you ﬁle a support request. Remember the following: • Resolving an unlinking request cancels that request. • You can't link to a AWS Marketplace account while the unlinking request is in progress. • You can't map IAM roles or link products and private oﬀers in Partner Central while the request is in progress. Unlinking accounts 44 AWS Partner Central To request unlinking Getting Started Guide 1. Sign in to AWS Partner Central as an alliance lead or cloud administrator. 2. Under Account linking, choose Manage linked account. 3. Choose Unlink account. 4. Review the warning message and select a reason for unlinking your account. 5. Enter confirm and choose Open support case. 6. On the conﬁrmation banner, choose View case details to track the progress of your request. Account linking FAQ The following topics answer frequently asked questions about linking AWS Partner Central accounts with other AWS accounts. Which IAM policies should I use? You use AWS managed policies for the account linking prerequisites. By default, account linking uses AWS managed policies to assign IAM roles during account linking. However, IT admins can use custom AWS Marketplace policies to assign IAM roles to AWS Partner Central users such as an ACE team. The roles enable users to link ACE opportunities with AWS Marketplace private oﬀers. For more information, refer to Using custom policies to map users later in this guide. The links in the following list take you to the AWS Managed Policy
apc-gs-014	apc-gs.pdf	14	accounts with other AWS accounts. Which IAM policies should I use? You use AWS managed policies for the account linking prerequisites. By default, account linking uses AWS managed policies to assign IAM roles during account linking. However, IT admins can use custom AWS Marketplace policies to assign IAM roles to AWS Partner Central users such as an ACE team. The roles enable users to link ACE opportunities with AWS Marketplace private oﬀers. For more information, refer to Using custom policies to map users later in this guide. The links in the following list take you to the AWS Managed Policy Reference. AWS managed policies • AWSPartnerCentralFullAccess: – Provides full access to AWS Partner Central; features and related AWS services. • AWSPartnerCentralOpportunityManagement: – Provides necessary access for opportunity management activities. • AWSMarketplaceSellerOﬀerManagement: – Enables seller access to oﬀer and agreement management activities. For more information about the AWS Partner Central managed policies, refer to Account linking FAQ 45 AWS Partner Central Getting Started Guide An AWS managed policy is a standalone policy created and administered by AWS. AWS managed policies provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your speciﬁc use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by deﬁning customer managed policies speciﬁc to your use cases. For more information, refer to AWS managed policies. The AWS managed policies described in this section manage AWS Partner Central users' access to AWS Marketplace. For more information about AWS Marketplace seller policies, refer to AWS managed policies for AWS Marketplace sellers. Topics • AWS managed policy: AWSPartnerCentralFullAccess • AWS managed policy: PartnerCentralAccountManagementUserRoleAssociation • AWS managed policy: AWSPartnerCentralOpportunityManagement • AWS managed policy: AWSPartnerCentralSandboxFullAccess • AWS managed policy: AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy • AWS Partner Central updates to AWS managed policies AWS managed policy: AWSPartnerCentralFullAccess You can attach the AWSPartnerCentralFullAccess policy to your IAM identities. This policy grants full access to AWS Partner Central and related AWS services. To view the permissions for this policy, see AWSPartnerCentralFullAccess in the AWS Managed Policy Reference. AWS managed policy: PartnerCentralAccountManagementUserRoleAssociation You can attach the PartnerCentralAccountManagementUserRoleAssociation policy to your IAM identities. This policy is used by a partner cloud admin to manage IAM roles linked to partner users. AWSPartnerCentralFullAccess 46 AWS Partner Central Getting Started Guide This policy allows the following operations: • List all roles. • Pass an IAM role with the name preﬁx PartnerCentralRoleFor to the AWS Partner Central account management service. • Associate a AWS Partner Central user with an IAM role. • Disassociate a AWS Partner Central user from an IAM role. To view the permissions for this policy, see PartnerCentralAccountManagementUserRoleAssociation in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralOpportunityManagement You can attach the AWSPartnerCentralOpportunityManagement policy to your IAM identities. This policy grants full access to manage opportunities in AWS Partner Central. To view the permissions for this policy, see AWSPartnerCentralOpportunityManagement in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSandboxFullAccess You can attach the AWSPartnerCentralSandboxFullAccess policy to your IAM identities. This policy grants access for developer testing in the Sandbox catalog. To view the permissions for this policy, see AWSPartnerCentralSandboxFullAccess in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy You can attach the AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy policy to your IAM identities. AWSPartnerCentralOpportunityManagement 47 AWS Partner Central Getting Started Guide This policy provides the ResourceSnapshotJob with permission to read a resource and snapshot it in the target environment. For more information on how to use this policy, see Working with multi- partner opportunities in the AWS Partner Central API Reference. To view the permissions for this policy, see AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy in the AWS Managed Policy Reference. AWS Partner Central updates to AWS managed policies View details about updates to AWS managed policies for AWS Partner Central since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the AWS Partner Central Document history for the AWS Partner Central Getting Started Guide page. AWSPartnerCentralFullAccess — Update to an existing AWS Partner Central updated a policy. December 4, 2024 policy AWSPartnerCentralO pportunityManagement — AWS Partner Central updated a policy. December 4, 2024 Update to an existing policy AWSPartnerCentralS andboxFullAccess — Update AWS Partner Central updated a policy. December 4, 2024 to an existing policy AWSPartnerCentralSellingRes ourceSnapshotJobEx AWS Partner Central added a new policy to grant access ecutionRolePolicy — New to read resources and create policy snapshots. December 4, 2024 AWSPartnerCentralFullAccess – New policy AWS Partner Central added a new policy to grant full access November 18, 2024 to the AWS Partner Central service. Policy updates 48 AWS Partner Central Getting Started Guide AWSPartnerCentralO pportunityManagement — AWS Partner Central added a new policy to grant full access
apc-gs-015	apc-gs.pdf	15	updated a policy. December 4, 2024 Update to an existing policy AWSPartnerCentralS andboxFullAccess — Update AWS Partner Central updated a policy. December 4, 2024 to an existing policy AWSPartnerCentralSellingRes ourceSnapshotJobEx AWS Partner Central added a new policy to grant access ecutionRolePolicy — New to read resources and create policy snapshots. December 4, 2024 AWSPartnerCentralFullAccess – New policy AWS Partner Central added a new policy to grant full access November 18, 2024 to the AWS Partner Central service. Policy updates 48 AWS Partner Central Getting Started Guide AWSPartnerCentralO pportunityManagement — AWS Partner Central added a new policy to grant full access November 14, 2024 New policy to manage opportunities in AWS Partner Central. AWSPartnerCentralS andboxFullAccess — New AWS Partner Central added a new policy to grant access November 14, 2024 policy for developer testing in the Sandbox catalog. AWS Partner Central started tracking changes AWS Partner Central started tracking changes for its AWS November 14, 2024 managed policies. Change Description Date later in this guide. For more information about the AWS Marketplace managed policy, refer to AWS managed policies for AWS Marketplace sellers in the AWS Marketplace Seller Guide. Custom AWS Marketplace policies • aws-marketplace:ListEntities and aws-marketplace:SearchAgreements – Enables users to link ACE opportunities and AWS Marketplace private oﬀers. • aws-marketplace:GetSellerDashboard: – Grants access to the AWS Partner Central & Marketplace dashboard. For more information about the custom AWS Marketplace policies, refer to Policies and permissions for AWS Marketplace sellers in the AWS Marketplace Seller Guide. Why can’t I complete account linking? I have alliance lead privileges You must have the alliance lead or cloud admin role, not the privileges. How do I unlink accounts? Policy updates Follow the steps in Unlinking AWS Partner Central and AWS accounts earlier in this guide. 49 AWS Partner Central Getting Started Guide What happens to linked ACE opportunities + MPPO if I unlink an account? If you unlink and re-link to a diﬀerent AWS Marketplace seller or AWS account, linked objects disappear. If a partner re-links to the same AWS Marketplace seller or AWS account, linked objects remain. How can I manage partner user access to a linked account? Alliance leads use AWS Partner Central User Management to assign IAM roles to AWS Partner Central users and grant them access to a linked account. They can also remove the mapped roles to remove access a linked account. In addition, each standard IAM role created during account linking comes with limited permissions. For more information about them, refer to Understanding the role permissions earlier in this guide. Selecting the PartnerCentralAceRole checkbox created 3 roles. Why? You use that option to bulk assign IAM roles to the Alliance, Cloud Admin, and ACE teams. The linking process creates the roles. Partners can use the IAM console to delete unwanted roles. For more information, refer to Updated Account Linking User Guide in AWS Partner Central. Why can't we register our legal business name during account linking? Ensure you submitted an accurate account name. The AWS ID you select may already be in use, and it cannot be shared by multiple parties, especially if your company is merging. For guidance on what to during a merger, refer to: • AWS Partners M&A Policy and FAQs • How do I merge AWS Partner Central accounts? Why do I get the “Missing IAM Role Mapping”, “Missing Permission”, “Access denied”, and “Your AWS Marketplace IAM role does not have the required permissions” errors? The messages appear for the following reasons: • An AWS Partner Central user wasn't mapped to an IAM role. Ask the alliance lead or cloud admin to map the appropriate role to the user. For more information, refer to the AWS Partner Central & AWS account linking guide. Policy updates 50 AWS Partner Central Getting Started Guide • AWS Partner Central users with mapped IAM roles need to update their existing policies. For more information about the latest prerequisites, refer to Prerequisites earlier in this guide. Can I associate AWS Marketplace private oﬀers and Channel Partner private oﬀers with ACE opportunities? Yes, but you must link accounts ﬁrst. You use AWS Partner Central to associate AWS Marketplace private oﬀers with ACE opportunities. You use Partner Connections to associate Channel Partner private oﬀers with ACE opportunities. Both methods require account linking before you can use them. For more information, refer to Partner Connections in the AWS Partner Central Sales Guide. Policy updates 51 AWS Partner Central Getting Started Guide Mapping AWS Marketplace roles to a CRM integration user This section explains how to map AWS Marketplace AWS Identity and Access Management (IAM) roles to your CRM integration service user on AWS Partner Central. Mapping enables the CRM Integration service user to perform actions on the AWS Marketplace account. Selecting an IAM role to access AWS Marketplace APIs through CRM integration
apc-gs-016	apc-gs.pdf	16	Partner private oﬀers with ACE opportunities. Both methods require account linking before you can use them. For more information, refer to Partner Connections in the AWS Partner Central Sales Guide. Policy updates 51 AWS Partner Central Getting Started Guide Mapping AWS Marketplace roles to a CRM integration user This section explains how to map AWS Marketplace AWS Identity and Access Management (IAM) roles to your CRM integration service user on AWS Partner Central. Mapping enables the CRM Integration service user to perform actions on the AWS Marketplace account. Selecting an IAM role to access AWS Marketplace APIs through CRM integration enables features such as linking AWS Marketplace private oﬀers to ACE opportunities. Before mapping, you must ﬁrst complete the following: • Create IAM roles in the AWS Marketplace account. • While creating IAM roles, add the following custom trust policy to allow AWS Partner Central to map the IAM roles. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "partnercentral-account-management.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } • Grant permissions to perform the ListEntities and SearchAgreements actions. For more information, refer to Controlling access to AWS Marketplace Management Portal. • Link your AWS Partner Central account to an AWS Marketplace account. To map an AWS Marketplace IAM role to a CRM integration user 1. 2. Sign in to AWS Partner Central as a user with the alliance lead or cloud admin role. In the AWS Marketplace section of the AWS Partner Central homepage, choose Manage Linked Account. 52 AWS Partner Central Getting Started Guide 3. On the AWS Marketplace page, in the IAM role for CRM integration section, choose Map IAM role. 4. Choose an IAM role from the dropdown list. 5. Choose Map role. To unmap an AWS Marketplace IAM role from a CRM integration user. 1. 2. Sign in to AWS Partner Central as a user with the alliance lead or cloud admin role. In the AWS Marketplace section of the AWS Partner Central homepage, choose Manage Linked Account. 3. On the AWS Marketplace page, in the IAM role for CRM integration section, choose Unmap IAM role. 53 AWS Partner Central Getting Started Guide AWS managed policies for AWS Partner Central users An AWS managed policy is a standalone policy created and administered by AWS. AWS managed policies provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your speciﬁc use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by deﬁning customer managed policies speciﬁc to your use cases. For more information, refer to AWS managed policies. The AWS managed policies described in this section manage AWS Partner Central users' access to AWS Marketplace. For more information about AWS Marketplace seller policies, refer to AWS managed policies for AWS Marketplace sellers. Topics • AWS managed policy: AWSPartnerCentralFullAccess • AWS managed policy: PartnerCentralAccountManagementUserRoleAssociation • AWS managed policy: AWSPartnerCentralOpportunityManagement • AWS managed policy: AWSPartnerCentralSandboxFullAccess • AWS managed policy: AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy • AWS Partner Central updates to AWS managed policies AWS managed policy: AWSPartnerCentralFullAccess You can attach the AWSPartnerCentralFullAccess policy to your IAM identities. This policy grants full access to AWS Partner Central and related AWS services. To view the permissions for this policy, see AWSPartnerCentralFullAccess in the AWS Managed Policy Reference. AWSPartnerCentralFullAccess 54 AWS Partner Central Getting Started Guide AWS managed policy: PartnerCentralAccountManagementUserRoleAssociation You can attach the PartnerCentralAccountManagementUserRoleAssociation policy to your IAM identities. This policy is used by a partner cloud admin to manage IAM roles linked to partner users. This policy allows the following operations: • List all roles. • Pass an IAM role with the name preﬁx PartnerCentralRoleFor to the AWS Partner Central account management service. • Associate a AWS Partner Central user with an IAM role. • Disassociate a AWS Partner Central user from an IAM role. To view the permissions for this policy, see PartnerCentralAccountManagementUserRoleAssociation in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralOpportunityManagement You can attach the AWSPartnerCentralOpportunityManagement policy to your IAM identities. This policy grants full access to manage opportunities in AWS Partner Central. To view the permissions for this policy, see AWSPartnerCentralOpportunityManagement in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSandboxFullAccess You can attach the AWSPartnerCentralSandboxFullAccess policy to your IAM identities. This policy grants access for developer testing in the Sandbox catalog. PartnerCentralAccountManagementUserRoleAssociation 55 AWS Partner Central Getting Started Guide To view the permissions for this policy, see AWSPartnerCentralSandboxFullAccess in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy You can attach the AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy policy to your IAM identities. This policy provides the ResourceSnapshotJob with permission to read a resource and snapshot it in the target environment. For more information on how to use this policy, see Working with multi-
apc-gs-017	apc-gs.pdf	17	AWSPartnerCentralOpportunityManagement in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSandboxFullAccess You can attach the AWSPartnerCentralSandboxFullAccess policy to your IAM identities. This policy grants access for developer testing in the Sandbox catalog. PartnerCentralAccountManagementUserRoleAssociation 55 AWS Partner Central Getting Started Guide To view the permissions for this policy, see AWSPartnerCentralSandboxFullAccess in the AWS Managed Policy Reference. AWS managed policy: AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy You can attach the AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy policy to your IAM identities. This policy provides the ResourceSnapshotJob with permission to read a resource and snapshot it in the target environment. For more information on how to use this policy, see Working with multi- partner opportunities in the AWS Partner Central API Reference. To view the permissions for this policy, see AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy in the AWS Managed Policy Reference. AWS Partner Central updates to AWS managed policies View details about updates to AWS managed policies for AWS Partner Central since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the AWS Partner Central Document history for the AWS Partner Central Getting Started Guide page. Change Description Date AWSPartnerCentralFullAccess — Update to an existing policy AWSPartnerCentralO pportunityManagement — Update to an existing policy AWS Partner Central updated a policy. December 4, 2024 AWS Partner Central updated a policy. December 4, 2024 AWSPartnerCentralS andboxFullAccess — Update AWS Partner Central updated a policy. December 4, 2024 to an existing policy AWSPartnerCentralSellingResourceSnapshotJobExecutionRolePolicy 56 AWS Partner Central Getting Started Guide Change Description Date AWSPartnerCentralSellingRes ourceSnapshotJobEx AWS Partner Central added a new policy to grant access ecutionRolePolicy — New to read resources and create policy snapshots. December 4, 2024 AWSPartnerCentralFullAccess – New policy AWS Partner Central added a new policy to grant full access November 18, 2024 to the AWS Partner Central service. AWSPartnerCentralO pportunityManagement — New policy AWS Partner Central added a new policy to grant full access to manage opportunities in November 14, 2024 AWSPartnerCentralS andboxFullAccess — New policy AWS Partner Central. AWS Partner Central added a new policy to grant access for developer testing in the Sandbox catalog. November 14, 2024 AWS Partner Central started tracking changes AWS Partner Central started tracking changes for its AWS November 14, 2024 managed policies. Policy updates 57 AWS Partner Central Getting Started Guide Controlling access in AWS Partner Central account management AWS Identity and Access Management (IAM) is an AWS service you can use at no additional charge that helps you control access to AWS resources. AWS Partner Central account management uses IAM for AWS Partner Central authentication and authorization. Administrators can use IAM roles to control who can sign in to AWS Partner Central and what AWS Partner Central permissions they have. Important AWS Partner Central users that you create authenticate using their credentials. However, they must use the same AWS account. Any change a user makes can impact the entire account. For more information about available actions, resources, and condition keys, refer to Actions, resources, and condition keys for AWS services. Topics • Permissions for AWS Partner Central account management • Additional resources Permissions for AWS Partner Central account management You can use the following permissions in IAM policies for AWS Partner Central account management. You can combine permissions into a single IAM policy to grant the permissions you want. AssociatePartnerAccount AssociatePartnerAccount provides access to associate AWS Partner Central and AWS accounts. • Action groups: ReadWrite Permissions for AWS Partner Central account management 58 AWS Partner Central Getting Started Guide • Required resources: Does not support specifying a resource Amazon Resource Number (ARN) in the Resource element of an IAM policy statement. To allow access, specify "Resource": "" in your policy. AssociatePartnerUser AssociatePartnerUser provides access to associate AWS Partner Central users and IAM roles. • Action groups: ReadWrite • Required resources: Does not support specifying a resource Amazon Resource Number (ARN) in the Resource element of an IAM policy statement. To allow access, specify "Resource": "" in your policy. AssociatePartnerUser 59 AWS Partner Central Getting Started Guide DisassociatePartnerUser DisassociatePartnerUser provides access to associate AWS Partner Central users and IAM roles. • Action groups: ReadWrite • Required resources: Does not support specifying a resource Amazon Resource Number (ARN) in the Resource element of an IAM policy statement. To allow access, specify "Resource": "*" in your policy. Additional resources Refer to the following sections of the IAM User Guide for more information: • Security best practices in IAM • Managing IAM policies • Attaching a policy to an IAM user group • IAM identities (users, user groups, and roles) • Controlling access to AWS resources using policies DisassociatePartnerUser 60 AWS Partner Central Getting Started Guide Logging AWS Partner Central API calls with AWS CloudTrail AWS Partner Central is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in
apc-gs-018	apc-gs.pdf	18	access, specify "Resource": "*" in your policy. Additional resources Refer to the following sections of the IAM User Guide for more information: • Security best practices in IAM • Managing IAM policies • Attaching a policy to an IAM user group • IAM identities (users, user groups, and roles) • Controlling access to AWS resources using policies DisassociatePartnerUser 60 AWS Partner Central Getting Started Guide Logging AWS Partner Central API calls with AWS CloudTrail AWS Partner Central is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in AWS Partner Central. CloudTrail captures calls from the AWS Partner Central console and code calls to the AWS Partner Central API operations as events. CloudTrail is active in your AWS account when you create it and doesn't require any manual setup. Supported event activity in AWS Partner Central is recorded in a CloudTrail event, along with other AWS service events, on the Event history page of the CloudTrail console. There you can view, search, and download events in your AWS account. Every event or log entry contains the identity of the user who generated the request. This information helps you determine if the request was made by any of the following: • A user with root or AWS Identity and Access Management user credentials. • A user with temporary security credentials for a role, or a federated user. • Another AWS service. AWS Partner Central supports logging the partnerCentralAccountManagement operation as events in CloudTrail log ﬁles with eventSource partnercentral-account- management.amazonaws.com Topics • AWS Partner Central log ﬁle entry examples • Related topics 61 AWS Partner Central Getting Started Guide AWS Partner Central log ﬁle entry examples Example: AssociatePartnerAccount { "eventVersion":"1.08", "userIdentity":{ "type":"IAMUser", "principalId":"EX_PRINCIPAL_ID", "arn":"arn:aws:iam::123456789012:user/Alice", "accountId":"123456789012", "accessKeyId":"EXAMPLE_KEY_ID", "userName":"Alice" }, "eventTime":"2023-10-11T20:57:35Z", "eventSource":"partnercentral-account-management.amazonaws.com", "eventName":"AssociatePartnerAccount", "awsRegion":"us-east-1", "sourceIPAddress":"192.0.0.2/24", "userAgent":"Mozilla/5.0", "requestParameters":{ "value":"HIDDEN_DUE_TO_SECURITY_REASONS" }, "responseElements":null, "requestID":"F9PAD7MAYFGV73S4T7B3", "eventID":"fe2a5873-773c-462a-b7c8-810d224de821", "readOnly":false, "eventType":"AwsApiCall", "managementEvent":true, "recipientAccountId":"123456789012", "eventCategory":"Management" } AWS Partner Central log ﬁle entry examples 62 AWS Partner Central Getting Started Guide Example: DisassociatePartnerUser { "eventVersion":"1.09", "userIdentity":{ "type":"AssumedRole", "principalId":"EX_PRINCIPAL_ID", "arn":"arn:aws:iam::123456789012:role/PartnerCentralRoleForCloudAdmin-1234", "accountId":"123456789012", "accessKeyId":"EXAMPLE_KEY_ID", "invokedBy":"partnercentral-account-management.amazonaws.com" }, "eventTime":"2023-10-11T20:57:35Z", "eventSource":"partnercentral-account-management.amazonaws.com", "eventName":"AssociatePartnerUser", "awsRegion":"us-east-1", "sourceIPAddress":"partnercentral-account-management.amazonaws.com", "userAgent":"partnercentral-account-management.amazonaws.com", "requestParameters":{ "partnerUserId":"005123456789012345", "iamRoleArn":"arn:aws:iam::123456789012:role/PartnerCentralRoleForUser-1234", "partnerAccountId":"1234567" }, "responseElements":null, "requestID":"655832a6-8452-4088-9a0f-17212fa55765", "eventID":"f7394769-4a3b-4101-9b00-ee0b86a77d89", "readOnly":false, "eventType":"AwsApiCall", "managementEvent":true, "recipientAccountId":"123456789012", "eventCategory":"Management" } Related topics For more information, refer to the following sections in the AWS CloudTrail User Guide: • Creating a trail for your AWS account • AWS service integrations with CloudTrail logs • Conﬁguring Amazon SNS notiﬁcations for CloudTrail Related topics 63 AWS Partner Central Getting Started Guide • Receiving CloudTrail log ﬁles from multiple Regions • CloudTrail userIdentity element Related topics 64 AWS Partner Central Getting Started Guide User management In AWS Partner Central, you provide users speciﬁc permissions by assigning them roles. A user can only access the AWS Partner Central resources permitted by their roles. Review the topics in this section to learn about role capabilities, assigning roles, and user management. Topics • AWS Partner Central roles • Managing users and role assignments • AWS Partner Central permissions best practices • Multi-factor authentication (MFA) 65 AWS Partner Central Getting Started Guide AWS Partner Central roles An AWS Partner Central role is an identity with speciﬁc permissions in AWS Partner Central. You can assign a new user a role when you invite them to register, and change role assignments on the User management page. This section describes roles and compares role capabilities. Topics • Alliance lead • Alliance team • Standard user • Channel user • Cloud admin • Marketing staﬀ • Technical staﬀ • ACE manager • ACE user • Role comparison AWS Partner Central roles 66 AWS Partner Central Alliance lead Getting Started Guide When you create an AWS Partner Central account, you begin with one role that has complete access to all resources in the account: the alliance lead. The ﬁrst user to create an account for your company is automatically assigned the alliance lead role. Only one user in your company account can be the alliance lead at one time. Only the alliance lead can reassign the role to another user. The alliance lead is your company's primary account administrator. They should have a business development or business leadership role with legal authority to accept the AWS Partner Network terms and conditions on behalf of your company. The alliance lead role can do the following: • View and manage all of your company's account information in AWS Partner Central. • Manage partner account information, including the partner scorecard, account details, and listing in the AWS Partner Solutions Finder (for eligible AWS Partners only). • Assign alliance team, ACE manager, ACE user, technical staﬀ, or marketing staﬀ roles to other users in your AWS Partner account. • Remove users. • Reassign the alliance lead role to another user. • View certiﬁcation details. • View and edit opportunities and leads in ACE Pipeline Manager. Alliance
apc-gs-019	apc-gs.pdf	19	behalf of your company. The alliance lead role can do the following: • View and manage all of your company's account information in AWS Partner Central. • Manage partner account information, including the partner scorecard, account details, and listing in the AWS Partner Solutions Finder (for eligible AWS Partners only). • Assign alliance team, ACE manager, ACE user, technical staﬀ, or marketing staﬀ roles to other users in your AWS Partner account. • Remove users. • Reassign the alliance lead role to another user. • View certiﬁcation details. • View and edit opportunities and leads in ACE Pipeline Manager. Alliance team The alliance team role shares administrative responsibility with the alliance lead. They serve as a secondary point of contact for communication regarding your company’s AWS Partner Network membership. An alliance team user supports the alliance lead by managing opportunities and leads in the ACE Pipeline Manager, submitting program applications, and monitoring your Partner scorecard. The alliance lead can assign the alliance team role to up to 20 users. The alliance team user can do the following: • Manage partner account information, including the partner scorecard, account details, and listing in the AWS Partner Solutions Finder (for eligible partners only). • Assign alliance team, ACE manager, ACE user, technical staﬀ, or marketing staﬀ roles to other users in your account. Alliance lead 67 AWS Partner Central • View certiﬁcation details. • View and edit opportunities and leads in ACE Pipeline Manager. • Remove users. Getting Started Guide Alliance team 68 AWS Partner Central Standard user Getting Started Guide The standard user role can sign in to your AWS Partner Central account, update personal information, and complete AWS training and certiﬁcation courses. Alliance lead and alliance team users can grant standard users access to more resources by assigning them a diﬀerent role. Channel user The channel user role is for users who help administer AWS Marketplace Channel Programs and report AWS accounts used for reselling. This role is necessary for users responsible for updating end-user information and program-management accounts on behalf of your organization. You can assign any number of users the channel user role. In addition to standard user role permissions, the channel user can access the Channel Management page. Cloud admin The user with the cloud admin role is your company's Identity and Access Management (IAM) administrator of your AWS accounts and the primary point of contact for AWS Marketplace. The alliance lead can assign multiple users to the cloud admin role. Only alliance lead or cloud admin users can reassign the cloud admin role to another user. The alliance lead user may assign themselves the cloud admin role to link AWS Partner Central and AWS Marketplace accounts. When you link your AWS Partner Central account to an AWS Marketplace seller account, AWS Marketplace creates an IAM role called cloud admin in your account. It makes you the cloud admin role by default (if you were not already) and associates the cloud admin IAM role to your AWS Partner Central account. The cloud admin role has IAM permissions to map AWS Partner Central users to IAM roles. Standard user 69 AWS Partner Central Getting Started Guide Cloud admin role IAM permissions The cloud admin role has the following IAM permissions { "Version": "2012-10-17", "Statement": [ { "Sid": "PassPartnerCentralRole", "Effect": "Allow", "Action": [ "iam:PassRole" ], "Resource": "arn:aws:iam:::role/PartnerCentralRoleFor", "Condition": { "StringEquals": { "iam:PassedToService": "Partnercentral-account-management.amazonaws.com" } } }, { "Sid": "PartnerUserRoleAssociation", "Effect": "Allow", "Action": [ "iam:ListRoles", "Partnercentral-account-management:AssociatePartnerUser", "Partnercentral-account-management:DisassociatePartnerUser" ], "Resource": "*" } ] } Cloud admin 70 AWS Partner Central Marketing staﬀ Getting Started Guide The marketing staﬀ role can view and edit all areas of AWS Partner Central with marketing components, such as AWS Partner Marketing Central, AWS Partner Network (APN) Badge Manager, AWS Partner Solutions Finder, and AWS Partner References. Marketing staﬀ users have a top of funnel view of leads and campaigns by AWS Region and campaign type. The role helps users identify the most eﬀective marketing channels and prioritize market development fund (MDF) utilization. In addition, marketing staﬀ users can participate in lead and opportunity management and provide details on the AWS Partner Program application to earn designations. The alliance lead can assign any number of users the marketing staﬀ role. The marketing staﬀ role is ideal for users responsible for promotional campaigns or branding, such as: • Members of a marketing team that build awareness for customer acquisition, maturation, and expansion based on Partner technical business strategies. • Members of a marketing coordinator team responsible for operational marketing needs and editing campaign and lead-generation information. The marketing staﬀ role can do the following: • Access AWS training and certiﬁcation courses. • Submit case studies. • Access AWS Partner Marketing Central and AWS sponsorships. • Create and build using the APN Marketing Toolkit. • Create and edit your
apc-gs-020	apc-gs.pdf	20	marketing staﬀ role. The marketing staﬀ role is ideal for users responsible for promotional campaigns or branding, such as: • Members of a marketing team that build awareness for customer acquisition, maturation, and expansion based on Partner technical business strategies. • Members of a marketing coordinator team responsible for operational marketing needs and editing campaign and lead-generation information. The marketing staﬀ role can do the following: • Access AWS training and certiﬁcation courses. • Submit case studies. • Access AWS Partner Marketing Central and AWS sponsorships. • Create and build using the APN Marketing Toolkit. • Create and edit your company listing in the AWS Partner Solutions Finder. • View and edit public references. • Use APN Badge Manager. • View and edit leads and opportunities managed by the marketing staﬀ role. • Create and edit program applications. Marketing staﬀ 71 AWS Partner Central Technical staﬀ Getting Started Guide The technical staﬀ role can view and edit all AWS Partner Central resources with technical components, such as oﬀerings, case studies, and Well-Architected workloads. AWS Partner Central provides these users with access to resources that build their AWS technical knowledge, including personalized recommendations on relevant training and certiﬁcations that match the organization’s proﬁle and market needs. Technical staﬀ users can participate in technical reviews of your organization's oﬀerings and provide details on your AWS Partner program application to earn designations. The alliance lead can assign any number of users the technical staﬀ role. The technical staﬀ role is for users who need to submit opportunities to AWS through the ACE Pipeline Manager and manage those opportunities throughout their lifecycle. This role is the best option for users responsible for managing a set of opportunities or leads without access to view or edit entries owned by other users. For example: • Members of a product development team that build awareness for customer acquisition, maturation, and expansion based on Partner technical business strategies. • Members of a presales technical team responsible for delivering proof-of-concept projects, managing implementations, and professional service engagements. • Members of a technical team responsible for technical guidance for customer solutions including architecture, applications, software, and services. The technical staﬀ role can do the following: • Access training and certiﬁcation courses. • Build oﬀerings. • Build technical validations. • Build case studies. • Build device listings. • Build Well-Architected workloads. • Create and edit program applications. Technical staﬀ 72 AWS Partner Central ACE manager Getting Started Guide The APN Customer Engagements (ACE) manager role can view and edit opportunities and leads in the ACE Pipeline Manager. Additionally, When AWS shares a lead with a partner, or requires more information about a partner-submitted opportunity, the ACE manager receives an automated email notiﬁcation. The alliance lead can assign the ACE manager role to up to 20 users. The ACE manager role is the ideal option for users responsible for managing or overseeing all AWS leads and opportunities in your organization without the additional access provided by the alliance team role. For example: • Members of an operations team that manage data input and opportunities for sales teams. • Members of a sales team that enter and manage lead and opportunity data. • Members of a marketing team who want to oversee lead activity. The ACE manager role provides users access to update all opportunities and leads in the ACE Pipeline Manager. It is important that new users review the ACE program documentation available on AWS Partner Central. For users who only need to manage the opportunities they actively own, the ACE user role is a more appropriate assignment. The ACE manager role can do the following: • Submit opportunities. • View or edit opportunities submitted by all users. • Accept, reject, view, and edit all opportunities and leads shared with all users. • Transfer ownership of all opportunities and leads to other users. • Perform bulk imports, exports, updates, and transfers of all opportunities and bulk exports and transfers of all leads. • Update leads and opportunities on behalf of sales teams. • Download pipeline data to create reports. ACE manager 73 AWS Partner Central ACE user Getting Started Guide The ACE user role can access the My Customers tab in Partner Central to submit opportunities to the ACE Pipeline Manager. ACE users can access and manage only the opportunities and leads that they own. You can assign any number of users the ACE user role. The ACE user role is for users who need to submit opportunities to AWS through the ACE Pipeline Manager and manage those opportunities throughout their lifecycle. This role is the best option for users responsible for managing a set of opportunities or leads without access to view or edit entries owned by other users. To enable ACE users to link ACE opportunities to AWS Marketplace private
apc-gs-021	apc-gs.pdf	21	Central to submit opportunities to the ACE Pipeline Manager. ACE users can access and manage only the opportunities and leads that they own. You can assign any number of users the ACE user role. The ACE user role is for users who need to submit opportunities to AWS through the ACE Pipeline Manager and manage those opportunities throughout their lifecycle. This role is the best option for users responsible for managing a set of opportunities or leads without access to view or edit entries owned by other users. To enable ACE users to link ACE opportunities to AWS Marketplace private oﬀers, provide AWSMarketplaceSellerFullAccess or, minimally, ListEntities/SearchAgreements to the IAM role assigned to ACE users. For more information, refer to Linking AWS Partner Central and AWS accounts. The ACE user role can do the following: • Submit opportunities. • View, edit, and update owned opportunities. • Transfer owned opportunities and leads to other users. • Perform bulk imports, exports, updates, and transfers of owned opportunities and bulk transfers of owned leads. ACE user 74 AWS Partner Central Role comparison Getting Started Guide Your role determines your access to AWS Partner Central resources and ability to perform tasks. The following table compares role abilities. It does not include the Standard user role, which has limited access in AWS Partner Central. A user with the standard user role can sign in, access their personal proﬁle, and access AWS training courses. Task Alliance lead Alliance team Cloud admin Marketing staﬀ Technical staﬀ ACE manager ACE user Reassign alliance lead role Assign ACE manager, ACE user, marketing staﬀ, and technical staﬀ roles Remove users Submit ACE opportunities Manage all ACE opportunities and leads Manage owned ACE opportuni ties and leads Manage AWS Partner Solution Finder listing X X X X X X X X X X X X X X X X X X X X X X X Role comparison 75 AWS Partner Central Task Access training and certiﬁcation data Apply to an AWS Competency Program Manage oﬀerings Build Well- Architected workloads Build case studies Build with the APN Marketing Toolkit Manage public references Access APN Badge Manager Manage program applications Alliance lead Alliance team Cloud admin Marketing staﬀ Technical staﬀ ACE manager ACE user Getting Started Guide X X X X X X X X X X X X X X X X X X X X X X X X X X X X Role comparison 76 AWS Partner Central Getting Started Guide Managing users and role assignments On the User management page, you can manage AWS Partner Central users, role assignments, and AWS Identity and Access Management (IAM) role mapping. Topics • Managing role assignments • Reassigning the alliance lead role • Mapping users to IAM roles • Removing users • Managing your proﬁle Managing role assignments On the Users tab of the User management page, you can manage role assignments for up to 10 users at a time. For best practices regarding role assignments, refer to AWS Partner Central permissions best practices. Note These instructions do not apply to the reassignment of the alliance lead role. To reassign the alliance lead role, refer to Reassigning the alliance lead role. To assign, reassign, or remove roles 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Users tab. 4. In user list, select the check box next to the user name of the user you want to manage. You can choose up to 10 users. 5. Choose Manage roles. 6. In the Role assignments section, each user you selected displays in its own row. For each user, the roles they currently have display below the Role ﬁeld. Managing users and role assignments 77 AWS Partner Central Getting Started Guide • To assign a new role to a user – To the right of the user name, choose a role from the Role(s) dropdown list. • To unassign a role – To the right of the user name, below the Role ﬁeld, choose the X icon of the role you want to remove. • To conﬁgure roles for another user – Choose Manage another user. • To remove a user row from the current role-mapping group – Choose Remove. This does not remove a user, and their role assignments will not change. To remove a user from AWS Partner Central, refer to Removing users. 7. After completing role assignments, choose Update. Managing role assignments 78 AWS Partner Central Note Getting Started Guide After you choose Update, the number of successful and failed role assignments display on the User management page. AWS Partner Central will not make prohibited role assignments. For example, you cannot assign the alliance team
apc-gs-022	apc-gs.pdf	22	for another user – Choose Manage another user. • To remove a user row from the current role-mapping group – Choose Remove. This does not remove a user, and their role assignments will not change. To remove a user from AWS Partner Central, refer to Removing users. 7. After completing role assignments, choose Update. Managing role assignments 78 AWS Partner Central Note Getting Started Guide After you choose Update, the number of successful and failed role assignments display on the User management page. AWS Partner Central will not make prohibited role assignments. For example, you cannot assign the alliance team role to more than 20 users. For more information, refer to AWS Partner Central roles. Reassigning the alliance lead role On the User management page, the alliance lead can reassign the role to another user. Only one user can have the alliance lead role at a time. To reassign the alliance lead role 1. Sign in to AWS Partner Central as a user with the alliance lead role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Users tab. 4. In the ﬁrst column of the user list, select the checkbox of the user you want to make the new alliance lead. 5. Choose Reassign the alliance lead role. 6. On the alliance lead role management page, choose the new alliance lead user. 7. Choose Reassign. 8. On the Reassign alliance lead dialog box, enter confirm and choose Reassign. Reassigning the alliance lead role 79 AWS Partner Central Getting Started Guide Mapping users to IAM roles On the IAM roles tab, you can grant single sign-on access to the AWS Marketplace Management Portal (AMMP) to cloud admin and non-cloud admin partner users by assigning them an IAM role. Prerequisites You must complete the following before mapping users to IAM roles: • Link your AWS Partner Central account to an AWS Marketplace account. • In the IAM console, a cloud admin user creates IAM roles with Marketplace permissions. For more information, refer to Linking AWS Partner Central and AWS accounts. To map users to IAM roles 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the IAM roles tab. 4. To map cloud admin users: a. Choose one or more users from the Cloud admin users list. This list contains users assigned the cloud admin role that need an IAM role assignment to have AWS Marketplace permissions. b. Choose Map to IAM role. 5. To map non-cloud admin partner users: a. Choose one or more users from the Available partner users list. This list contains users that do not have the cloud admin role but need an IAM role assignment to have AWS Marketplace permissions. b. Choose Map to IAM role. Mapping users to IAM roles 80 AWS Partner Central Removing users Getting Started Guide Removing a user permanently revokes that user's access to AWS Partner Central and cannot be undone. To restore a removed user, you must reinvite them to register. AWS Partner Central stores data for removed users. Important Before removing the user with the alliance lead role, reassign the role to another user. Refer to Reassigning the alliance lead role. To remove a user 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Users tab. 4. In the user list, select the checkboxes next to the users you want to remove. You can remove 10 users at a time. 5. Choose Remove user. 6. In the Remove user dialog box, enter confirm and choose Remove. Managing your proﬁle You can change your proﬁle data, except for your contact type, user role, or email address. To change your proﬁle 1. Sign in to AWS Partner Central. 2. Navigate to the My proﬁle menu and select the My proﬁle tab. 3. Choose Edit. 4. Update your information and choose Save. Removing users 81 AWS Partner Central Note Getting Started Guide If you need to update your contact type, submit an AWS Partner support case. Managing your proﬁle 82 AWS Partner Central Getting Started Guide AWS Partner Central permissions best practices When assigning AWS Partner Central roles, use the following guidelines. Topics • Assign roles according to the principle of least privilege • Audit role assignments • Use unique credentials • Avoid generic logins Assign roles according to the principle of least privilege Users should have permissions to access only those resources that they need to perform their jobs. For example, if one of your team members is responsible only for updating
apc-gs-023	apc-gs.pdf	23	you need to update your contact type, submit an AWS Partner support case. Managing your proﬁle 82 AWS Partner Central Getting Started Guide AWS Partner Central permissions best practices When assigning AWS Partner Central roles, use the following guidelines. Topics • Assign roles according to the principle of least privilege • Audit role assignments • Use unique credentials • Avoid generic logins Assign roles according to the principle of least privilege Users should have permissions to access only those resources that they need to perform their jobs. For example, if one of your team members is responsible only for updating and reporting on opportunities across your pipeline in the APN Customer Engagements (ACE) Pipeline Manager they should have the ACE manager role, not the alliance team role. For more information, refer to Apply least privilege permissions in the IAM User Guide. Audit role assignments Periodically audit your role assignments and adjust permissions as people change roles at your organization. Audit your user list to ensure you have deactivated users who have left your organization or moved to roles that no longer require access to AWS Partner Central. Use unique credentials Ensure that users log in to AWS Partner Central with unique login credentials. Sharing user credentials violates the AWS Partner Network and AWS Partner Network Customer Engagements (ACE) terms and conditions and creates security risks. AWS Partner Central permissions best practices 83 AWS Partner Central Avoid generic logins Getting Started Guide Avoid keeping a generic login (for example, APN_Admin@company.com) assigned to the alliance lead role. Follow best practices for managing permissions and avoid having multiple users sign in to AWS Partner Central with the same generic credentials. Instead, reassign an individual user to the alliance lead role, assign other users to the roles they require, and deactivate the generic account. To reassign a generic login 1. Identify all of the users currently signing in to AWS Partner Central with the generic login. 2. Assign an individual user to the alliance lead role. 3. Assign other users to roles based on the principle of least privilege. For a summary of roles and their permissions, refer to AWS Partner Central roles. 4. Conﬁrm that all assigned users can access AWS Partner Central. After conﬁrmation is complete, the alliance lead can deactivate the generic account. To deactivate a generic account 1. Sign in to AWS Partner Central with the alliance lead role. 2. Choose View my APN Account. 3. 4. In the Partner Users section, choose Manage Active Partner Users. For the generic account, choose Deactivate from the action menu. Avoid generic logins 84 AWS Partner Central Getting Started Guide Multi-factor authentication (MFA) Multi-factor authentication (MFA) adds an additional layer of protection to your AWS Partner Central account. When enabled, users must enter a veriﬁcation code sent to their registered email address in addition to their username and password during login. When logging in, users have the option to mark a device as trusted for 30 days. After 30 days, users need to obtain a new one-time password. To sign in with MFA enabled, see Signing in to AWS Partner Central. Note If your team shares login credentials, we highly recommend your alliance lead or cloud admin to deactivate and reassign any shared logins. If shared credentials are not deactivated when MFA is enabled, users without access to the registered email inbox may potentially be unable to retrieve the one-time password required for login, locking users out of their accounts. More information on this process can be found in AWS Partner Central permissions best practices. To manage MFA for your AWS Partner Central accounts An alliance lead or cloud admin can manage MFA for all users in their organziation. Any changes to MFA settings made by an alliance lead or cloud administrator aﬀect all users within their organization. 1. Sign in to AWS Partner Central as a user with the alliance lead or cloud admin role. 2. On the My Company menu, choose User Management. 3. On the User management page, choose the Security tab. 4. Choose Edit. 5. Select a Multi-factor authentication (MFA) status option. • Enabled – To sign in to AWS Partner Central, users must enter a veriﬁcation code sent to their registered email address in addition to their username and password. • Disabled – To sign in to AWS Partner Central, users must only enter their username and password. 6. Choose Save. Multi-factor authentication (MFA) 85 AWS Partner Central Important Getting Started Guide If you are locked out of AWS Partner Central and need support, do the following: 1. Navigate to the AWS Partner Team contact page of the AWS Partner Network Knowledge Base. 2. Complete the contact form and choose Submit. Multi-factor authentication (MFA) 86 AWS Partner Central Getting Started Guide AWS Partner Central tasks AWS Partner Central
apc-gs-024	apc-gs.pdf	24	to their registered email address in addition to their username and password. • Disabled – To sign in to AWS Partner Central, users must only enter their username and password. 6. Choose Save. Multi-factor authentication (MFA) 85 AWS Partner Central Important Getting Started Guide If you are locked out of AWS Partner Central and need support, do the following: 1. Navigate to the AWS Partner Team contact page of the AWS Partner Network Knowledge Base. 2. Complete the contact form and choose Submit. Multi-factor authentication (MFA) 86 AWS Partner Central Getting Started Guide AWS Partner Central tasks AWS Partner Central provides recommended tasks to help with your account, solution development, and AWS Partner program enrollment. The tasks AWS Partner Central recommends are based on your company proﬁle, AWS Partner path, solution stage, and program enrollment. In AWS Partner Central, three types of tasks guide you in the following areas: • Account tasks — AWS Partner Central onboarding, setup, and administration. • Solution tasks — Build, market, sell, and grow solutions on AWS. • Program tasks — Enroll in and complete AWS Partner Network programs. Topics • My tasks • Task management • Solution growth stage tasks My tasks Use the following procedures to review and complete tasks assigned to you. Topics • Task summary • Completing tasks • Dismissing a task Task summary To view a summary of your tasks, refer to the Tasks section on the AWS Partner Central home page. To view your task summary 1. Sign in to AWS Partner Central as a user with the alliance lead or alliance team role. My tasks 87 AWS Partner Central Getting Started Guide 2. Under Tasks, the number of account, solution, and program tasks assigned to you appear. In the Tasks section, you can do the following: • Choose the number under Account tasks, Solution tasks, or Program tasks to view those tasks on the Tasks page. • Choose a task name to go to the task details page. • Choose View tasks to go to the Tasks page. Completing tasks To complete a task 1. Sign in to AWS Partner Central. 2. On the AWS Partner Central menu bar, choose My tasks. 3. On the My tasks menu, choose a task type. My tasks menu option Description Account tasks Solution tasks AWS Partner Central onboarding, account setup and administration. Build, market, sell, and grow solutions on AWS. Program tasks Enroll in AWS Partner Network programs. 4. On the Tasks page, choose the task name. 5. Complete the actions on the task details page. • Some tasks, such as adding a company description, provide a form to complete. Complete the form and choose Submit. • Some tasks, such as creating a software oﬀering, provide a link to choose to begin task work. 6. When you have ﬁnished the task work, on the task details page, choose Conﬁrm. Completing tasks 88 AWS Partner Central Dismissing a task Getting Started Guide On a task detail page, standard users can dismiss a task. Dismissing a task removes it from your list of task assignments and sends the task back to your alliance lead for reassignment. To dismiss a task 1. On the Tasks page, choose the task name. 2. On the task details page, choose Dismiss task. 3. On the Dismiss task dialog, enter a reason for your alliance lead to read. 4. Choose Dismiss task. Task management Alliance leads can manage task assignments for users in their AWS Partner organization. To assign or reassign a task 1. 2. Sign in to AWS Partner Central as a user with the alliance lead role. In the Tasks section of the home page, choose View tasks. 3. On the Tasks page, choose the Account tasks, Solution tasks, or Program tasks tab. 4. In the tasks table, select the check box of the task you want to assign. 5. Choose Change assignee. 6. On the Assign task dialog box, choose a user. You can search for a user by entering a name. 7. Choose Conﬁrm. Solution growth stage tasks There are four stages in the development of a solution on AWS: Build, Market, Sell, and Grow. At each stage, AWS Partner Central recommends tasks to guide you. The tasks that AWS Partner Central recommends are based on your company proﬁle, AWS Partner path, solution stage, and program enrollment. Dismissing a task 89 AWS Partner Central Note Getting Started Guide The AWS Partner Proﬁtability Framework is a best practice for using AWS Partner Central to develop solutions on AWS. To follow the framework in AWS Partner Central, use tasks. Topics • Build stage • Market stage • Sell stage • Grow stage Build stage In the Build stage, you create your AWS solution. AWS Partner Central tasks guide you to the AWS technical and business resources
apc-gs-025	apc-gs.pdf	25	guide you. The tasks that AWS Partner Central recommends are based on your company proﬁle, AWS Partner path, solution stage, and program enrollment. Dismissing a task 89 AWS Partner Central Note Getting Started Guide The AWS Partner Proﬁtability Framework is a best practice for using AWS Partner Central to develop solutions on AWS. To follow the framework in AWS Partner Central, use tasks. Topics • Build stage • Market stage • Sell stage • Grow stage Build stage In the Build stage, you create your AWS solution. AWS Partner Central tasks guide you to the AWS technical and business resources that are available to AWS Partners. These include best practices to follow to optimize your solution's visibility to AWS sellers and technical guidance from AWS service experts. The following table contains an overview of Build stage activities for software, service, and AWS Managed Service Provider (MSP) solutions: Solution type Build stage overview Software or service solution • Enroll in the Cloud Essentials - Knowledge Badge Readiness Path to learn foundational cloud concepts. • Enroll in the Solutions Architect Partner Learning Plan to learn about AWS service best practices when building and designing solutions. • Refer to the Solution Building Enablement Guide to build industry-focused solutions. • Use APN Innovation Sandbox credits to oﬀset the cost of building your solution on AWS. Build stage 90 AWS Partner Central Solution type AWS Managed Service Provider (MSP) solution Getting Started Guide Build stage overview • Explore AWS PartnerCast for free webinars and on-demand training resources. • Explore the AWS MSP Factory content to access hands-on workshops and modular content to develop your capabilities as an AWS MSP Partner. • Enroll in the Cloud Essentials - Knowledge Badge Readiness Path to learn foundational cloud concepts. • Enroll in the Solutions Architect Partner Learning Plan to learn about AWS service best practices when building and designing solutions. • Refer to the Solution Building Enablement Guide to build industry-focused solutions. • Use APN Innovation Sandbox credits to oﬀset the cost of building your solution on AWS. • Explore AWS PartnerCast for free webinars and on-demand training resources. Market stage In the Market stage, AWS Partner Central tasks help you add case studies, go-to-market (GTM) campaign templates, and marketing enablement to your solution's marketing materials. Tasks also help expand your reach among AWS sellers and customers with listings on AWS Marketplace and AWS Partner Solution Finder. The following table contains an overview of Market stage activities for software, service, and AWS Managed Service Provider (MSP) solutions: Market stage 91 AWS Partner Central Getting Started Guide Solution type Software solution Market stage overview • Learn to use AWS Partner Marketing Central tools and resources to help you to grow your business and reach new customers. • Apply for Marketing Development Funds (MDF) to oﬀset your marketing costs and build sales pipeline. For more information, refer to the MDF Quick Guide. • Create custom partner badges with AWS Badge Manager to showcase your relations hip with AWS and designations you've earned. View and download your organizat ion's badges in high-resolution .eps and .png ﬁles. For guidance on when and how to use the badges in your marketing, refer to the AWS Partner Creative and Messaging Guide. • Learn about AWS go-to-market (GTM) best practices: • Build a lead-generation strategy. • Download the GTM Strategy template. • Download the AWS Business Plan template. • Consider oﬀering a free tier for your product or service on AWS Marketplace. • Ensure that your Partner Solutions Finder (PSF) listing is accurate and current. This helps customers ﬁnd you on the public Partner Solutions Finder (PSF) and AWS sellers ﬁnd your solution on the internal Partner Discovery Portal (PDP). Service solution • Watch the video Drive demand with AWS Partner Marketing Central. Market stage 92 AWS Partner Central Solution type Getting Started Guide Market stage overview • Use the AWS Marketing Toolkit to create go- to-market (GTM) assets. • Create case studies and link them to your solution. • Refer to the AWS Marketplace Seller GTM Academy quick reference guide to build a GTM strategy for AWS Marketplace solutions . AWS Managed Service Provider (MSP) solution • Explore the AWS MSP Factory content to amplify your marketing eﬀorts. • Enroll in the Cloud Essentials - Knowledge Badge Readiness Path to learn foundational cloud concepts. • Enroll in the Solutions Architect Partner Learning Plan to learn about AWS service best practices when building and designing solutions. • Refer to the Solution Building Enablement Guide to build industry-focused solutions. • Use APN Innovation Sandbox credits to oﬀset the cost of building your solution on AWS. • Explore AWS PartnerCast for free webinars and on-demand training resources. Sell stage In the Sell stage, AWS Partner Central recommends tasks to enhance the visibility of your solutions among AWS
apc-gs-026	apc-gs.pdf	26	amplify your marketing eﬀorts. • Enroll in the Cloud Essentials - Knowledge Badge Readiness Path to learn foundational cloud concepts. • Enroll in the Solutions Architect Partner Learning Plan to learn about AWS service best practices when building and designing solutions. • Refer to the Solution Building Enablement Guide to build industry-focused solutions. • Use APN Innovation Sandbox credits to oﬀset the cost of building your solution on AWS. • Explore AWS PartnerCast for free webinars and on-demand training resources. Sell stage In the Sell stage, AWS Partner Central recommends tasks to enhance the visibility of your solutions among AWS sellers and customers. You'll build opportunity pipelines and prepare for co-selling opportunities in the APN Customer Engagement (ACE) program. The following table contains an overview of Sell stage activities for software, service, and AWS Managed Service Provider (MSP) solutions: Sell stage 93 AWS Partner Central Getting Started Guide Solution type Software solution Service solution AWS Managed Service Provider (MSP) solution Sell stage overview • Complete AWS Partner Sales Accreditation training to learn how to co-sell with AWS: • Create AWS Marketplace Private Oﬀers (MPPOs). • Submit opportunities through the APN Customer Engagements (ACE) Pipeline Manager. After 10 validated partner- originated opportunities, you become ACE eligible, to receive AWS originated opportunities. Launch two opportunities with your oﬀering attached to move to Grow stage. • Complete AWS Partner Sales Accreditation (Business) to learn to communicate the AWS value proposition to customers. • Complete the AWS Solution Seller Learning Plan and AWS Sales Essentials Partner Learning Plan to learn customer needs on AWS and best AWS co-selling practices. • Use the AWS Marketplace Channel Partner activation toolkit to sell your solutions on AWS Marketplace. • Request AWS Partner Proof-of-Concept (POC) activity funding to help acquire new customers or upsell existing customers. • Explore the AWS MSP Factory content to access hands-on workshops and modular content to develop your capabilities as an AWS MSP Partner. • Complete AWS Partner Sales Accreditation (Business) to learn to communicate the AWS value proposition to customers. Sell stage 94 AWS Partner Central Solution type Getting Started Guide Sell stage overview • Complete the AWS Solution Seller Learning Plan and AWS Sales Essentials Partner Learning Plan to learn customer needs on AWS and best AWS co-selling practices. • Use the AWS Marketplace Channel Partner activation toolkit to sell your solutions on AWS Marketplace. • Request AWS Partner Proof-of-Concept (POC) activity funding to help acquire new customers or upsell existing customers. Grow stage Growing your solution on AWS involves learning advanced networking to reach new markets and customer segments. AWS Partner Central recommends tasks to highlight your expertise to customers by achieving an AWS Specialization and validate your solutions with AWS Foundational Technical Reviews (FTRs). The following table contains an overview of Grow stage activities for software, service, and AWS Managed Service Provider (MSP) solutions: Solution type Software solution Service solution Grow stage overview • Highlight your expertise to customers by achieving an AWS Specialization. • Run pilot programs in your specialization. • Streamline procurement and oﬀer ﬂexible pricing on AWS Marketplace with AWS Marketplace Private Oﬀers (MPPOs). • Authorize channel partners to sell your AWS Marketplace oﬀer. • Use the channel seller renewal playbook to optimize your renewals process and reﬁne Grow stage 95 AWS Partner Central Solution type AWS Managed Service Provider (MSP) solution Getting Started Guide Grow stage overview your AWS Marketplace Channel Partner Private Oﬀer (CPPO) strategy. • Streamline procurement and oﬀer ﬂexible pricing on AWS Marketplace with AWS Marketplace Private Oﬀers (MPPOs). • Build industry-focused solutions and promote them with AWS Competency specialization. • Stand out among AWS Partners to AWS sales teams by sharing opportunites in the ACE Pipeline Manager that are linked to your solution. • Explore the AWS MSP Factory content to access hands-on workshops and modular content to develop your capabilities as an AWS MSP Partner. • Use the channel seller renewal playbook to optimize your renewals process and reﬁne your AWS Marketplace Channel Partner Private Oﬀer (CPPO) strategy. • Streamline procurement and oﬀer ﬂexible pricing on AWS Marketplace with AWS Marketplace Private Oﬀers (MPPOs). • Stand out among AWS Partners to AWS sales teams by sharing opportunites in the ACE Pipeline Manager that are linked to your solution. Grow stage 96 AWS Partner Central Getting Started Guide AWS Partner Central FAQ This topic provides answers to the following questions about AWS Partner Central. Topics • How do I open an AWS Support ticket? • I'm locked out of AWS Partner Central. How do I get support? • How do I register for AWS Partner Accreditations? • How do I reset my AWS Partner Central password? • How do I ensure that my Partner Scorecard registers my organization's AWS Certiﬁcations? • How do I transfer my AWS certiﬁcations to a new
apc-gs-027	apc-gs.pdf	27	Pipeline Manager that are linked to your solution. Grow stage 96 AWS Partner Central Getting Started Guide AWS Partner Central FAQ This topic provides answers to the following questions about AWS Partner Central. Topics • How do I open an AWS Support ticket? • I'm locked out of AWS Partner Central. How do I get support? • How do I register for AWS Partner Accreditations? • How do I reset my AWS Partner Central password? • How do I ensure that my Partner Scorecard registers my organization's AWS Certiﬁcations? • How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? • What is the AWS Direct Connect program? • Does AWS Partner Central support the Microsoft Edge Legacy browser? • Can I access the AWS Management Console through AWS Partner Central? How do I open an AWS Support ticket? In AWS Partner Central, choose Support, Contact Support to submit new cases, view your case history, or correspond with AWS Partner Support. I'm locked out of AWS Partner Central. How do I get support? If you are locked out of AWS Partner Central, you can get support by doing the following: 1. Navigate to the AWS Partner Team contact page of the AWS Partner Network Knowledge Base. 2. Complete the contact form and choose Submit. How do I register for AWS Partner Accreditations? To enroll in AWS Skill Builder and AWS Partner Accreditations 1. Sign in to AWS Partner Central. 2. Choose Learn, AWS Partner Training. 3. Choose Explore free digital training. How do I open an AWS Support ticket? 97 AWS Partner Central Getting Started Guide 4. Choose Sign in to AWS Skill Builder. How do I reset my AWS Partner Central password? To reset a forgotten password 1. On the Sign in to AWS Partner Network page, choose Forgot password. 2. Enter your registered business email address. 3. Choose Next. 4. Check your email for a message from apn-no-reply@amazon.com with the subject line AWS Partner Network Email Veriﬁcation. The message contains a veriﬁcation code. 5. On the Reset password page, enter the veriﬁcation code. 6. For Password, enter a new password. Passwords must contain the following: • Eight or more characters. • At least one uppercase and one lowercase letter. • At least one number. • At least one symbol from ! @ # $ % ^ _ = + : :. 7. Choose Submit. Note For help with signing in and registration, contact APN Support. How do I ensure that my Partner Scorecard registers my organization's AWS Certiﬁcations? In order for a user's AWS Certiﬁcation to appear on your Partner Scorecard, the user must be registered with AWS Partner Central. To register a user, refer to Inviting new users. In addition, one of the following must be true: • The user passed the AWS Certiﬁcation exam using their current registered AWS Partner Central email address. How do I reset my AWS Partner Central password? 98 AWS Partner Central Getting Started Guide • The user passed an AWS Certiﬁcation exam using the email address from their personal CertMetrics account and added the address to their AWS Partner Central account. Refer to Adding your CertMetrics email address to your AWS Partner Central account Adding your CertMetrics email address to your AWS Partner Central account 1. Sign in to AWS Partner Central. 2. Choose My Proﬁle, My AWS Certiﬁcations. 3. Choose Edit. 4. For AWS T&C Account Email, enter the email address registered with your CertMetrics account. 5. Choose Save. Allow 5 days for certiﬁcations to update on your Partner Scorecard. How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? You can transfer AWS certiﬁcations you've earned with a previous employer to a new AWS Partner Central account. To transfer your AWS certiﬁcations to a new AWS Partner Central account 1. Register as a user on AWS Partner Central with the registered business email address of your new company. 2. Navigate to the AWS Certiﬁcation page. 3. Choose Sign in. 4. On the Choose a sign in method page, in the Organization SSO section, enter the registered business email of your new company. 5. Choose Sign in. 6. Navigate to Contact AWS Training and Certiﬁcation. Submit a request to transfer your previous AWS Certiﬁcation proﬁle to your new AWS Partner Central account. How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? 99 AWS Partner Central Getting Started Guide To transfer AWS certiﬁcations to a new AWS Partner Central account with a CertMetrics email address If your CertMetrics account address is a personal email address listed in your previous company's AWS Partner Scorecard, do the following: 1. Sign in to AWS Partner Central using your previous email address and password. If you do not have access to this
apc-gs-028	apc-gs.pdf	28	Training and Certiﬁcation. Submit a request to transfer your previous AWS Certiﬁcation proﬁle to your new AWS Partner Central account. How do I transfer my AWS certiﬁcations to a new AWS Partner Central account? 99 AWS Partner Central Getting Started Guide To transfer AWS certiﬁcations to a new AWS Partner Central account with a CertMetrics email address If your CertMetrics account address is a personal email address listed in your previous company's AWS Partner Scorecard, do the following: 1. Sign in to AWS Partner Central using your previous email address and password. If you do not have access to this account, contact APN support for assistance. 2. Choose My proﬁle, My AWS Certiﬁcations 3. For View All Trainings and Certiﬁcations, choose Edit. 4. Delete the contents of the AWS T&C Account Email ﬁeld. 5. Choose Save. Your certiﬁcations will appear in your new account within ﬁve business days. Note For assistance updating your CertMetrics account email address, submit a request at Contact AWS Training and Certiﬁcation. In the request details, include your previous and new CertMetrics email addresses. What is the AWS Direct Connect program? For more information, refer to AWS Direct Connect Delivery Partners. Does AWS Partner Central support the Microsoft Edge Legacy browser? No. Eﬀective December 31, 2020, AWS Partner Central stopped supporting the Microsoft Edge Legacy Browser. If you currently access AWS Partner Central with the Edge Legacy browser, we recommend upgrading to the Microsoft Edge browser for a better experience. What is the Microsoft Edge Legacy browser? Microsoft Edge Legacy browser includes version of the original Edge browser prior to version 80. To ﬁnd out what version of Edge you have, refer to Find out which version of Microsoft Edge you have. What is the AWS Direct Connect program? 100 AWS Partner Central Why the change? Getting Started Guide In 2021, Microsoft ended support for its Microsoft Edge Legacy browser, including security updates. At AWS, our partner user experience and the security of partner data are very important to us. Hence, we proactively discontinued support for the Microsoft Edge Legacy browser on December 3, 2020 in favor of the new Edge browser released in January 2020. Can I access the AWS Management Console through AWS Partner Central? You cannot access the AWS Management Console through AWS Partner Central. Sign in to the AWS Management Console at https://console.aws.amazon.com/console. Why the change? 101 AWS Partner Central Getting Started Guide Document history for the AWS Partner Central Getting Started Guide The following table describes the documentation releases for AWS Partner Central Documentation. Change Description Date Updates to Partner Assistant documentation Moved information that was formerly in the AWS Partner March 17, 2025 Added account unlinking instructions Added new managed policy and updates to existing Central FAQ to AWS Partner Assistant and added a nested FAQ page speciﬁc to that product. Instructions were added in Unlinking your AWS Partner Central account from an AWS Marketplace account. January 15, 2025 Added the AWSPartne December 4, 2024 rCentralSellingRes ourceSnapshotJobEx ecutionRolePolicy managed policy. For more information, see AWSPartne rCentralSellingResourceSnap shotJobExecutionRo lePolicy. Updates to: AWSPartnerCentralFullAccess , AWSPartnerCentralO pportunityManageme nt, AWSPartnerCentralS andboxFullAccess. New AWS Partner Assistant AWS Partner Assistant is a generative AI-powered November 25, 2024 102 AWS Partner Central Getting Started Guide chatbot for AWS Partners. It is accessible from both Partner Central and AWS Marketplace Portal (AMMP). Added new managed policy Added the AWSPartne November 18, 2024 rCentralFullAccess AWS managed policy. For more information, see AWS managed policy: AWSPartne rCentralFullAccess . Added managed policy Added the AWSPartne November 14, 2024 rCentralOpportunit yManagement AWS managed policy. For more information, see AWS managed policy: AWSPartne rCentralOpportunit yManagement . Added managed policy Added the AWSPartne November 14, 2024 rCentralSandboxFul lAccess AWS managed policy. For more informati on, see AWS managed policy: AWSPartnerCentralS . andboxFullAccess Clariﬁcation First release Updated linking accounts prerequisites for clarity. June 5, 2024 First release of the AWS Partner Central Getting Started Guide. November 10, 2023 103
apc-sg-001	apc-sg.pdf	1	Sales Guide AWS Partner Central Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Partner Central Sales Guide AWS Partner Central: Sales Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Partner Central Table of Contents Sales Guide What Is ACE Pipeline Manager? ...................................................................................................... 1 Getting started ................................................................................................................................ 2 ACE terms and conditions .......................................................................................................................... 2 Permissions .................................................................................................................................................... 3 APN Customer Engagements Program eligibility .................................................................................. 3 Leads ................................................................................................................................................. 4 Accessing leads .............................................................................................................................................. 4 Lead status ..................................................................................................................................................... 4 Accepting a lead ........................................................................................................................................... 5 Updating a lead ............................................................................................................................................ 5 Converting a lead to an opportunity ....................................................................................................... 5 Exporting the current lead view ............................................................................................................... 6 Transferring lead ownership ...................................................................................................................... 7 Opportunities ................................................................................................................................... 8 AWS sales stages .......................................................................................................................................... 8 Contact roles ................................................................................................................................................. 9 Creating a new opportunity .................................................................................................................... 10 Cloning opportunities ................................................................................................................................ 11 AWS opportunity review process ............................................................................................................ 13 Accepting opportunities ............................................................................................................................ 13 Updating next steps and opportunity stage ........................................................................................ 14 Transferring opportunity ownership ...................................................................................................... 15 AWS stage visibility ................................................................................................................................... 16 Opportunity contacts ................................................................................................................................ 16 Creating a collaboration channel ............................................................................................................ 18 Sharing opportunities with multiple partners ..................................................................................... 19 Partner connections ...................................................................................................................... 20 Finding and connecting with partners .................................................................................................. 20 Managing connections .............................................................................................................................. 21 List views and column picker ....................................................................................................... 23 List views ...................................................................................................................................................... 23 Lead list views ....................................................................................................................................... 23 Opportunities list views ....................................................................................................................... 25 Column picker ............................................................................................................................................. 28 iii AWS Partner Central Sales Guide Bulk actions ................................................................................................................................... 29 Transfer lead and opportunity ownership ............................................................................................ 35 Search ............................................................................................................................................. 38 Document history .......................................................................................................................... 39 iv AWS Partner Central Sales Guide What Is ACE Pipeline Manager? The APN Customer Engagements Program (ACE) Pipeline Manager is an exclusive beneﬁt for participating AWS Partners in the APN Customer Engagements Program. The ACE Pipeline Manager provides AWS Partners full-service management of their pipeline of AWS customers, allowing for joint collaboration with AWS on those engagements. This guide walks through how to use the ACE Pipeline Manager and equips you with the necessary skills to drive successful customer engagements on AWS. 1 AWS Partner Central Sales Guide Getting started This section describes what you must do before using the ACE Pipeline Manager, and its main features, accessible from the Sell menu in AWS Partner Central. Topics • ACE terms and conditions • Permissions • APN Customer Engagements Program eligibility ACE terms and conditions Prior to participating in the ACE program, the Alliance Lead in your organization must sign in to AWS Partner Central and accept the ACE terms and conditions. To accept ACE terms and conditions 1. Sign in to AWS Partner Central as a user with the alliance lead role. 2. Choose Sell in the top menu bar. 3. Read the terms and conditions and choose Accept. Note After accepting the terms and conditions, only the alliance lead can access ACE Pipeline Manager. The alliance lead can assign permissions to ACE Pipeline Manager to other AWS Partner Central users. For more information, refer to Permissions To refer to the ACE terms and conditions 1. In AWS Partner Central, in the AWS Partner Path section, choose View Scorecard. 2. Choose Additional Details. 3. Choose ACE Program Terms Acceptance Date. ACE terms and conditions 2 AWS Partner Central Permissions Sales Guide The ACE Pipeline Manager is permission-based. Upon acceptance of the ACE terms and conditions, only the alliance lead will have access to the ACE Pipeline Manager and will need to enable permissions for other AWS Partner Central users. The alliance lead or an alliance team user can assign ACE user or ACE manager permissions. It can take up to one hour for the permissions to fully activate after they are assigned. The ACE user role can be assigned to an unlimited number of users, and provides users access to view and manage opportunities submitted by themselves, and to leads and opportunities in which they are the owner. The ACE manager role can be assigned to up to 20 users, and provides users access to view and manage opportunities submitted by any Partner user and access to all leads and opportunities shared by AWS. Available users are individuals in your ﬁrm with an active AWS Partner Central account. To enable new users to create a AWS Partner Central account, direct them to Sign up for APN. To grant the ACE user or ACE manager roles 1. Sign in to AWS Partner Central as a user with the Alliance Lead or Alliance Team role. 2.
apc-sg-002	apc-sg.pdf	2	they are the owner. The ACE manager role can be assigned to up to 20 users, and provides users access to view and manage opportunities submitted by any Partner user and access to all leads and opportunities shared by AWS. Available users are individuals in your ﬁrm with an active AWS Partner Central account. To enable new users to create a AWS Partner Central account, direct them to Sign up for APN. To grant the ACE user or ACE manager roles 1. Sign in to AWS Partner Central as a user with the Alliance Lead or Alliance Team role. 2. Choose My Company, User Management. 3. Choose Manage ACE Pipeline Manager Users. 4. Choose a user from the Available users list. 5. Choose Make ACE user or Make ACE manager. 6. On the Update User Role dialog box, choose OK. APN Customer Engagements Program eligibility For requirements for AWS Partners to be able to receive leads and opportunities, refer to APN Customer Engagements. Permissions 3 AWS Partner Central Leads Sales Guide On Leads tab of the ACE Pipeline Manager, you can accept and update leads and convert leads to opportunities. Topics • Accessing leads • Lead status • Accepting a lead • Updating a lead • Converting a lead to an opportunity • Exporting the current lead view • Transferring lead ownership Accessing leads 1. 2. Sign in to AWS Partner Central. From the top menu bar, choose Sell, Leads Management. On the ACE Pipeline Manager page, the Leads tab is where you to accept, manage, and report back updates on lead engagements shared by AWS and convert lead engagements to opportunities. Note Only Alliance leads can view AWS Partner Solutions Finder leads. Users with the alliance lead, alliance team, and ACE manager roles receive automated messages when a lead is generated through their AWS Partner Solutions Finder listing. Lead status Leads can have the following status: Accessing leads 4 AWS Partner Central Lead status Open Research Qualiﬁed Sales Guide Description The lead was accepted by the partner but no customer contact has been made. The lead is being reviewed by the partner to understand customer needs, use case. Partner account team engaged with prospect/end customer to discuss viability, understand requirements, etc. Prospect/end customer agreed the opportunity is real, of interest, and may solve a business or technical need. Disqualified Lead cannot be tied to an opportunity. Accepting a lead AWS Partners have the option to either accept or reject incoming lead engagements. You must accept an incoming lead before you can view all lead details including contact information. 1. On the Leads tab, for All Customer Engagements, choose Leads Pending Acceptance. 2. Choose the row of the lead you want to accept. 3. In the Action column, choose Accept. Updating a lead 1. On the Leads tab, select the row of the lead you want to update. 2. In the Action column, choose Update. 3. On the Leads detail page, choose Edit. 4. Edit lead details and choose Save. Converting a lead to an opportunity On the Leads tab, you can convert qualiﬁed leads to opportunities to receive AWS validation and support. Accepting a lead 5 AWS Partner Central Sales Guide 1. On the Leads tab, select the row of the qualiﬁed lead you want to convert. 2. In the Action column, choose Update. 3. On the Leads detail page, choose Convert. 4. On the conﬁrmation dialog, choose OK. 5. Complete the ﬁve steps of the Create opportunity form. 6. On the Review and create page, choose Save & Submit. 7. Choose Back to Opportunity Dashboard. On the Opportunities tab, the new opportunity displays with status of Submitted. Exporting the current lead view You can export the current lead view as a CSV ﬁle. On the Leads tab, choose Bulk Actions, Export current lead view. Note To view all available lead information, ensure that all leads are accepted. For more information, refer to Accepting a lead. Exporting the current lead view 6 AWS Partner Central Sales Guide Transferring lead ownership Partner users can transfer ownership of leads in ACE Pipeline Manager to another active user in their partner organization that meets the following criteria: • The user must have permissions to ACE Pipeline Manager. For more information, refer to Permissions. • The user must have the alliance lead, alliance team, ACE manager, or ACE user role. 1. On the Leads tab, choose the lead you want to transfer. 2. Choose Bulk actions, Transfer lead. 3. Enter the name of the user you want to transfer to. 4. Choose Save. Note To transfer leads in bulk, refer to Bulk actions Transferring lead ownership 7 AWS Partner Central Sales Guide Opportunities Opportunities can be added individually or by bulk import. We encourage AWS Partners to submit opportunities early in the sales
apc-sg-003	apc-sg.pdf	3	permissions to ACE Pipeline Manager. For more information, refer to Permissions. • The user must have the alliance lead, alliance team, ACE manager, or ACE user role. 1. On the Leads tab, choose the lead you want to transfer. 2. Choose Bulk actions, Transfer lead. 3. Enter the name of the user you want to transfer to. 4. Choose Save. Note To transfer leads in bulk, refer to Bulk actions Transferring lead ownership 7 AWS Partner Central Sales Guide Opportunities Opportunities can be added individually or by bulk import. We encourage AWS Partners to submit opportunities early in the sales cycle after the discovery phase is complete, once the opportunity is at a stage of Qualified or higher. Note Only the alliance lead, alliance team, and ACE manager have a complete view of opportunities. Individuals granted access to the ACE Pipeline Manager can view opportunities they submit. Topics • AWS sales stages • Contact roles • Creating a new opportunity • Cloning opportunities • AWS opportunity review process • Accepting opportunities • Updating next steps and opportunity stage • Transferring opportunity ownership • AWS stage visibility • Opportunity contacts • Creating a collaboration channel on Slack • Sharing opportunities with multiple AWS Partners AWS sales stages Stage Prospect AWS sales stages Description Customer opportunity has been identiﬁed. 8 AWS Partner Central Stage Qualiﬁed Technical validation Sales Guide Description You have engaged with the customer on the opportuni ty to discuss its viability and understand the requireme nts. The customer has agreed that the opportunity is real, of interest, and may help with key business and technical needs. The customer technically validates the solution using a combination of presentations, architecture design sessions with the system administrator (SA) and AWS Partner and other proof-of-concept activities. Business validation Business stakeholders have communicated their agreement on the ﬁnancial viability of the solution. Committed Launched Closed lost Contact roles The customer has agreed to the solution and commits to moving with technology, architecture, and economics. Billing for the solution has begun. The end customer selected another cloud provider or is not ready to move forward with the solution. The following table shows the names and roles of contacts in an opportunity. Contact name Role AWS Sales representative AWS Partner sales contact The primary contact from AWS Sales on an opportunity. The primary contact from your organization for an opportunity. AWS Sales may connect with this contact regarding the opportunity. Contact roles 9 AWS Partner Central Contact name AWS account manager Partner Development Manager (PDM) Sales Guide Role The AWS account manager for the customer on an opportunity. The primary AWS contact for AWS Partners. Partner Development Managers (PDMs) help AWS Partners through their AWS Partner journey and serves as the key resource. The primary AWS contact for AWS Partners working on a public-sector opportunity. Worldwide Public Sector Partner Development Worldwide Public Sector Partner Developme Manager (WWPS PDM) nt Managers (WWPS PDMs) help AWS Partners through their AWS Partner journey for public- sector competencies. AWS Partner Success Managers (PSM) connect AWS Sales teams directly to AWS Partners. AWS Partner Success Manager (PSM) They are experts on AWS Partner solutions and help drive AWS Partner go-to-market strategies. AWS Independent Software Vendor Success Managers (ISMs) help co-sell with AWS. They assist with sales pipeline reviews, sales enablement, lead generation, and lead management. AWS Independent Software Vendor Success Manager (ISM) Creating a new opportunity 1. Sign in to AWS Partner Central. 2. Choose Sell, Opportunity Management. 3. On the Opportunities page, choose Create. 4. Enter customer details and choose Next. Creating a new opportunity 10 AWS Partner Central Sales Guide • All ﬁelds are required except for Customer DUNS. Information such as the customer website and zip code are necessary to align the opportunity with internal stakeholders. • If you enter Government for Industry Vertical, make sure you select a Classiﬁed National Security Information option. 5. Enter project details and choose Next. • Select Co-Sell with AWS if you want AWS Sales support. If you select Co-Sell with AWS, make sure you choose one or more Partner speciﬁc needs from AWS for Co-Sell options. • For Opportunity Type, if there are existing contracts between the end customer and partner with the potential for incremental revenue, choose Expansion. Choose Flat Renewal if no potential for incremental revenue exists. If you select Expansion or Flat Renewal, you can enter an optional parent opportunity ID. • AWS Training Partners (ATPs) should enter Training for Use Case, and enter AWS revenue from AWS training kits for Estimated AWS Monthly Recurring Revenue. • Enter a future date for Target Close Date. Do not submit opportunities with Launched or Closed Won status. • If you select Yes: Sourced from marketing activity, make sure you select Yes or No for Marketing development funds. Enter optional details
apc-sg-004	apc-sg.pdf	4	with the potential for incremental revenue, choose Expansion. Choose Flat Renewal if no potential for incremental revenue exists. If you select Expansion or Flat Renewal, you can enter an optional parent opportunity ID. • AWS Training Partners (ATPs) should enter Training for Use Case, and enter AWS revenue from AWS training kits for Estimated AWS Monthly Recurring Revenue. • Enter a future date for Target Close Date. Do not submit opportunities with Launched or Closed Won status. • If you select Yes: Sourced from marketing activity, make sure you select Yes or No for Marketing development funds. Enter optional details as desired and choose Next.> Enter optional customer contact details and choose Next. For more information, refer to Contact roles. 6. 7. 8. Review the opportunity details and choose Save & and Submit. Cloning opportunities You can start creating a new opportunity by cloning any existing opportunity that is not in draft status. 1. On the Opportunities page, choose the Opportunity ID of the opportunity you want to clone. 2. On the opportunity detail page, choose Clone. 3. Edit the information as necessary to create the new opportunity. 4. Review the opportunity details and choose Save & and Submit. Cloning opportunities 11 AWS Partner Central Note Sales Guide If you receive a data-entry error message, you can edit and resubmit the opportunity. Cloning opportunities 12 AWS Partner Central Sales Guide AWS opportunity review process AWS conducts an initial review of submitted opportunities, and may require additional information from the AWS Partner, according to the ACE Terms and Conditions. If additional information is required for a secondary review, users with the alliance lead, alliance team, ACE manager, and ACE user roles receive email notiﬁcations. In ACE Pipeline Manager, Action required displays in the Status column for opportunities that require more information. 1. Sign in to AWS Partner Central. 2. Choose Sell, Opportunity Management. 3. In the Opportunities section, choose Filter. 4. On the Filter page, choose Action required. 5. Choose Apply. 6. Choose the row of the Action required opportunity that you want to update. 7. Choose the Opportunity ID. 8. On the opportunity details page, review the remarks from the ACE Validation team in the APN Review Reason notiﬁcation. 9. Choose Edit. 10. Make the required changes and choose Save. 11. Choose Submit. Accepting opportunities ACE eligible AWS Partners can receive AWS Opportunity Referrals. These opportunities are generated by AWS where consent was captured to permit an AWS Partner to assist with their proposed solution or workload. The Alliance Lead can access all shared opportunities. Note You must accept an opportunity within ﬁve business days or it will be removed from your view in the ACE Pipeline Manager. To view opportunity details before accepting, on the Opportunities page, choose the Opportunity ID. Before you accept an opportunity, you only have access to the following ﬁelds: AWS opportunity review process 13 AWS Partner Central Sales Guide • Customer company ﬁelds – End User (Company Name), End User Website, Country, Postal Code, Industry Vertical. • Opportunity ﬁelds – Opportunity Type, Use Case, Created Date, Partner Project Title, Customer Business Problem, Next Step, Delivery Model, Monthly Recurring Revenue, Target Close Date, Lead Source, Opportunity Ownership. • AWS contact ﬁelds – Name and email of AWS Sales Rep, AWS Account Owner, Partner Success Manager/ISV Success Manager, Partner Development Manager/Partner Development Representative, WWPS PDM. To accept an opportunity 1. On the Opportunities page, for All Opportunities, choose Opportunities Pending Acceptance. 2. Select the check box of the opportunity you want to accept. 3. Choose Accept. Updating next steps and opportunity stage We recommend that AWS Partners update opportunities with AWS Sales visibility with next steps at each stage change. To add next steps 1. On the Opportunities page, choose the row of the validated opportunity you want to update. Validated opportunities have a status of Approved. 2. Choose Opportunity ID. 3. On the opportunity details page, under Next Steps, choose Add next step. 4. On the Next Steps page, enter a comment of up to 255 characters. 5. Choose Save. To update opportunity stage 1. On the Opportunities page, choose the row of the validated opportunity you want to update. Validated opportunities have a status of Approved. 2. Choose Opportunity ID. Updating next steps and opportunity stage 14 AWS Partner Central Sales Guide 3. On the opportunity details page, choose a stage from the Change Stage dropdown list. Transferring opportunity ownership Partner users can transfer ownership of opportunities in ACE Pipeline Manager to another active user in their partner organization that meets the following criteria: • The user must have permissions to ACE Pipeline Manager. For more information, refer to Permissions. • The user must have the Alliance Lead, Alliance Team, ACE Manager, or ACE User role. 1. On the Opportunities page, choose the opportunity
apc-sg-005	apc-sg.pdf	5	of Approved. 2. Choose Opportunity ID. Updating next steps and opportunity stage 14 AWS Partner Central Sales Guide 3. On the opportunity details page, choose a stage from the Change Stage dropdown list. Transferring opportunity ownership Partner users can transfer ownership of opportunities in ACE Pipeline Manager to another active user in their partner organization that meets the following criteria: • The user must have permissions to ACE Pipeline Manager. For more information, refer to Permissions. • The user must have the Alliance Lead, Alliance Team, ACE Manager, or ACE User role. 1. On the Opportunities page, choose the opportunity you want to transfer. 2. Choose Bulk actions, Transfer Opportunities. 3. Enter the name of the user that you want to transfer to. 4. Choose Transfer. Note To transfer opportunities in bulk, refer to Bulk actions. Transferring opportunity ownership 15 AWS Partner Central AWS stage visibility Sales Guide When an opportunity has reached its terminal stage (status Launched or Closed/Lost), the AWS Partner must complete the following: 1. Update the opportunity close date. 2. Enter an AWS account ID if applicable. 3. Update the opportunity stage. If the AWS seller updates an opportunity to a terminal stage in their CRM (customer relationship management) program, three new ﬁelds will appear for the opportunity in ACE Pipeline Manager: • AWS Stage • AWS Close Date • AWS Closed/Lost Reason To view AWS Stage, AWS Close Date, AWS Closed/Lost Reason ﬁelds 1. On the Opportunities page, click the opportunity ID of the validated opportunity you want to update. Validated opportunities have a status of Approved. 2. Choose the Additional Details tab. Edits to AWS Close Date on the Additional details tab do not aﬀect the Target Close Date on the Project details tab. Edits to AWS Stage on the Additional details tab do not aﬀect Stage in the Overview section on the opportunity detail page. Opportunity contacts You can view the AWS contacts for any validated opportunity in the ACE Pipeline Manager. To view opportunity contacts 1. On the Opportunities page, choose the row of the validated opportunity you want to update. Validated opportunities have a status of Approved. 2. Choose Update or the Customer Company Name. 3. Choose the Contacts tab. AWS stage visibility 16 AWS Partner Central Sales Guide Opportunity contacts 17 AWS Partner Central Sales Guide Creating a collaboration channel on Slack AWS Partners can request collaboration on select strategic, high-value opportunities that require AWS co-sell support. The eligible opportunity must be at the Qualiﬁed stage or higher. Once approved, the partner will receive an email notiﬁcation with an invitation to join the designated Slack channel. To submit a collaboration request: 1. Sign in to AWS Partner Central. 2. Choose Sell from the top navigation, and then choose Opportunity Management. 3. 4. From Opportunities, choose the Opportunity ID to view details. From the opportunity details page, choose the Collaboration channels tab. 5. Choose Request a Slack channel. 6. Select users to add to the channel, and then choose Add to channel. Once you have submitted the request, you can view the channel's status and details, including invited partner contacts and their invitation status. When a collaboration request is submitted, the AWS account manager for the opportunity is notiﬁed. The account manager then creates the Slack channel, adding the selected contacts and other relevant opportunity team members. Once the channel is created, an email invitation is sent to all invited parties. To accept the invitation: 1. 2. From the email invitation, choose Get started. Slack will open in your browser. Select the organization associated with your invitation. The email you use for Slack must match the one used for your Partner Central account. 3. Choose the Slack workspace that you'd like to use to join the channel. 4. Choose Join channel. Opting out and leaving a channel: • Partners can opt out of future Slack invitations by selecting Opt-out of all invites from the ﬁrst pinned message in the channel. Creating a collaboration channel 18 AWS Partner Central Sales Guide • To leave a channel, choose the channel name in the conversation header to see channel information. Then, choose Leave channel from the channel options. Alternatively, you can choose Leave channel from the ﬁrst pinned message. Sharing opportunities with multiple AWS Partners AWS Partners can share and collaborate on opportunities with other AWS Partners. Note You must have an active Partner connection to share an opportunity. For more information, see Partner connections. To share an opportunity with another partner: 1. 2. 3. Sign in to AWS Partner Central. From the top navigation, choose Sell, and then choose Opportunity Management. From Opportunities, select the Opportunity ID and choose Share with partners. Alternatively, you can also choose Share with partners from the opportunity details page. 4. Enter details to share with collaborating partners,
apc-sg-006	apc-sg.pdf	6	from the ﬁrst pinned message. Sharing opportunities with multiple AWS Partners AWS Partners can share and collaborate on opportunities with other AWS Partners. Note You must have an active Partner connection to share an opportunity. For more information, see Partner connections. To share an opportunity with another partner: 1. 2. 3. Sign in to AWS Partner Central. From the top navigation, choose Sell, and then choose Opportunity Management. From Opportunities, select the Opportunity ID and choose Share with partners. Alternatively, you can also choose Share with partners from the opportunity details page. 4. Enter details to share with collaborating partners, and then add the partners you want to share the opportunity with. You can add nine partners to the invitation. 5. Choose Share opportunity. To accept an invitation to collaborate on an opportunity: 1. From the Sell navigation, choose Multi-partner opportunites, and then choose Invitations. 2. Choose the Invitation ID to view the details page. 3. From the invitation details page, choose either Accept invitation or Reject invitation. Sharing opportunities with multiple partners 19 AWS Partner Central Sales Guide Partner connections You can discover other AWS Partners to connect and collaborate with by going to Partner connections. Once you've connected with other partners, you can manage your connections from the same page. An existing connection is required to collaborate on a multi-partner opportunity together. Note Only AWS Partners who have linked their AWS Partner Central account with their AWS Marketplace account can use Partner connections. You can use any AWS account to complete the linking process. For more information, see Linking AWS Partner Central accounts with AWS Marketplace seller accounts. To access partner connections: 1. 2. Sign in to AWS Partner Central. From the top navigation, choose Partner connections. You can use Find and connect to discover other AWS Partners and send connection requests. Use Manage partner connections to respond to connection invitations and manage your active connections. Topics • Finding and connecting with partners • Managing connections Finding and connecting with partners From Find and connect, you can search for partners to connect with using either the Partner ﬁnder or the AI-recommended connections. Use the search criteria provided in Partner ﬁnder to reﬁne your search and ﬁnd partners who align. AI-recommended connections provides you with suggestions based on your proﬁle and open opportunities. Finding and connecting with partners 20 AWS Partner Central To send a connection request: Sales Guide 1. When you have found a partner to connect with, choose the options menu in their info card. 2. Choose Send connection request. 3. In the Send connection request modal, enter your introduction in Message to partner, and choose Send connection request. Partner connections — Send a connection request Managing connections From Manage partner connections, you can manage existing partner connections as well as both incoming and outgoing connection requests. Managing connections 21 AWS Partner Central Sales Guide To respond to a connection request: You can respond to any connection request with the Request status as Pending response. 1. From Connection requests, select a connection. Alternatively, you can choose the Connection ID to view details and respond. 2. Choose Accept or Reject. Connection requests can have the following statuses: • Pending response—Waiting for a response from the recipient. • Cancelled—The sender cancelled the request. • Rejected—The recipient rejected the request. To end a connection: If you no longer want to be connected to a partner, you can end the connection. 1. Select the partner you no longer want to be connected with. Alternatively, you can also choose the partner to view details. 2. Choose End connection. Your connections can have the following statuses: • Connected—This connection is active, and you can share opportunities with this partner. • Not connected—This connection has ended, and you can no longer share opportunities with this partner. Either partner can end a connection. Managing connections 22 AWS Partner Central Sales Guide List views and column picker Use list views and column pickers on the Leads and Opportunities tabs to customize displays. Topics • List views • Column picker List views By default, All Customer Engagements display for leads and All Opportunities display for opportunities. Choose the All Customer Engagements or All Opportunities list-view picker to choose other preset list views. In addition to preset list views, you can create custom list views for leads and opportunities that include your choice of ﬁlters. Lead list views Label Description Leads pending acceptance Leads shared by AWS that haven’t been accepted or rejected. Open leads Leads in status Open that have been accepted. Qualiﬁed leads Leads in status Qualiﬁed. Disqualified leads Leads in status Disqualified. Leads in research Leads in status Research. Flagged leads Leads you ﬂagged for follow-up. Partner Solution Finder leads Leads generated from your AWS Partner Solutions Finder Directory Listing. Leads with campaigns Leads generated
apc-sg-007	apc-sg.pdf	7	choose other preset list views. In addition to preset list views, you can create custom list views for leads and opportunities that include your choice of ﬁlters. Lead list views Label Description Leads pending acceptance Leads shared by AWS that haven’t been accepted or rejected. Open leads Leads in status Open that have been accepted. Qualiﬁed leads Leads in status Qualiﬁed. Disqualified leads Leads in status Disqualified. Leads in research Leads in status Research. Flagged leads Leads you ﬂagged for follow-up. Partner Solution Finder leads Leads generated from your AWS Partner Solutions Finder Directory Listing. Leads with campaigns Leads generated from AWS Marketing Activities (for example, service webinars). List views 23 AWS Partner Central Label Description Sales Guide Shared by AWS in the last 7 days Leads shared by AWS in the last 7 days. Shared by AWS this Quarter Leads shared by AWS this quarter. Date of last provided update exceeds 2 weeks Leads that haven’t been edited and updated in the previous two weeks. Lead list views 24 AWS Partner Central Sales Guide Opportunities list views Label Description All customer engagements All opportunities you’ve submitted and have been shared by AWS. Draft opportunities All opportunities you’ve created, but, have not completed and submitted. Opportunities in review All opportunities you’ve submitted that are being reviewed by AWS. Validated open opportunities All opportunities that you’ve submitted, have been validated by AWS are in are in an open sales stage (not Launched or Closed Lost). Committed opportunities All opportunities you’ve created or were shared by AWS that are in stage Committed. Closing this month All opportunities you’ve created that have a close date this month. Launched opportunities All opportunities you’ve created or were shared by AWS that are in stage Launched. Opportunities pending acceptance Opportunities shared by AWS that are pending acceptance or rejection. Partner referred opportunities All opportunities you submitted that were validated by AWS. AWS referred opportunities Accepted opportunities shared by AWS. Flagged opportunities All opportunities you ﬂagged for follow-up. Shared by AWS in the last 7 days Opportunities shared by AWS in the last 7 days. Opportunities list views 25 AWS Partner Central Label Description Sales Guide Shared by AWS this quarter Opportunities shared by AWS in the existing AWS quarter (January–March, April–June, July–September, October–D ecember). Date of last provided update exceeds 2 weeks All opportunities that lack edits and updates in the previous 2 weeks. Submitted to AWS in the last 7 days All opportunities submitted to AWS in the last 7 days. Submitted to AWS this quarter All opportunities submitted to AWS this quarter. Opportunities list views 26 AWS Partner Central Creating a custom list view Sales Guide 1. On the Leads or Opportunities tabs of ACE Pipeline Manager, choose the list view picker. 2. Choose Create new view. 3. On the Create new view page, enter a View Name. 4. To add a ﬁlter, choose a Field, complete the ﬁlter parameters, and choose Add ﬁlter. AWS Partners can add multiple ﬁlters. 5. Choose Save. To edit a custom lead list view 1. On the Leads or Opportunities tab, choose the list view you want to edit. 2. Choose the list view name. 3. Choose Edit View. 4. Edit the view name and ﬁlters as necessary. 5. Choose Save. To delete a custom lead list view 1. On the Leads or Opportunities tab, choose the list view you want to edit. 2. Choose the list view name. 3. Choose Delete View. To edit a custom opportunity list view 1. On the Leads or Opportunities tab, choose the list view you want to edit. 2. 3. To the left of the settings icon, choose the Edit view icon. Edit the view name and ﬁlters as necessary. 4. Choose Save. To delete a custom opportunity list view 1. On the Leads or Opportunities tab, choose the list view you want to delete. 2. On the ACE Pipeline Manager, choose the table icon. Opportunities list views 27 AWS Partner Central 3. Choose Delete View. Column picker Sales Guide Choose the Column Picker gear icon on the Leads or Opportunities tabs to select the columns you want displayed in the list. Column picker 28 AWS Partner Central Sales Guide Bulk actions 1. To upload opportunities in bulk, choose the drop-down list for Bulk Actions and select Import Opportunities. Partners are prompted with an overview of the key steps involved. 2. Choose Start Import. Users must complete the following Download and Prepare CSV ﬁle for import steps prior to uploading ﬁles: • Always download the latest Excel template: The date in which the template was last updated will be displayed for user transparency. Note: it is the user’s responsibility to ensure the latest template version is being used for upload. • New changes: Check the new section “Products and Oﬀerings” for
apc-sg-008	apc-sg.pdf	8	actions 1. To upload opportunities in bulk, choose the drop-down list for Bulk Actions and select Import Opportunities. Partners are prompted with an overview of the key steps involved. 2. Choose Start Import. Users must complete the following Download and Prepare CSV ﬁle for import steps prior to uploading ﬁles: • Always download the latest Excel template: The date in which the template was last updated will be displayed for user transparency. Note: it is the user’s responsibility to ensure the latest template version is being used for upload. • New changes: Check the new section “Products and Oﬀerings” for guidance on how to attach products and oﬀerings on opportunities. Download the dynamic sheet to check the APN Product Codes and Oﬀering IDs to add on the bulk excel template. • Prepare the Excel ﬁle to import: Fill in all the information in the required ﬁelds highlighted in yellow. There are guided boxes that appear by clicking on the cell. They support you through the process in order to insert the correct information. Some of the cells have drop-down lists where you can review and choose required ﬁelds. • Additional columns are required if you select certain options: Additional columns are highlighted in the Excel ﬁle and listed in the table. 3. Choose Next. 4. When your Excel template is ready, choose Select File, select your saved .csv ﬁle, and then choose Upload. If you receive an error message while resolving any missing ﬁelds, refer to the accompanying tables in this section. 5. Choose Import to continue, and then wait for the conﬁrmation message. If you receive an error message, review the section Errors in the bulk upload. 6. Choose Done, and close bulk import to return to the ACE Pipeline Manager. Fields Field name (required) Description Customer/company name • Name can be 80 characters maximum. Industry vertical (pick-list value) Customer company name: 29 AWS Partner Central Sales Guide Field name (required) Description • Choose an industry vertical from the pick list. If you copy data from another ﬁle, paste it as text. • Needs to map to valid selection. Refer to Values sheet containing mapping. • Industry Other (required if industry vertical is Other) (column C). • Required ﬁeld when Industry Vertical selected is Other. • 255 characters maximum. • Government requires the following: Does opportunity belong to NatSec? (column D) Country (pick-list value) Required conditional ﬁelds: • Needs to map to valid selection. Refer to the Values sheet for mapping. • If you copy data from another ﬁle, paste it as text. • State/province (pick-list value) (column F). • When country is set to United States, state/province (column F) is required. Postal code • Field is speciﬁc to the end customer’s billing postal code. • 20 characters maximum. • If the postal code starts with a zero, reformat the cell to as text. • Attention to the formatting according to each country. Refer to the values tab and follow the postal code format of the country selected. If your country does not have a postal code leave it blank. 30 AWS Partner Central Sales Guide Field name (required) Description Customer website • Must be a valid domain. Partner primary need from AWS • No social media pages are allowed. • 255 characters maximum. • If the domain ends in .co, add a forward slash (/) to the end (e.g., www.domain.co/). • Required conditional ﬁeld. • Must map to a valid selection. Refer to the Values sheet for mapping. • If you select Co-Sell, then Sales Activities is required (column W). Partner project title • Project title can be 60 characters maximum. Customer business problem • Describe the customer’s pain point or business problem. The description must be 20 characters minimum. Solution oﬀered • Describe the solution in 255 characters maximum. Enter the Oﬀering ID for the solution. If you don't have an Oﬀering ID, enter Other. If you enter Other, then Other Solution Oﬀered is required (Column M). Other Solution Oﬀered • Describe the solution in 255 characters maximum. Use case (pick-list value) • Must map to valid use case. Refer to the Values sheet for mapping. • If you copy data from another ﬁle, paste it as text. Estimated AWS monthly recurring revenue • Use only numbers and no special formatting. Remember to count revenues in dollars and use US decimal notation (0,000.00). 31 AWS Partner Central Sales Guide Field name (required) Description Target close date • Future date must be in mm/dd/yyyy format. Update column formatting prior to and after saving the .csv ﬁle. • When formatting the column, don't use asterisks in the date format because it will respond to changes based on a user’s location and operating system. Download a new template, transfer only its data, and format the target-launch date column using the
apc-sg-009	apc-sg.pdf	9	text. Estimated AWS monthly recurring revenue • Use only numbers and no special formatting. Remember to count revenues in dollars and use US decimal notation (0,000.00). 31 AWS Partner Central Sales Guide Field name (required) Description Target close date • Future date must be in mm/dd/yyyy format. Update column formatting prior to and after saving the .csv ﬁle. • When formatting the column, don't use asterisks in the date format because it will respond to changes based on a user’s location and operating system. Download a new template, transfer only its data, and format the target-launch date column using the steps in the next section. Opportunity type • Select from the list of valid values only to specify if the project is a net new business, renewal or expansion. • If the opportunity is a renewal or expansion, you can add the Parent Opportunity ID on Column Y Delivery model (pick-list value) • Needs to map to valid selection. Refer to the Values sheet for mapping. • If you copy data from another ﬁle, paste it as text. Is opportunity from marketing activity? (required) • Choose Yes or No. If you choose Yes, the following ﬁeld is mandatory: Were marketing development funds used? (required if Is opportunity from marketing activity? is set to Yes) (Column U). • If you choose Yes, the following ﬁelds are also optional: • AWS Marketing Campaign (Column AK). • Marketing Activity Channel (Column AL). • Marketing Activity Use-Case (Column AM). • Must map to a valid selection. Refer to Values sheet for mapping. Sales activities Describes the customer's sales activities. This is required if Partner Primary Need from AWS (column I) is set to Co-Sell. Competitive tracking (column AI) If Competitive Tracking is set to Other, then Other Competito rs (column AJ) is required. 32 AWS Partner Central Note Sales Guide The Secondary Required Fields (highlighted black) are required: 1. If Industry Vertical is set to Other, the vertical must be speciﬁed in column C. 2. If Industry Vertical is set to Government, the following ﬁeld is requested: Does opportunity belong to NatSec? (column D). 3. If Country is set to United States, then State/province is required (column F). 4. If Solution oﬀered is set to Other, then Other Solution Oﬀered is required (Column M). 5. If you Choose Yes for Is Opportunity from Marketing Activity, Was Marketing Development Funds Used? is required (column U). 6. If Partner Primary Need From AWS is set to Co-Sell, then specify Sales Activities in (column W). 7. If Competitive Tracking is set to Other, then you must specify it in column AJ. 8. If the Excel template contains a Values tab, you can use it to complete the additional columns. Optional ﬁelds Field name (required) Description AWS products (column X) • Add the AWS product code from the Excel ﬁle in step 1. If you have multiple IDs, separate each one with a semicolon (;). Customer phone • Only numbers are allowed. Customer email • Must be a valid email address. AWS account ID • Must be a 12-digit number. If the ID starts with zero, reformat the cell as text. Additional comments • 255 characters maximum. State/province (pick-list value) • Required conditional ﬁeld. • State is a required ﬁeld when country is set to United States. • If you copy data from another ﬁle, paste it as text. 33 AWS Partner Central Sales Guide Field name (required) Description Street address and city • 255 alphanumeric characters maximum (each). Competitive tracking (pick-lis t value) • Required conditional ﬁelds. • Must map to a valid use case. Refer to the Values sheet for mapping. • If Other Competitors (column AI) is selected, column AJ is required (255 characters maximum). • Must map to a valid use case. Refer to the Values sheet for mapping. • The contact referenced in this ﬁeld is included in opportuni ty-related email notiﬁcations. Marketing development funded (pick-list value) Primary sales contact, ﬁrst name, last name, and title Primary contact phone • Only numbers allowed. Primary contact email • Must be a valid email address. Partner CRM unique identiﬁe r • Ensure that the value is unique for each opportunity or leave this ﬁeld blank so other users can save and submit records. Export opportunities The Bulk Export functionality allows a user to export up to 1,500 opportunities into a .csv ﬁle. AWS Opportunity referrals that have not been accepted will not appear in the export. To generate a ﬁle with your opportunities, choose Export Opportunities from the bulk-import dropdown list. Note You will export all ﬁltered opportunities in the currently selected view. Update opportunities The bulk-update function can export validated opportunities in bulk. This feature is designed to be scalable and to provide visibility of each engagement. 34 AWS Partner Central Sales Guide 1.
apc-sg-010	apc-sg.pdf	10	so other users can save and submit records. Export opportunities The Bulk Export functionality allows a user to export up to 1,500 opportunities into a .csv ﬁle. AWS Opportunity referrals that have not been accepted will not appear in the export. To generate a ﬁle with your opportunities, choose Export Opportunities from the bulk-import dropdown list. Note You will export all ﬁltered opportunities in the currently selected view. Update opportunities The bulk-update function can export validated opportunities in bulk. This feature is designed to be scalable and to provide visibility of each engagement. 34 AWS Partner Central Sales Guide 1. From the bulk-actions drop-down list, choose Update Opportunities. 2. Prepare the opportunities you want to update and download. Use ﬁlters to narrow the scope. 3. Choose Next. 4. Choose Download Prepared XLS ﬁle to generate and download your AWS opportunities. Acknowledge that there is a limit of 1,500 opportunities that can be downloaded. 5. Open the ﬁle in Excel, make any necessary changes, and save the ﬁle as a .csv. 6. Choose Upload File, choose your saved .csv ﬁle, and then choose Update. A popup window conﬁrms the process status. 7. Conﬁrm that you have prepared the .csv and are ready to upload it, and then choose Next. 8. Choose the ﬁle you prepared, and then choose Upload CSV File. 9. You will be redirected to the ACE Pipeline Manager. 10.When the bulk update completes, you will receive a notiﬁcation. Note To review your history of bulk updates and get detailed information, choose Go to Bulk Updates. Transfer lead and opportunity ownership Note A notiﬁcation conﬁrming the transfer is sent to both the Partner Users who transfer and receive the list view. For more information, refer to List Views and Creating Custom List Views. 1. Navigate to the view you want to transfer (for example, Choose the Opportunities tab if you want to transfer a custom list view for Opportunities and choose the Leads tab if you want to transfer a custom list view for Leads). 2. Choose the down arrow to reveal options to edit, transfer, and delete. If you are not in your custom view, choose the down arrow, and scroll to your desired view. To display further options, choose the vertical dots to the right of the desired view. Transfer lead and opportunity ownership 35 AWS Partner Central Sales Guide 3. Choose either option to transfer the view. 4. Enter the ﬁrst or last name to locate the partner user who you intend to receive the list view. Note Searching by only pasting an email may not identify the correct user. You can only transfer leads and opportunities to individuals who have been granted ACE Pipeline Manager User access. 5. Choose the partner user contact to conﬁrm, and then choose Save. 6. When you receive a popup that conﬁrms your transfer is complete, choose Done. 7. You will be redirected to the main ACE Pipeline Manager view where you can download a .csv of successful transfer and unsuccessful transfers. To choose an opportunity list to transfer from Pipeline Manager Users can select up to 100 leads or opportunities within their ACE Pipeline Manager and transfer them to another active user within their partner organization (alliance lead, alliance team, ACE manager, ACE user). Users can transfer leads or opportunities without creating a custom view. Alliance Leads retain access to all opportunities even after a view is transferred. Note A notiﬁcation that conﬁrms the transfer is sent to both the partner users who transfer and receive the opportunities or leads. Only opportunities with the following attributes can be transferred: Stage: Prospect, Qualiﬁed, Technical Validation, Business Validation, Committed (Not Launched or Closed/Lost) Status: Partner Originated Opportunities: Draft, Action Required, Approved AWS Referred Opportunities: Accept to View, Approved Only Leads with the following attributes can be transferred: Action: Update Transfer lead and opportunity ownership 36 AWS Partner Central Sales Guide To transfer leads or opportunities 1. Choose Bulk Transfer from the Bulk Actions dropdown list. 2. The number of records being transferred is displayed. Note If you don't choose an opportunity, all opportunities in the list view are transferred. Ensure that the number matches the number of opportunities chosen so that you don't unintentionally transfer a large number of opportunities. 3. Search for the user you want to transfer the opportunities to, and choose Transfer. The partner must enter the name of an active user within their partner organization in which they want to transfer opportunities. You can be in any of the following roles: alliance lead, alliance team, ACE manager, or ACE user. 4. You are redirected to the ACE Pipeline Manager and receive a notiﬁcation with the result of the transfer. Any opportunities that didn't transfer remain in the original owner’s name. 5. Choose any of the buttons to
apc-sg-011	apc-sg.pdf	11	you don't unintentionally transfer a large number of opportunities. 3. Search for the user you want to transfer the opportunities to, and choose Transfer. The partner must enter the name of an active user within their partner organization in which they want to transfer opportunities. You can be in any of the following roles: alliance lead, alliance team, ACE manager, or ACE user. 4. You are redirected to the ACE Pipeline Manager and receive a notiﬁcation with the result of the transfer. Any opportunities that didn't transfer remain in the original owner’s name. 5. Choose any of the buttons to download the opportunity transfer logs. 6. The error log provides the opportunity ID and reason for the failed transfer. Transfer lead and opportunity ownership 37 AWS Partner Central Search Sales Guide Use the search bar on the Leads and Opportunities tabs to ﬁnd records in the current list view. To search all records, ensure that you choose a list view that includes all records before searching. For more information about list views, refer to List views. 38 AWS Partner Central Sales Guide Document history for the AWS Partner Central Sales Guide The following table describes the documentation releases for AWS Partner Central Documentation. Change Description Date Feature release of multi-par tner opportunities Information added for sharing and accepting December 4, 2024 opportunities with multiple partners. Information added on connecting with other partners. Feature release of Slack collaboration Instructions added for slack collaboration channels. November 1, 2024 First release First release of the AWS Partner Central Sales Guide. November 2, 2023 39
api-reference-001	api-reference.pdf	1	Management API Reference Amazon FinSpace Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon FinSpace Management API Reference Amazon FinSpace: Management API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon FinSpace Table of Contents Management API Reference ......................................................................................................................................................... vi What is Amazon FinSpace ............................................................................................................... 1 API Operations by Topic ................................................................................................................. 2 Dataset browser environment operations ............................................................................................... 2 Managed kdb environment operations .................................................................................................... 2 Managed kdb database operations .......................................................................................................... 3 Managed kdb volumes operations ............................................................................................................ 3 Managed kdb scaling groups operations ................................................................................................. 3 Managed kdb cluster operations ............................................................................................................... 4 Tagging operations ...................................................................................................................................... 4 API Reference Index ........................................................................................................................ 5 Actions ............................................................................................................................................................ 5 CreateEnvironment ................................................................................................................................. 8 CreateKxChangeset ............................................................................................................................... 14 CreateKxCluster ..................................................................................................................................... 21 CreateKxDatabase ................................................................................................................................. 39 CreateKxDataview ................................................................................................................................. 45 CreateKxEnvironment ........................................................................................................................... 55 CreateKxScalingGroup .......................................................................................................................... 61 CreateKxUser .......................................................................................................................................... 68 CreateKxVolume .................................................................................................................................... 73 DeleteEnvironment ............................................................................................................................... 81 DeleteKxCluster ..................................................................................................................................... 84 DeleteKxClusterNode ............................................................................................................................ 87 DeleteKxDatabase ................................................................................................................................. 90 DeleteKxDataview ................................................................................................................................. 93 DeleteKxEnvironment ........................................................................................................................... 96 DeleteKxScalingGroup .......................................................................................................................... 99 DeleteKxUser ....................................................................................................................................... 102 DeleteKxVolume .................................................................................................................................. 105 GetEnvironment .................................................................................................................................. 108 GetKxChangeset .................................................................................................................................. 111 GetKxCluster ........................................................................................................................................ 116 GetKxConnectionString ..................................................................................................................... 126 iii Amazon FinSpace Management API Reference GetKxDatabase .................................................................................................................................... 129 GetKxDataview .................................................................................................................................... 134 GetKxEnvironment .............................................................................................................................. 141 GetKxScalingGroup ............................................................................................................................. 148 GetKxUser ............................................................................................................................................. 154 GetKxVolume ....................................................................................................................................... 158 ListEnvironments ................................................................................................................................ 164 ListKxChangesets ................................................................................................................................ 168 ListKxClusterNodes ............................................................................................................................. 172 ListKxClusters ...................................................................................................................................... 176 ListKxDatabases .................................................................................................................................. 181 ListKxDataviews ................................................................................................................................... 184 ListKxEnvironments ............................................................................................................................ 188 ListKxScalingGroups ........................................................................................................................... 192 ListKxUsers ........................................................................................................................................... 196 ListKxVolumes ..................................................................................................................................... 200 ListTagsForResource ........................................................................................................................... 204 TagResource ......................................................................................................................................... 207 UntagResource .................................................................................................................................... 210 UpdateEnvironment ........................................................................................................................... 213 UpdateKxClusterCodeConﬁguration ............................................................................................... 218 UpdateKxClusterDatabases ............................................................................................................... 223 UpdateKxDatabase ............................................................................................................................. 228 UpdateKxDataview ............................................................................................................................. 233 UpdateKxEnvironment ....................................................................................................................... 241 UpdateKxEnvironmentNetwork ....................................................................................................... 249 UpdateKxUser ...................................................................................................................................... 257 UpdateKxVolume ................................................................................................................................ 262 Data Types ................................................................................................................................................. 268 AutoScalingConﬁguration ................................................................................................................. 271 CapacityConﬁguration ....................................................................................................................... 274 ChangeRequest .................................................................................................................................... 276 CodeConﬁguration .............................................................................................................................. 278 CustomDNSServer .............................................................................................................................. 280 Environment ......................................................................................................................................... 282 ErrorInfo ................................................................................................................................................ 286 iv Amazon FinSpace Management API Reference FederationParameters ........................................................................................................................ 288 IcmpTypeCode ..................................................................................................................................... 291 KxAttachedCluster .............................................................................................................................. 292 KxCacheStorageConﬁguration ......................................................................................................... 294 KxChangesetListEntry ........................................................................................................................ 296 KxCluster ............................................................................................................................................... 298 KxClusterCodeDeploymentConﬁguration ...................................................................................... 303 KxCommandLineArgument ............................................................................................................... 305 KxDatabaseCacheConﬁguration ....................................................................................................... 307 KxDatabaseConﬁguration ................................................................................................................. 309 KxDatabaseListEntry .......................................................................................................................... 311 KxDataviewActiveVersion .................................................................................................................. 313 KxDataviewConﬁguration .................................................................................................................. 315 KxDataviewListEntry .......................................................................................................................... 317 KxDataviewSegmentConﬁguration ................................................................................................. 322 KxDeploymentConﬁguration ............................................................................................................ 324 KxEnvironment .................................................................................................................................... 326 KxNAS1Conﬁguration ........................................................................................................................ 331 KxNode .................................................................................................................................................. 333 KxSavedownStorageConﬁguration .................................................................................................. 335 KxScalingGroup ................................................................................................................................... 337 KxScalingGroupConﬁguration .......................................................................................................... 340 KxUser ................................................................................................................................................... 342 KxVolume ............................................................................................................................................. 344 NetworkACLEntry ................................................................................................................................ 347 PortRange ............................................................................................................................................. 349 SuperuserParameters ......................................................................................................................... 350 TickerplantLogConﬁguration ............................................................................................................ 352 TransitGatewayConﬁguration ........................................................................................................... 353 Volume .................................................................................................................................................. 355 VpcConﬁguration ................................................................................................................................ 357 Common Errors ........................................................................................................................................ 358 Common Parameters ............................................................................................................................... 360 AWS Glossary ............................................................................................................................... 363 v Amazon FinSpace Management API Reference Amazon FinSpace Dataset Browser will be discontinued on November 29, 2024. Starting November 29, 2023, FinSpace will no longer accept the creation of new Dataset Browser environments. Customers using Amazon FinSpace with Managed Kdb Insights will not be aﬀected. For more information, review the FAQ or contact AWS Support to assist with your transition. vi Amazon FinSpace Management API Reference What is Amazon FinSpace Amazon FinSpace is a data management and analytics service for the ﬁnancial services industry (FSI). It reduces the time to ﬁnd and prepare all types of ﬁnancial data to be ready for analysis from months to minutes. FinSpace is a fully managed data management and analytics service that makes it easy to store, catalog, and prepare ﬁnancial industry data at scale. FinSpace provides a Managed kdb Insights analytics engine powered by the industry recognized kdb analytics engine. It also features the Dataset browser that you can use to collect data and catalog it by relevant business concepts such as asset class, risk classiﬁcation, or geographic region. This API Reference provides descriptions, syntax, and usage examples for each of the operations and data types for use of FinSpace. You can use the API operations to programmatically expand and manage your FinSpace deployments. You can also use one of the AWS SDKs to access an API operation that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs. 1 Amazon FinSpace Management API Reference API Operations by Topic Use this section to locate API operations by topic. Topics • Dataset browser environment operations • Managed kdb environment operations • Managed kdb database operations • Managed kdb volumes operations • Managed kdb scaling groups operations • Managed kdb cluster operations • Tagging operations Dataset browser environment operations The API operations in this section control FinSpace environment. • CreateEnvironment • ListEnvironments • GetEnvironment • DeleteEnvironment • UpdateEnvironment Managed kdb environment operations The API operations in this
api-reference-002	api-reference.pdf	2	the programming language or platform that you're using. For more information, see AWS SDKs. 1 Amazon FinSpace Management API Reference API Operations by Topic Use this section to locate API operations by topic. Topics • Dataset browser environment operations • Managed kdb environment operations • Managed kdb database operations • Managed kdb volumes operations • Managed kdb scaling groups operations • Managed kdb cluster operations • Tagging operations Dataset browser environment operations The API operations in this section control FinSpace environment. • CreateEnvironment • ListEnvironments • GetEnvironment • DeleteEnvironment • UpdateEnvironment Managed kdb environment operations The API operations in this section control Managed kdb environment. • CreateKxEnvironment • UpdateKxEnvironment • DeleteKxEnvironment • GetKxEnvironment • ListKxEnvironments • UpdateKxEnvironmentNetwork Dataset browser environment operations 2 Amazon FinSpace Management API Reference Managed kdb database operations The API operations in this section control Managed kdb database. • CreateKxDatabase • UpdateKxDatabase • DeleteKxDatabase • GetKxDatabase • ListKxDatabases • CreateKxChangeset • GetKxChangeset • ListKxChangesets • CreateKxDataview • DeleteKxDataview • GetKxDataview • ListKxDataviews • UpdateKxDataview Managed kdb volumes operations The API operations in this section control Managed kdb volumes. • CreateKxVolume • DeleteKxVolume • GetKxVolume • ListKxVolumes • UpdateKxVolume Managed kdb scaling groups operations The API operations in this section control Managed kdb scaling groups. • CreateKxScalingGroup Managed kdb database operations 3 Management API Reference Amazon FinSpace • DeleteKxScalingGroup • GetKxScalingGroup • ListKxScalingGroups Managed kdb cluster operations The API operations in this section control Managed kdb cluster. • CreateKxCluster • DeleteKxCluster • GetKxCluster • ListKxClusters • ListKxClusterNodes • DeleteKxClusterNode • UpdateKxClusterCodeConﬁguration • UpdateKxClusterDatabases • CreateKxUser • DeleteKxUser • GetKxUser • ListKxUsers • UpdateKxUser Tagging operations The API operations in this section control tagging in FinSpace. • TagResource • UntagResource • ListTagsForResource Managed kdb cluster operations 4 Amazon FinSpace Management API Reference API Reference Index This section contains the API Reference documentation. Topics • Actions • Data Types • Common Errors • Common Parameters Actions The following actions are supported: • CreateEnvironment • CreateKxChangeset • CreateKxCluster • CreateKxDatabase • CreateKxDataview • CreateKxEnvironment • CreateKxScalingGroup • CreateKxUser • CreateKxVolume • DeleteEnvironment • DeleteKxCluster • DeleteKxClusterNode • DeleteKxDatabase • DeleteKxDataview • DeleteKxEnvironment • DeleteKxScalingGroup • DeleteKxUser • DeleteKxVolume Actions 5 Management API Reference Amazon FinSpace • GetEnvironment • GetKxChangeset • GetKxCluster • GetKxConnectionString • GetKxDatabase • GetKxDataview • GetKxEnvironment • GetKxScalingGroup • GetKxUser • GetKxVolume • ListEnvironments • ListKxChangesets • ListKxClusterNodes • ListKxClusters • ListKxDatabases • ListKxDataviews • ListKxEnvironments • ListKxScalingGroups • ListKxUsers • ListKxVolumes • ListTagsForResource • TagResource • UntagResource • UpdateEnvironment • UpdateKxClusterCodeConﬁguration • UpdateKxClusterDatabases • UpdateKxDatabase • UpdateKxDataview • UpdateKxEnvironment • UpdateKxEnvironmentNetwork Actions 6 Amazon FinSpace • UpdateKxUser • UpdateKxVolume Management API Reference Actions 7 Management API Reference Amazon FinSpace CreateEnvironment Create a new FinSpace environment. Request Syntax POST /environment HTTP/1.1 Content-type: application/json { "dataBundles": [ "string" ], "description": "string", "federationMode": "string", "federationParameters": { "applicationCallBackURL": "string", "attributeMap": { "string" : "string" }, "federationProviderName": "string", "federationURN": "string", "samlMetadataDocument": "string", "samlMetadataURL": "string" }, "kmsKeyId": "string", "name": "string", "superuserParameters": { "emailAddress": "string", "firstName": "string", "lastName": "string" }, "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. CreateEnvironment 8 Amazon FinSpace name Management API Reference The name of the FinSpace environment to be created. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-][a-zA-Z0-9]$ Required: Yes dataBundles The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs: • arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies. • arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data. Type: Array of strings Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d:data-bundle/[0-9A-Za- z_-]{1,128}$ Required: No description The description of the FinSpace environment to be created. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ Required: No federationMode Authentication mode for the environment. CreateEnvironment 9 Amazon FinSpace Management API Reference • FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider. • LOCAL - Users access FinSpace via email and password managed within the FinSpace environment. Type: String Valid Values: FEDERATED \| LOCAL Required: No federationParameters Conﬁguration information when authentication mode is FEDERATED. Type: FederationParameters object Required: No kmsKeyId The KMS key id to encrypt your data in the FinSpace environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z-0-9-:\/]*$ Required: No superuserParameters Conﬁguration information for the superuser. Type: SuperuserParameters object Required: No tags Add tags to your FinSpace environment. Type: String to string map Map Entries: Maximum number of 50 items. CreateEnvironment 10 Amazon FinSpace Management API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum
api-reference-003	api-reference.pdf	3	LOCAL Required: No federationParameters Conﬁguration information when authentication mode is FEDERATED. Type: FederationParameters object Required: No kmsKeyId The KMS key id to encrypt your data in the FinSpace environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z-0-9-:\/]$ Required: No superuserParameters Conﬁguration information for the superuser. Type: SuperuserParameters object Required: No tags Add tags to your FinSpace environment. Type: String to string map Map Entries: Maximum number of 50 items. CreateEnvironment 10 Amazon FinSpace Management API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "environmentArn": "string", "environmentId": "string", "environmentUrl": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. environmentArn The Amazon Resource Name (ARN) of the FinSpace environment that you created. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za- z_-]{1,128}$ environmentId The unique identiﬁer for FinSpace environment that you created. Type: String CreateEnvironment 11 Amazon FinSpace Management API Reference Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]{1,26}$ environmentUrl The sign-in URL for the web application of the FinSpace environment you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^https?://[-a-zA-Z0-9+&@#/%?=~_\|!:,.;][-a-zA-Z0-9+&@#/%=~_\|] Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase. HTTP Status Code: 402 ThrottlingException The request was denied due to request throttling. CreateEnvironment 12 Amazon FinSpace HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. Management API Reference HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateEnvironment 13 Amazon FinSpace CreateKxChangeset Management API Reference Creates a changeset for a kdb database. A changeset allows you to add and delete existing ﬁles by using an ordered list of change requests. Request Syntax POST /kx/environments/environmentId/databases/databaseName/changesets HTTP/1.1 Content-type: application/json { "changeRequests": [ { "changeType": "string", "dbPath": "string", "s3Path": "string" } ], "clientToken": "string" } URI Request Parameters The request uses the following URI parameters. databaseName The name of the kdb database. Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes environmentId A unique identiﬁer of the kdb environment. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S.* Required: Yes CreateKxChangeset 14 Amazon FinSpace Request Body The request accepts the following data in JSON format. changeRequests Management API Reference A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values: • PUT – Adds or updates ﬁles in a database. • DELETE – Deletes ﬁles in a database. All the change requests require a mandatory dbPath attribute that deﬁnes the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute deﬁnes the s3 source ﬁle path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a ﬁle. Here are few examples of how you can use the change request object: 1. This request adds a single sym ﬁle at database root location. { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"} 2. This request adds ﬁles in the given s3Path under the 2020.01.02 partition of the database. { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"} 3. This request adds ﬁles in the given s3Path under the taq table partition of the database. [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] 4. This request deletes the 2020.01.02 partition of the database. [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ] 5. The DELETE request allows you to delete the existing ﬁles under the 2020.01.02 partition of the database, and
api-reference-004	api-reference.pdf	4	the change request object: 1. This request adds a single sym ﬁle at database root location. { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"} 2. This request adds ﬁles in the given s3Path under the 2020.01.02 partition of the database. { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"} 3. This request adds ﬁles in the given s3Path under the taq table partition of the database. [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] 4. This request deletes the 2020.01.02 partition of the database. [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ] 5. The DELETE request allows you to delete the existing ﬁles under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it. [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] CreateKxChangeset 15 Amazon FinSpace Management API Reference Type: Array of ChangeRequest objects Array Members: Minimum number of 1 item. Maximum number of 32 items. Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "changeRequests": [ { "changeType": "string", "dbPath": "string", "s3Path": "string" } ], "changesetId": "string", "createdTimestamp": number, "databaseName": "string", "environmentId": "string", "errorInfo": { "errorMessage": "string", "errorType": "string" }, "lastModifiedTimestamp": number, "status": "string" } CreateKxChangeset 16 Amazon FinSpace Response Elements Management API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. changeRequests A list of change requests. Type: Array of ChangeRequest objects Array Members: Minimum number of 1 item. Maximum number of 32 items. changesetId A unique identiﬁer for the changeset. Type: String Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]+$ createdTimestamp The timestamp at which the changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp databaseName The name of the kdb database. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ environmentId A unique identiﬁer for the kdb environment. CreateKxChangeset 17 Amazon FinSpace Type: String Management API Reference Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S.* errorInfo The details of the error that you receive when creating a changeset. It consists of the type of error and the error message. Type: ErrorInfo object lastModiﬁedTimestamp The timestamp at which the changeset was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp status Status of the changeset creation process. • Pending – Changeset creation is pending. • Processing – Changeset creation is running. • Failed – Changeset creation has failed. • Complete – Changeset creation has succeeded. Type: String Valid Values: PENDING \| PROCESSING \| FAILED \| COMPLETED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 CreateKxChangeset 18 Amazon FinSpace ConﬂictException Management API Reference There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ResourceNotFoundException One or more resources can't be found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateKxChangeset 19 Amazon FinSpace • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Management API Reference CreateKxChangeset 20 Management API Reference Amazon FinSpace CreateKxCluster Creates a new kdb cluster. Request Syntax POST /kx/environments/environmentId/clusters HTTP/1.1 Content-type: application/json { "autoScalingConfiguration": { "autoScalingMetric": "string", "maxNodeCount": number, "metricTarget": number, "minNodeCount": number, "scaleInCooldownSeconds": number, "scaleOutCooldownSeconds": number }, "availabilityZoneId": "string", "azMode": "string", "cacheStorageConfigurations": [ { "size": number, "type": "string" } ], "capacityConfiguration": { "nodeCount": number, "nodeType": "string" }, "clientToken": "string", "clusterDescription": "string", "clusterName": "string", "clusterType": "string", "code": { "s3Bucket": "string", "s3Key": "string", "s3ObjectVersion": "string" }, "commandLineArguments": [ { "key": "string", "value": "string" CreateKxCluster 21 Amazon FinSpace } ], "databases": [ { "cacheConfigurations": [ { "cacheType": "string", "dataviewName": "string", "dbPaths": [ "string" ] } ], "changesetId": "string", "databaseName": "string",
api-reference-005	api-reference.pdf	5	FinSpace CreateKxCluster Creates a new kdb cluster. Request Syntax POST /kx/environments/environmentId/clusters HTTP/1.1 Content-type: application/json { "autoScalingConfiguration": { "autoScalingMetric": "string", "maxNodeCount": number, "metricTarget": number, "minNodeCount": number, "scaleInCooldownSeconds": number, "scaleOutCooldownSeconds": number }, "availabilityZoneId": "string", "azMode": "string", "cacheStorageConfigurations": [ { "size": number, "type": "string" } ], "capacityConfiguration": { "nodeCount": number, "nodeType": "string" }, "clientToken": "string", "clusterDescription": "string", "clusterName": "string", "clusterType": "string", "code": { "s3Bucket": "string", "s3Key": "string", "s3ObjectVersion": "string" }, "commandLineArguments": [ { "key": "string", "value": "string" CreateKxCluster 21 Amazon FinSpace } ], "databases": [ { "cacheConfigurations": [ { "cacheType": "string", "dataviewName": "string", "dbPaths": [ "string" ] } ], "changesetId": "string", "databaseName": "string", "dataviewConfiguration": { "changesetId": "string", "dataviewName": "string", "dataviewVersionId": "string", "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ] }, "dataviewName": "string" } ], "executionRole": "string", "initializationScript": "string", "releaseLabel": "string", "savedownStorageConfiguration": { "size": number, "type": "string", "volumeName": "string" }, "scalingGroupConfiguration": { "cpu": number, "memoryLimit": number, "memoryReservation": number, "nodeCount": number, "scalingGroupName": "string" }, "tags": { CreateKxCluster Management API Reference 22 Amazon FinSpace Management API Reference "string" : "string" }, "tickerplantLogConfiguration": { "tickerplantLogVolumes": [ "string" ] }, "vpcConfiguration": { "ipAddressType": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } URI Request Parameters The request uses the following URI parameters. environmentId A unique identiﬁer for the kdb environment. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-z0-9]+$ Required: Yes Request Body The request accepts the following data in JSON format. azMode The number of availability zones you want to assign per cluster. This can be one of the following • SINGLE – Assigns one availability zone per cluster. • MULTI – Assigns all the availability zones per cluster. Type: String Valid Values: SINGLE \| MULTI CreateKxCluster 23 Management API Reference Amazon FinSpace Required: Yes clusterName A unique name for the cluster that you want to create. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes clusterType Speciﬁes the type of KDB database that is being created. The following types are available: • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this ﬁeld in your request, you must provide the savedownStorageConfiguration parameter. • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage. • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is ﬁxed at 1. It does not support autoscaling and supports only SINGLE AZ mode. • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. Type: String Valid Values: HDB \| RDB \| GATEWAY \| GP \| TICKERPLANT CreateKxCluster 24 Management API Reference Amazon FinSpace Required: Yes releaseLabel The version of FinSpace managed kdb to run. Type: String Length Constraints: Minimum length of 1. Maximum length of 16. Pattern: ^[a-zA-Z0-9._-]+$ Required: Yes vpcConﬁguration Conﬁguration details about the network where the Privatelink endpoint of the cluster resides. Type: VpcConﬁguration object Required: Yes autoScalingConﬁguration The conﬁguration based on which FinSpace will scale in or scale out nodes in your cluster. Type: AutoScalingConﬁguration object Required: No availabilityZoneId The availability zone identiﬁers for the requested regions. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ Required: No cacheStorageConﬁgurations The conﬁgurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. CreateKxCluster 25 Amazon FinSpace Management API Reference Type: Array of KxCacheStorageConﬁguration objects Required: No capacityConﬁguration A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances. Type: CapacityConﬁguration object Required: No clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S.*
api-reference-006	api-reference.pdf	6	Pattern: ^[a-zA-Z0-9-]+$ Required: No cacheStorageConﬁgurations The conﬁgurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. CreateKxCluster 25 Amazon FinSpace Management API Reference Type: Array of KxCacheStorageConﬁguration objects Required: No capacityConﬁguration A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances. Type: CapacityConﬁguration object Required: No clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S. Required: No clusterDescription A description of the cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9\_\-\.\s]+$ Required: No code The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. Type: CodeConﬁguration object Required: No CreateKxCluster 26 Amazon FinSpace commandLineArguments Management API Reference Deﬁnes the key-value pairs to make them available inside the cluster. Duplicate keys are not allowed. To send a list of values for the same command line argument (key), use a space delimited list of values for the key. Type: Array of KxCommandLineArgument objects Required: No databases A list of databases that will be available for querying. Type: Array of KxDatabaseConﬁguration objects Required: No executionRole An IAM role that deﬁnes a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^arn:aws[a-z0-9-]*:iam::\d{12}:role\/[\w-\/.@+=,]{1,1017}$ Required: No initializationScript Speciﬁes a Q program that will be run at launch of a cluster. It is a relative path within .zip ﬁle that contains the custom code, which will be loaded on the cluster. It must include the ﬁle name itself. For example, somedir/init.q. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9\_\-\.\/\\]+$ Required: No CreateKxCluster 27 Amazon FinSpace Management API Reference savedownStorageConﬁguration The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted. Type: KxSavedownStorageConﬁguration object Required: No scalingGroupConﬁguration The structure that stores the conﬁguration details of a scaling group. Type: KxScalingGroupConﬁguration object Required: No tags A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ Required: No tickerplantLogConﬁguration A conﬁguration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. Type: TickerplantLogConﬁguration object Required: No CreateKxCluster 28 Amazon FinSpace Response Syntax HTTP/1.1 200 Content-type: application/json { "autoScalingConfiguration": { "autoScalingMetric": "string", "maxNodeCount": number, "metricTarget": number, "minNodeCount": number, "scaleInCooldownSeconds": number, "scaleOutCooldownSeconds": number }, "availabilityZoneId": "string", "azMode": "string", "cacheStorageConfigurations": [ { "size": number, "type": "string" } ], "capacityConfiguration": { "nodeCount": number, "nodeType": "string" }, "clusterDescription": "string", "clusterName": "string", "clusterType": "string", "code": { "s3Bucket": "string", "s3Key": "string", "s3ObjectVersion": "string" }, "commandLineArguments": [ { "key": "string", "value": "string" } ], "createdTimestamp": number, "databases": [ { CreateKxCluster Management API Reference 29 Amazon FinSpace Management API Reference "cacheConfigurations": [ { "cacheType": "string", "dataviewName": "string", "dbPaths": [ "string" ] } ], "changesetId": "string", "databaseName": "string", "dataviewConfiguration": { "changesetId": "string", "dataviewName": "string", "dataviewVersionId": "string", "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ] }, "dataviewName": "string" } ], "environmentId": "string", "executionRole": "string", "initializationScript": "string", "lastModifiedTimestamp": number, "releaseLabel": "string", "savedownStorageConfiguration": { "size": number, "type": "string", "volumeName": "string" }, "scalingGroupConfiguration": { "cpu": number, "memoryLimit": number, "memoryReservation": number, "nodeCount": number, "scalingGroupName": "string" }, "status": "string", "statusReason": "string", "tickerplantLogConfiguration": { CreateKxCluster 30 Amazon FinSpace Management API Reference "tickerplantLogVolumes": [ "string" ] }, "volumes": [ { "volumeName": "string", "volumeType": "string" } ], "vpcConfiguration": { "ipAddressType": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. autoScalingConﬁguration The conﬁguration based on which FinSpace will scale in or scale out nodes in your cluster. Type: AutoScalingConﬁguration object availabilityZoneId The availability zone identiﬁers for the requested regions. Type: String Length Constraints: Minimum length of 8. Maximum
api-reference-007	api-reference.pdf	7	30 Amazon FinSpace Management API Reference "tickerplantLogVolumes": [ "string" ] }, "volumes": [ { "volumeName": "string", "volumeType": "string" } ], "vpcConfiguration": { "ipAddressType": "string", "securityGroupIds": [ "string" ], "subnetIds": [ "string" ], "vpcId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. autoScalingConﬁguration The conﬁguration based on which FinSpace will scale in or scale out nodes in your cluster. Type: AutoScalingConﬁguration object availabilityZoneId The availability zone identiﬁers for the requested regions. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ azMode The number of availability zones you want to assign per cluster. This can be one of the following • SINGLE – Assigns one availability zone per cluster. • MULTI – Assigns all the availability zones per cluster. CreateKxCluster 31 Amazon FinSpace Type: String Valid Values: SINGLE \| MULTI cacheStorageConﬁgurations Management API Reference The conﬁgurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. Type: Array of KxCacheStorageConﬁguration objects capacityConﬁguration A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances. Type: CapacityConﬁguration object clusterDescription A description of the cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9\_\-\.\s]+$ clusterName A unique name for the cluster. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ clusterType Speciﬁes the type of KDB database that is being created. The following types are available: • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster. • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk CreateKxCluster 32 Amazon FinSpace Management API Reference and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this ﬁeld in your request, you must provide the savedownStorageConfiguration parameter. • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage. • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is ﬁxed at 1. It does not support autoscaling and supports only SINGLE AZ mode. • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. Type: String Valid Values: HDB \| RDB \| GATEWAY \| GP \| TICKERPLANT code The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster. Type: CodeConﬁguration object commandLineArguments Deﬁnes the key-value pairs to make them available inside the cluster. Duplicate keys are not allowed. To send a list of values for the same command line argument (key), use a space delimited list of values for the key. Type: Array of KxCommandLineArgument objects createdTimestamp The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. CreateKxCluster 33 Management API Reference Amazon FinSpace Type: Timestamp databases A list of databases that will be available for querying. Type: Array of KxDatabaseConﬁguration objects environmentId A unique identiﬁer for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-z0-9]+$ executionRole An IAM role that deﬁnes a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^arn:aws[a-z0-9-]:iam::\d{12}:role\/[\w-\/.@+=,]{1,1017}$ initializationScript Speciﬁes a Q program that will be run at launch of a cluster. It is a relative path within .zip ﬁle that contains the custom code, which will be loaded on the cluster. It
api-reference-008	api-reference.pdf	8	of KxDatabaseConﬁguration objects environmentId A unique identiﬁer for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-z0-9]+$ executionRole An IAM role that deﬁnes a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^arn:aws[a-z0-9-]:iam::\d{12}:role\/[\w-\/.@+=,]{1,1017}$ initializationScript Speciﬁes a Q program that will be run at launch of a cluster. It is a relative path within .zip ﬁle that contains the custom code, which will be loaded on the cluster. It must include the ﬁle name itself. For example, somedir/init.q. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9\_\-\.\/\\]+$ lastModiﬁedTimestamp The last time that the cluster was modiﬁed. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. CreateKxCluster 34 Management API Reference Amazon FinSpace Type: Timestamp releaseLabel A version of the FinSpace managed kdb to run. Type: String Length Constraints: Minimum length of 1. Maximum length of 16. Pattern: ^[a-zA-Z0-9._-]+$ savedownStorageConﬁguration The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted. Type: KxSavedownStorageConﬁguration object scalingGroupConﬁguration The structure that stores the conﬁguration details of a scaling group. Type: KxScalingGroupConﬁguration object status The status of cluster creation. • PENDING – The cluster is pending creation. • CREATING – The cluster creation process is in progress. • CREATE_FAILED – The cluster creation process has failed. • RUNNING – The cluster creation process is running. • UPDATING – The cluster is in the process of being updated. • DELETING – The cluster is in the process of being deleted. • DELETED – The cluster has been deleted. • DELETE_FAILED – The cluster failed to delete. Type: String Valid Values: PENDING \| CREATING \| CREATE_FAILED \| RUNNING \| UPDATING \| DELETING \| DELETED \| DELETE_FAILED CreateKxCluster 35 Amazon FinSpace statusReason Management API Reference The error message when a failed state occurs. Type: String Length Constraints: Minimum length of 1. Maximum length of 250. Pattern: ^[a-zA-Z0-9\_\-\.\s]+$ tickerplantLogConﬁguration A conﬁguration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. Type: TickerplantLogConﬁguration object volumes A list of volumes mounted on the cluster. Type: Array of Volume objects Array Members: Minimum number of 0 items. Maximum number of 5 items. vpcConﬁguration Conﬁguration details about the network where the Privatelink endpoint of the cluster resides. Type: VpcConﬁguration object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 AccessDeniedException You do not have suﬃcient access to perform this action. CreateKxCluster 36 Amazon FinSpace HTTP Status Code: 403 ConﬂictException Management API Reference There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ResourceNotFoundException One or more resources can't be found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ CreateKxCluster 37 Management API Reference Amazon FinSpace • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateKxCluster 38 Management API Reference Amazon FinSpace CreateKxDatabase Creates a new kdb database in the environment. Request Syntax POST /kx/environments/environmentId/databases HTTP/1.1 Content-type: application/json { "clientToken": "string", "databaseName": "string", "description": "string", "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. environmentId A unique identiﬁer for the kdb environment. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S.* Required: Yes Request Body The request accepts the following data in JSON format. clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String CreateKxDatabase 39 Amazon FinSpace Management API Reference Length
api-reference-009	api-reference.pdf	9	Management API Reference Amazon FinSpace CreateKxDatabase Creates a new kdb database in the environment. Request Syntax POST /kx/environments/environmentId/databases HTTP/1.1 Content-type: application/json { "clientToken": "string", "databaseName": "string", "description": "string", "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. environmentId A unique identiﬁer for the kdb environment. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S. Required: Yes Request Body The request accepts the following data in JSON format. clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String CreateKxDatabase 39 Amazon FinSpace Management API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes databaseName The name of the kdb database. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes description A description of the database. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ Required: No tags A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ CreateKxDatabase 40 Management API Reference Amazon FinSpace Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "createdTimestamp": number, "databaseArn": "string", "databaseName": "string", "description": "string", "environmentId": "string", "lastModifiedTimestamp": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. createdTimestamp The timestamp at which the database is created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp databaseArn The ARN identiﬁer of the database. Type: String databaseName The name of the kdb database. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. CreateKxDatabase 41 Amazon FinSpace Management API Reference Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ description A description of the database. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ environmentId A unique identiﬁer for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S. lastModiﬁedTimestamp The last time that the database was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 CreateKxDatabase 42 Amazon FinSpace InternalServerException Management API Reference The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource group already exists. HTTP Status Code: 409 ResourceNotFoundException One or more resources can't be found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 CreateKxDatabase 43 Amazon FinSpace • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Management API Reference CreateKxDatabase 44 Amazon FinSpace CreateKxDataview Management API Reference Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters. Request Syntax POST /kx/environments/environmentId/databases/databaseName/dataviews HTTP/1.1 Content-type: application/json { "autoUpdate": boolean, "availabilityZoneId": "string", "azMode": "string", "changesetId": "string", "clientToken": "string", "dataviewName": "string", "description": "string", "readWrite": boolean, "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ], "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. databaseName The name of the database where you want to create a dataview. Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$ CreateKxDataview 45 Amazon FinSpace Required: Yes environmentId Management API Reference A unique identiﬁer for the kdb environment, where you want to create the
api-reference-010	api-reference.pdf	10	POST /kx/environments/environmentId/databases/databaseName/dataviews HTTP/1.1 Content-type: application/json { "autoUpdate": boolean, "availabilityZoneId": "string", "azMode": "string", "changesetId": "string", "clientToken": "string", "dataviewName": "string", "description": "string", "readWrite": boolean, "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ], "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. databaseName The name of the database where you want to create a dataview. Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ CreateKxDataview 45 Amazon FinSpace Required: Yes environmentId Management API Reference A unique identiﬁer for the kdb environment, where you want to create the dataview. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S.* Required: Yes Request Body The request accepts the following data in JSON format. azMode The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. Type: String Valid Values: SINGLE \| MULTI Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes dataviewName A unique identiﬁer for the dataview. Type: String CreateKxDataview 46 Amazon FinSpace Management API Reference Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$ Required: Yes autoUpdate The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false. Type: Boolean Required: No availabilityZoneId The identiﬁer of the availability zones. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ Required: No changesetId A unique identiﬁer of the changeset that you want to use to ingest data. Type: String Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]+$ Required: No description A description of the dataview. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. CreateKxDataview 47 Amazon FinSpace Management API Reference Pattern: ^[a-zA-Z0-9. ]{1,1000}$ Required: No readWrite The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews. • You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path. • You cannot perform updates on a writeable dataview. Hence, autoUpdate must be set as False if readWrite is True for a dataview. • You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails. • Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the readWrite parameter later. Type: Boolean Required: No segmentConﬁgurations The conﬁguration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. Type: Array of KxDataviewSegmentConﬁguration objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No tags A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview. Type: String to string map Map Entries: Maximum number of 50 items. CreateKxDataview 48 Amazon FinSpace Management API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "autoUpdate": boolean, "availabilityZoneId": "string", "azMode": "string", "changesetId": "string", "createdTimestamp": number, "databaseName": "string", "dataviewName": "string", "description": "string", "environmentId": "string", "lastModifiedTimestamp": number, "readWrite": boolean, "segmentConfigurations": [ { "dbPaths": [ "string" ], "onDemand": boolean, "volumeName": "string" } ], "status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreateKxDataview 49 Amazon FinSpace autoUpdate Management API Reference The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false. Type: Boolean availabilityZoneId The identiﬁer of the availability zones. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ azMode The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. Type: String Valid Values: SINGLE \| MULTI changesetId A unique identiﬁer for the changeset. Type: String Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]+$ createdTimestamp The timestamp at which the dataview was created
api-reference-011	api-reference.pdf	11	automatically to the dataview when you ingest new changesets. The default value is false. Type: Boolean availabilityZoneId The identiﬁer of the availability zones. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ azMode The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. Type: String Valid Values: SINGLE \| MULTI changesetId A unique identiﬁer for the changeset. Type: String Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]+$ createdTimestamp The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp databaseName The name of the database where you want to create a dataview. CreateKxDataview 50 Amazon FinSpace Type: String Management API Reference Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ dataviewName A unique identiﬁer for the dataview. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ description A description of the dataview. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ environmentId A unique identiﬁer for the kdb environment, where you want to create the dataview. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: .\S. lastModiﬁedTimestamp The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp readWrite Returns True if the dataview is created as writeable and False otherwise. CreateKxDataview 51 Amazon FinSpace Type: Boolean segmentConﬁgurations Management API Reference The conﬁguration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment. Type: Array of KxDataviewSegmentConﬁguration objects Array Members: Minimum number of 0 items. Maximum number of 50 items. status The status of dataview creation. • CREATING – The dataview creation is in progress. • UPDATING – The dataview is in the process of being updated. • ACTIVE – The dataview is active. Type: String Valid Values: CREATING \| ACTIVE \| UPDATING \| FAILED \| DELETING Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 InternalServerException The request processing has failed because of an unknown error, exception or failure. CreateKxDataview 52 Management API Reference Amazon FinSpace HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ResourceAlreadyExistsException The speciﬁed resource group already exists. HTTP Status Code: 409 ResourceNotFoundException One or more resources can't be found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 CreateKxDataview 53 Amazon FinSpace • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Management API Reference CreateKxDataview 54 Amazon FinSpace Management API Reference CreateKxEnvironment Creates a managed kdb environment for the account. Request Syntax POST /kx/environments HTTP/1.1 Content-type: application/json { "clientToken": "string", "description": "string", "kmsKeyId": "string", "name": "string", "tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. kmsKeyId The KMS key ID to encrypt your data in the FinSpace environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^arn:aws:kms:.:\d+:.$ Required: Yes name The name of the kdb environment that you want to create. CreateKxEnvironment 55 Amazon FinSpace Type: String Management API Reference Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S.* Required: No description A description for the kdb environment. Type: String Length Constraints: Minimum length of 1.
api-reference-012	api-reference.pdf	12	your data in the FinSpace environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^arn:aws:kms:.:\d+:.$ Required: Yes name The name of the kdb environment that you want to create. CreateKxEnvironment 55 Amazon FinSpace Type: String Management API Reference Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S.* Required: No description A description for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ Required: No tags A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. CreateKxEnvironment 56 Amazon FinSpace Management API Reference Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "creationTimestamp": number, "description": "string", "environmentArn": "string", "environmentId": "string", "kmsKeyId": "string", "name": "string", "status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. creationTimestamp The timestamp at which the kdb environment was created in FinSpace. Type: Timestamp description A description for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z0-9. ]{1,1000}$ environmentArn The ARN identiﬁer of the environment. CreateKxEnvironment 57 Amazon FinSpace Type: String Management API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za- z_-]{1,128}$ environmentId A unique identiﬁer for the kdb environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 26. Pattern: ^[a-zA-Z0-9]{1,26}$ kmsKeyId The KMS key ID to encrypt your data in the FinSpace environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: ^[a-zA-Z-0-9-:\/]$ name The name of the kdb environment. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ status The status of the kdb environment. Type: String Valid Values: CREATE_REQUESTED \| CREATING \| CREATED \| DELETE_REQUESTED \| DELETING \| DELETED \| FAILED_CREATION \| RETRY_DELETION \| FAILED_DELETION CreateKxEnvironment 58 Amazon FinSpace Management API Reference \| UPDATE_NETWORK_REQUESTED \| UPDATING_NETWORK \| FAILED_UPDATING_NETWORK \| SUSPENDED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is exceeded. HTTP Status Code: 400 ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase. HTTP Status Code: 402 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 ValidationException The input fails to satisfy the constraints speciﬁed by an AWS service. CreateKxEnvironment 59 Amazon FinSpace HTTP Status Code: 400 See Also Management API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateKxEnvironment 60 Amazon FinSpace Management API Reference CreateKxScalingGroup Creates a new scaling group. Request Syntax POST /kx/environments/environmentId/scalingGroups HTTP/1.1 Content-type: application/json { "availabilityZoneId": "string", "clientToken": "string", "hostType": "string", "scalingGroupName": "string", "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. environmentId A unique identiﬁer for the kdb environment, where you want to create the scaling group. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-z0-9]+$ Required: Yes Request Body The request accepts the following data in JSON format. availabilityZoneId The identiﬁer of the availability zones. Type: String CreateKxScalingGroup 61 Amazon FinSpace Management API Reference Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S. Required: Yes hostType The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. You can add one of the following
api-reference-013	api-reference.pdf	13	Pattern: ^[a-z0-9]+$ Required: Yes Request Body The request accepts the following data in JSON format. availabilityZoneId The identiﬁer of the availability zones. Type: String CreateKxScalingGroup 61 Amazon FinSpace Management API Reference Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes clientToken A token that ensures idempotency. This token expires in 10 minutes. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: .\S. Required: Yes hostType The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. You can add one of the following values: • kx.sg.large – The host type with a conﬁguration of 16 GiB memory and 2 vCPUs. • kx.sg.xlarge – The host type with a conﬁguration of 32 GiB memory and 4 vCPUs. • kx.sg.2xlarge – The host type with a conﬁguration of 64 GiB memory and 8 vCPUs. • kx.sg.4xlarge – The host type with a conﬁguration of 108 GiB memory and 16 vCPUs. • kx.sg.8xlarge – The host type with a conﬁguration of 216 GiB memory and 32 vCPUs. • kx.sg.16xlarge – The host type with a conﬁguration of 432 GiB memory and 64 vCPUs. • kx.sg.32xlarge – The host type with a conﬁguration of 864 GiB memory and 128 vCPUs. • kx.sg1.16xlarge – The host type with a conﬁguration of 1949 GiB memory and 64 vCPUs. • kx.sg1.24xlarge – The host type with a conﬁguration of 2948 GiB memory and 96 vCPUs. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-zA-Z0-9._]+ Required: Yes CreateKxScalingGroup 62 Management API Reference Amazon FinSpace scalingGroupName A unique identiﬁer for the kdb scaling group. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ Required: Yes tags A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "availabilityZoneId": "string", "createdTimestamp": number, "environmentId": "string", "hostType": "string", "lastModifiedTimestamp": number, "scalingGroupName": "string", "status": "string" CreateKxScalingGroup 63 Management API Reference Amazon FinSpace } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. availabilityZoneId The identiﬁer of the availability zones. Type: String Length Constraints: Minimum length of 8. Maximum length of 12. Pattern: ^[a-zA-Z0-9-]+$ createdTimestamp The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp environmentId A unique identiﬁer for the kdb environment, where you create the scaling group. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[a-z0-9]+$ hostType The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. CreateKxScalingGroup 64 Amazon FinSpace Management API Reference Pattern: ^[a-zA-Z0-9._]+ lastModiﬁedTimestamp The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is speciﬁed as 1635768000000. Type: Timestamp scalingGroupName A unique identiﬁer for the kdb scaling group. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_][a-zA-Z0-9]$ status The status of scaling group. • CREATING – The scaling group creation is in progress. • CREATE_FAILED – The scaling group creation has failed. • ACTIVE – The scaling group is active. • UPDATING – The scaling group is in the process of being updated. • UPDATE_FAILED – The update action failed. • DELETING – The scaling group is in the process of being deleted. • DELETE_FAILED – The system failed to delete the scaling group. • DELETED – The scaling group is successfully deleted. Type: String Valid Values: CREATING \| CREATE_FAILED \| ACTIVE \| DELETING \| DELETED \| DELETE_FAILED Errors For information about the errors that are common to all actions, see Common Errors. CreateKxScalingGroup 65 Management API Reference Amazon FinSpace AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException There was a conﬂict with this action, and it could not be completed. HTTP Status Code: 409 InternalServerException The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 LimitExceededException A service limit or quota is

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.