Module Awso_partnercentral_selling.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule MonetaryAmount : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule AwsProductOptimization : sig ... end

Specific optimization strategies partners can implement to reduce costs.

Sourcemodule Email : sig ... end
Sourcemodule JobTitle : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule PhoneNumber : sig ... end
Sourcemodule AwsProductDetails : sig ... end

List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.

Sourcemodule AddressPart : sig ... end
Sourcemodule AddressSummaryCityString : sig ... end
Sourcemodule CountryCode : sig ... end
Sourcemodule CustomerAction : sig ... end
Sourcemodule DateTime : sig ... end
Sourcemodule EngagementUseCase : sig ... end
Sourcemodule LeadContact : sig ... end

An object that contains a lead contact's details associated with the engagement. This provides contact information for individuals involved in lead-related activities.

Sourcemodule LeadSourceId : sig ... end
Sourcemodule LeadSourceName : sig ... end
Sourcemodule LeadSourceType : sig ... end
Sourcemodule Amount : sig ... end
Sourcemodule CurrencyCode : sig ... end
Sourcemodule EstimationUrl : sig ... end
Sourcemodule PaymentFrequency : sig ... end
Sourcemodule ContactFirstNameString : sig ... end
Sourcemodule ContactLastNameString : sig ... end
Sourcemodule AmountMap : sig ... end
Sourcemodule AwsProductsList : sig ... end
Sourcemodule AddressCityString : sig ... end
Sourcemodule AddressPostalCodeString : sig ... end
Sourcemodule CompanyName : sig ... end
Sourcemodule CompanyWebsiteUrl : sig ... end
Sourcemodule Industry : sig ... end
Sourcemodule AddressSummary : sig ... end

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

Sourcemodule AwsMaturity : sig ... end
Sourcemodule MarketSegment : sig ... end
Sourcemodule LeadInteraction : sig ... end

Represents a specific interaction or touchpoint with a lead customer. This structure captures details about communications, meetings, or other engagement activities that help track the lead's progression and engagement history.

Sourcemodule ExpectedCustomerSpend : sig ... end

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

Sourcemodule SenderContactEmail : sig ... end
Sourcemodule WebsiteUrl : sig ... end
Sourcemodule DeliveryModel : sig ... end
Sourcemodule Alias : sig ... end
Sourcemodule AwsAccount : sig ... end
Sourcemodule Contact : sig ... end

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

Sourcemodule AwsProductInsights : sig ... end

Comprehensive spend analysis for a single source (AWS or Partner) including total amounts, optimization savings, program category breakdowns, and detailed product-level insights.

Sourcemodule ProfileNextStepsHistory : sig ... end

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

Sourcemodule AwsProductIdentifier : sig ... end
Sourcemodule SolutionIdentifier : sig ... end
Sourcemodule AwsMemberBusinessTitle : sig ... end
Sourcemodule AccountCompanyNameString : sig ... end
Sourcemodule Address : sig ... end

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

Sourcemodule DunsNumber : sig ... end
Sourcemodule SalesActivity : sig ... end
Sourcemodule EngagementCustomer : sig ... end

Contains details about the customer associated with the Engagement Invitation, including company information and industry.

Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements.

Sourcemodule LeadCustomer : sig ... end

Contains detailed information about the customer associated with the lead, including company details, industry classification, and AWS maturity level. This information helps qualify and categorize the lead for appropriate engagement strategies.

Sourcemodule LeadInteractionList : sig ... end
Sourcemodule LeadQualificationStatus : sig ... end
Sourcemodule Date : sig ... end
Sourcemodule ExpectedCustomerSpendList : sig ... end
Sourcemodule ProjectDetailsTitleString : sig ... end
Sourcemodule ReceiverResponsibility : sig ... end
Sourcemodule SenderContact : sig ... end

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

Sourcemodule AccountSummary : sig ... end

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

Sourcemodule ClosedLostReason : sig ... end
Sourcemodule ReviewStatus : sig ... end
Sourcemodule Stage : sig ... end
Sourcemodule DeliveryModels : sig ... end
Sourcemodule ExpectedContractDuration : sig ... end

The expected duration of a partner's contract with the customer. Used to convert Total Contract Value (TCV) to Monthly Recurring Revenue (MRR) for opportunity dealsizing calculations.

Sourcemodule EngagementContextType : sig ... end
Sourcemodule AccountReceiver : sig ... end

Contains the account details of the partner who received the Engagement Invitation, including the AWS account ID and company name.

Sourcemodule CustomerContactsList : sig ... end

Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.

Sourcemodule EngagementScore : sig ... end
Sourcemodule AwsClosedLostReason : sig ... end
Sourcemodule AwsOpportunityStage : sig ... end
Sourcemodule AwsPartition : sig ... end
Sourcemodule AwsProductIdentifiers : sig ... end
Sourcemodule SolutionIdentifiers : sig ... end
Sourcemodule AwsTeamMember : sig ... end

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

Sourcemodule Account : sig ... end

Specifies the Customer's account details associated with the Opportunity.

Sourcemodule PrimaryNeedFromAws : sig ... end
Sourcemodule SalesActivities : sig ... end
Sourcemodule CustomerProjectsContext : sig ... end

The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers. All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.

Sourcemodule LeadContext : sig ... end

Provides comprehensive details about a lead associated with an engagement. This structure contains information about lead qualification status, customer details, and interaction history to facilitate lead management and tracking within the engagement.

Sourcemodule LeadInvitationCustomer : sig ... end

Contains customer information included in a lead invitation payload. This structure provides essential details about the customer to help partners evaluate the lead opportunity and determine their interest in engagement.

Sourcemodule LeadInvitationInteraction : sig ... end

Represents interaction details included in a lead invitation payload. This structure provides context about how the lead was generated and the customer's engagement history to help partners assess the opportunity quality.

Sourcemodule ProjectDetails : sig ... end

Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.

Sourcemodule SenderContactList : sig ... end
Sourcemodule ValidationExceptionError : sig ... end

Indicates an invalid value for a field. REQUIRED_FIELD_MISSING: The request is missing a required field. Fix: Verify your request payload includes all required fields. INVALID_ENUM_VALUE: The enum field value isn't an accepted values. Fix: Check the documentation for the list of valid enum values, and update your request with a valid value. INVALID_STRING_FORMAT: The string format is invalid. Fix: Confirm that the string is in the expected format (For example: email address, date). INVALID_VALUE: The value isn't valid. Fix: Confirm that the value meets the expected criteria and is within the allowable range or set. TOO_MANY_VALUES: There are too many values in a field that expects fewer entries. Fix: Reduce the number of values to match the expected limit. NOT_ENOUGH_VALUES: There are not enough values in a field that expects more entries. Fix: Increase the number of values to match the expected threshold. ACTION_NOT_PERMITTED: The action isn't permitted due to current state or permissions. Fix: Verify that the action is appropriate for the current state, and that you have the necessary permissions to perform it. DUPLICATE_KEY_VALUE: The value in a field duplicates a value that must be unique. Fix: Verify that the value is unique and doesn't duplicate an existing value in the system.

Sourcemodule NextStepsHistory : sig ... end

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

Sourcemodule Channel : sig ... end
Sourcemodule MonetaryValueAmountString : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule CatalogIdentifier : sig ... end
Sourcemodule SolutionArn : sig ... end
Sourcemodule SolutionStatus : sig ... end
Sourcemodule ResourceIdentifier : sig ... end
Sourcemodule ResourceSnapshotArn : sig ... end
Sourcemodule ResourceSnapshotRevision : sig ... end
Sourcemodule ResourceTemplateName : sig ... end
Sourcemodule ResourceType : sig ... end
Sourcemodule EngagementIdentifier : sig ... end
Sourcemodule ResourceSnapshotJobArn : sig ... end
Sourcemodule ResourceSnapshotJobStatus : sig ... end
Sourcemodule ContextIdentifier : sig ... end
Sourcemodule OpportunityIdentifier : sig ... end
Sourcemodule ReasonCode : sig ... end
Sourcemodule TaskArn : sig ... end
Sourcemodule TaskIdentifier : sig ... end
Sourcemodule TaskStatus : sig ... end
Sourcemodule CustomerSummary : sig ... end

An object that contains a Customer object's subset of fields.

Sourcemodule LifeCycleSummary : sig ... end

An object that contains a LifeCycle object's subset of fields.

Sourcemodule OpportunityArn : sig ... end
Sourcemodule OpportunityType : sig ... end
Sourcemodule ProjectSummary : sig ... end

An object that contains a Project object's subset of fields.

Sourcemodule EngagementArn : sig ... end
Sourcemodule EngagementContextTypeList : sig ... end
Sourcemodule EngagementTitle : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule MemberCompanyName : sig ... end
Sourcemodule InvitationStatus : sig ... end
Sourcemodule ParticipantType : sig ... end
Sourcemodule Receiver : sig ... end

Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.

Sourcemodule AwsOpportunityCustomer : sig ... end

Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.

Sourcemodule AwsOpportunityInsights : sig ... end

Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.

Sourcemodule AwsOpportunityLifeCycle : sig ... end

Tracks the lifecycle of the AWS opportunity, including stages such as qualification, validation, and closure. This field helps partners understand the current status and progression of the opportunity.

Sourcemodule AwsOpportunityProject : sig ... end

Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.

Represents other entities related to the AWS opportunity, such as AWS products, partner solutions, and marketplace offers. These associations help build a complete picture of the solution being sold.

Sourcemodule OpportunityOrigin : sig ... end
Sourcemodule SalesInvolvementType : sig ... end
Sourcemodule Visibility : sig ... end
Sourcemodule Customer : sig ... end

An object that contains the customer's Account and Contact.

Sourcemodule LifeCycleForView : sig ... end

Provides the lifecycle view of an opportunity resource shared through a snapshot.

Sourcemodule PrimaryNeedsFromAws : sig ... end
Sourcemodule ProjectView : sig ... end

Provides the project view of an opportunity resource shared through a snapshot.

Sourcemodule RelatedEntityIdentifiers : sig ... end

This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

Sourcemodule EngagementContextPayload : sig ... end

Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.

Sourcemodule LeadInvitationPayload : sig ... end

Represents the data payload of an engagement invitation for a lead opportunity. This contains detailed information about the customer and interaction history that partners use to evaluate whether to accept the lead engagement invitation.

Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.

Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule LifeCycleNextStepsString : sig ... end
Sourcemodule AwsFundingUsed : sig ... end
Sourcemodule Channels : sig ... end
Sourcemodule MarketingSource : sig ... end
Sourcemodule UseCases : sig ... end
Sourcemodule ApnPrograms : sig ... end
Sourcemodule CompetitorName : sig ... end
Sourcemodule ProjectTitleString : sig ... end
Sourcemodule MonetaryValue : sig ... end

Specifies payments details.

Sourcemodule RevenueModel : sig ... end
Sourcemodule UpdateLeadContext : sig ... end

Updates the context information for a lead with qualification status, customer details, and interaction data.

Sourcemodule Tag : sig ... end

The key-value pair assigned to a specified resource.

Sourcemodule SolutionBase : sig ... end

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

Sourcemodule SolutionSortName : sig ... end
Sourcemodule SortOrder : sig ... end
Sourcemodule ResourceSnapshotSummary : sig ... end

Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.

An object that contains a Resource Snapshot Job's subset of fields.

Sourcemodule SortBy : sig ... end

Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task's status, associated identifiers, and any failure details for opportunity creation processes.

Sourcemodule EngagementArnOrIdentifier : sig ... end
Sourcemodule ListTasksSortName : sig ... end
Sourcemodule TaskArnOrIdentifier : sig ... end
Sourcemodule OpportunitySummary : sig ... end

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

Sourcemodule OpportunitySortName : sig ... end
Sourcemodule EngagementSummary : sig ... end

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

Sourcemodule EngagementSortName : sig ... end

This provide a streamlined view of the relationships between engagements and resources. These summaries offer a crucial link between collaborative engagements and the specific resources involved, such as opportunities.These summaries are particularly valuable for partners navigating complex engagements with multiple resources. They enable quick insights into resource distribution across engagements, support efficient resource management, and help maintain a clear overview of collaborative activities.

Sourcemodule EngagementMember : sig ... end

Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement. Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.

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

Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.

Specifies a subset of fields associated with tasks related to accepting an engagement invitation.

Provides a comprehensive view of AwsOpportunitySummaryFullView template.

Sourcemodule OpportunitySummaryView : sig ... end

Provides a comprehensive view of an opportunity summary, including lifecycle information, team details, opportunity type, primary needs from AWS, and associated project information.

Sourcemodule EngagementContextDetails : sig ... end

Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.

Sourcemodule EngagementMemberSummary : sig ... end

The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.

Sourcemodule InvitationMessage : sig ... end
Sourcemodule Payload : sig ... end

Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.

Sourcemodule AccessDeniedException : sig ... end

This error occurs when you don't have permission to perform the requested action. You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

Sourcemodule ConflictException : sig ... end

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource. Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

Sourcemodule InternalServerException : sig ... end

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect. Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

Sourcemodule ResourceNotFoundException : sig ... end

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials. Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

Sourcemodule ThrottlingException : sig ... end

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling. This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by the service or business validation rules. Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

Sourcemodule LifeCycle : sig ... end

An object that contains the Opportunity lifecycle's details.

Sourcemodule Marketing : sig ... end

An object that contains marketing details for the Opportunity.

Sourcemodule NationalSecurity : sig ... end
Sourcemodule Project : sig ... end

An object that contains the Opportunity's project details.

Sourcemodule SoftwareRevenue : sig ... end

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

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit. Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

Represents the updated payload of an engagement context. The structure of this payload varies based on the context type being updated.

Sourcemodule TagKeyList : sig ... end
Sourcemodule TaggableResourceArn : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule ClientToken : sig ... end
Sourcemodule AwsSubmission : sig ... end

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

Sourcemodule RejectionReasonString : sig ... end
Sourcemodule SolutionList : sig ... end
Sourcemodule PageSize : sig ... end
Sourcemodule SolutionSort : sig ... end

Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.

Sourcemodule SortObject : sig ... end

Defines the sorting parameters for listing resource snapshot jobs. This structure allows you to specify the field to sort by and the order of sorting.

Sourcemodule ContextIdentifiers : sig ... end
Sourcemodule EngagementIdentifiers : sig ... end
Sourcemodule ListTasksSortBase : sig ... end

Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.

Sourcemodule OpportunityIdentifiers : sig ... end
Sourcemodule TaskIdentifiers : sig ... end
Sourcemodule TaskStatuses : sig ... end
Sourcemodule OpportunitySummaries : sig ... end
Sourcemodule CreatedDateFilter : sig ... end

Filter for opportunities based on creation date range.

Sourcemodule LastModifiedDate : sig ... end

Defines a filter to retrieve opportunities based on the last modified date. This filter is useful for tracking changes or updates to opportunities over time.

Sourcemodule OpportunitySort : sig ... end

Object that configures response sorting.

Sourcemodule TargetCloseDateFilter : sig ... end

Filters opportunities based on their target close date.

Sourcemodule EngagementSummaryList : sig ... end
Sourcemodule AwsAccountList : sig ... end
Sourcemodule EngagementPageSize : sig ... end
Sourcemodule EngagementSort : sig ... end

Specifies the sorting parameters for listing Engagements.

Sourcemodule EngagementMembers : sig ... end
Sourcemodule MemberPageSize : sig ... end
Sourcemodule AwsAccountIdOrAliasList : sig ... end
Sourcemodule InvitationStatusList : sig ... end

Defines sorting options for retrieving Engagement Invitations. Sorting can be done based on various criteria like the invitation date or status.

Sourcemodule ResourceArn : sig ... end
Sourcemodule ResourceSnapshotPayload : sig ... end

Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.

Sourcemodule EngagementContexts : sig ... end
Sourcemodule EngagementDescription : sig ... end
Sourcemodule EngagementMemberSummaries : sig ... end
Sourcemodule RelatedEntityType : sig ... end
Sourcemodule EngagementInvitationArn : sig ... end
Sourcemodule Invitation : sig ... end

The Invitation structure represents an invitation exchanged between partners and AWS. It includes a message, receiver information, and a payload providing context for the invitation.

Sourcemodule AssigneeContact : sig ... end

Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.

Sourcemodule UpdateOpportunityResponse : sig ... end

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate. When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

Sourcemodule UpdateOpportunityRequest : sig ... end

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate. When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

Updates the context information for an existing engagement with new or modified data.

Updates the context information for an existing engagement with new or modified data.

Sourcemodule UntagResourceResponse : sig ... end

Removes a tag or tags from a resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes a tag or tags from a resource.

Sourcemodule TagResourceResponse : sig ... end

Assigns one or more tags (key-value pairs) to the specified resource.

Sourcemodule TagResourceRequest : sig ... end

Assigns one or more tags (key-value pairs) to the specified resource.

Sourcemodule SubmitOpportunityRequest : sig ... end

Use this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has LifeCycle.ReviewStatus as either Approved or Action Required.

Stops a resource snapshot job. The job must be started prior to being stopped.

Starts a resource snapshot job that has been previously created.

This action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.

This action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.

Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including GetOpportunity, CreateEngagement (if it doesn't exist), CreateResourceSnapshot, CreateResourceSnapshotJob, CreateEngagementInvitation (if not already invited/accepted), and SubmitOpportunity.

Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including GetOpportunity, CreateEngagement (if it doesn't exist), CreateResourceSnapshot, CreateResourceSnapshotJob, CreateEngagementInvitation (if not already invited/accepted), and SubmitOpportunity.

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

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

This action rejects an EngagementInvitation that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.

Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Returns a list of tags for a resource.

Returns a list of tags for a resource.

Sourcemodule ListSolutionsResponse : sig ... end

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

Sourcemodule ListSolutionsRequest : sig ... end

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

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: Fetching all snapshots associated with an engagement. Retrieving snapshots of a specific resource type within an engagement. Obtaining snapshots for a particular resource using a specified template. Accessing the latest snapshot of a resource within an engagement. Filtering snapshots by resource owner.

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: Fetching all snapshots associated with an engagement. Retrieving snapshots of a specific resource type within an engagement. Obtaining snapshots for a particular resource using a specified template. Accessing the latest snapshot of a resource within an engagement. Filtering snapshots by resource owner.

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.

Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.

Sourcemodule ListOpportunitiesResponse : sig ... end

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action. To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the ListOpportunities action. We recommend the following approach: Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

Sourcemodule ListOpportunitiesRequest : sig ... end

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action. To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the ListOpportunities action. We recommend the following approach: Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

Sourcemodule ListEngagementsResponse : sig ... end

This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.

Sourcemodule ListEngagementsRequest : sig ... end

This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The ListEngagementMembers operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried.

Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The ListEngagementMembers operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried.

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

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

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Use this action to retrieve a specific snapshot record.

Use this action to retrieve a specific snapshot record.

Use this action to retrieves information about a specific resource snapshot job.

Use this action to retrieves information about a specific resource snapshot job.

Sourcemodule GetOpportunityResponse : sig ... end

Fetches the Opportunity record from Partner Central by a given Identifier. Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

Sourcemodule GetOpportunityRequest : sig ... end

Fetches the Opportunity record from Partner Central by a given Identifier. Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

Sourcemodule GetEngagementResponse : sig ... end

Use this action to retrieve the engagement record for a given EngagementIdentifier.

Sourcemodule GetEngagementRequest : sig ... end

Use this action to retrieve the engagement record for a given EngagementIdentifier.

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

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

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

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change. Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.

This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template.

This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template.

Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

Sourcemodule CreateOpportunityResponse : sig ... end

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission. To submit an opportunity, follow these steps: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To start the engagement with AWS, use StartEngagementFromOpportunity. After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state. There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

Sourcemodule CreateOpportunityRequest : sig ... end

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission. To submit an opportunity, follow these steps: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To start the engagement with AWS, use StartEngagementFromOpportunity. After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state. There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

Sourcemodule CreateEngagementResponse : sig ... end

The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.

Sourcemodule CreateEngagementRequest : sig ... end

The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.

This action creates an invitation from a sender to a single receiver to join an engagement.

This action creates an invitation from a sender to a single receiver to join an engagement.

Creates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an engagement, providing additional details that help facilitate collaboration between engagement members.

Creates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an engagement, providing additional details that help facilitate collaboration between engagement members.

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace. To obtain identifiers for these entities, use the following methods: Solution: Use the ListSolutions operation. AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities.

Sourcemodule AssignOpportunityRequest : sig ... end

Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity. This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

Use the AcceptEngagementInvitation action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data.