{
"smithy": "2.0",
"shapes": {
"com.amazonaws.partnercentralselling#AWSPartnerCentralSelling": {
"type": "service",
"version": "2022-07-26",
"operations": [
{
"target": "com.amazonaws.partnercentralselling#CreateEngagementContext"
},
{
"target": "com.amazonaws.partnercentralselling#GetSellingSystemSettings"
},
{
"target": "com.amazonaws.partnercentralselling#ListTagsForResource"
},
{
"target": "com.amazonaws.partnercentralselling#PutSellingSystemSettings"
},
{
"target": "com.amazonaws.partnercentralselling#TagResource"
},
{
"target": "com.amazonaws.partnercentralselling#UntagResource"
},
{
"target": "com.amazonaws.partnercentralselling#UpdateEngagementContext"
}
],
"resources": [
{
"target": "com.amazonaws.partnercentralselling#CustomerAccount"
},
{
"target": "com.amazonaws.partnercentralselling#CustomerAccountBulkJob"
},
{
"target": "com.amazonaws.partnercentralselling#Engagement"
},
{
"target": "com.amazonaws.partnercentralselling#EngagementByAcceptingInvitationTask"
},
{
"target": "com.amazonaws.partnercentralselling#EngagementFromOpportunityTask"
},
{
"target": "com.amazonaws.partnercentralselling#EngagementGroup"
},
{
"target": "com.amazonaws.partnercentralselling#EngagementInvitation"
},
{
"target": "com.amazonaws.partnercentralselling#Opportunity"
},
{
"target": "com.amazonaws.partnercentralselling#OpportunityBulkJob"
},
{
"target": "com.amazonaws.partnercentralselling#OpportunityFromEngagementTask"
},
{
"target": "com.amazonaws.partnercentralselling#ProspectingFromEngagementTask"
},
{
"target": "com.amazonaws.partnercentralselling#ResourceSnapshot"
},
{
"target": "com.amazonaws.partnercentralselling#ResourceSnapshotJob"
},
{
"target": "com.amazonaws.partnercentralselling#Solution"
}
],
"traits": {
"aws.api#service": {
"sdkId": "PartnerCentral Selling",
"endpointPrefix": "partnercentral-selling",
"arnNamespace": "partnercentral",
"cloudTrailEventSource": "partnercentral-selling.amazonaws.com"
},
"aws.auth#sigv4": {
"name": "partnercentral-selling"
},
"aws.endpoints#dualStackOnlyEndpoints": {},
"aws.endpoints#standardRegionalEndpoints": {},
"aws.iam#defineConditionKeys": {
"partnercentral:RelatedEntityType": {
"type": "String",
"relativeDocumentation": "page.html#RelatedEntityType",
"documentation": "Filters access by entity types for Opportunity association. Accepted values: [Solutions, AwsProducts, AwsMarketplaceOffers]"
},
"partnercentral:Catalog": {
"type": "String",
"relativeDocumentation": "page.html#Catalog",
"documentation": "Filters access by a specific Catalog. Accepted values: [AWS, Sandbox]"
},
"aws:RequestTag/${TagKey}": {
"type": "String",
"documentation": "Filters access by the tags that are passed in the request",
"externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag"
},
"aws:ResourceTag/${TagKey}": {
"type": "String",
"documentation": "Filters access by the tags associated with the resource",
"externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag"
},
"aws:TagKeys": {
"type": "ArrayOfString",
"documentation": "Filters access by the tag keys that are passed in the request",
"externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys"
}
},
"aws.iam#supportedPrincipalTypes": [
"Root",
"IAMUser",
"IAMRole",
"FederatedUser"
],
"aws.protocols#awsJson1_0": {},
"smithy.api#documentation": "
This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.
The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.
Features offered by AWS Partner Central API
Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.
AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.
Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.
View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.
List solutions: Provides list APIs for listing partner offers using ListSolutions.
Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.
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.
The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.
The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.
Contains the request parameters for the AcceptEngagementInvitation operation.
A message that describes why access was denied.
" } }, "Reason": { "target": "com.amazonaws.partnercentralselling#AccessDeniedExceptionErrorCode", "traits": { "smithy.api#documentation": "The reason why access was denied for the requested operation.
" } } }, "traits": { "smithy.api#documentation": "This error occurs when you don't have permission to perform the requested action.
You don\u2019t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.partnercentralselling#AccessDeniedExceptionErrorCode": { "type": "enum", "members": { "INCOMPATIBLE_BENEFIT_AWS_PARTNER_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCOMPATIBLE_BENEFIT_AWS_PARTNER_STATE" } }, "SEARCH_OPPORTUNITIES_NOT_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEARCH_OPPORTUNITIES_NOT_ENABLED" } }, "SEARCH_OPPORTUNITIES_DATA_NOT_ROUTED_TO_DDB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEARCH_OPPORTUNITIES_DATA_NOT_ROUTED_TO_DDB" } }, "OPPORTUNITY_BULK_JOB_NOT_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPPORTUNITY_BULK_JOB_NOT_ENABLED" } } }, "traits": { "smithy.api#documentation": "The code that identifies why AWS Partner Central denied access to the requested operation.
" } }, "com.amazonaws.partnercentralselling#Account": { "type": "structure", "members": { "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { "smithy.api#documentation": "Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.
Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.
Specifies the end Customer's company name associated with the Opportunity.
Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.
Specifies the Customer Amazon Web Services account ID associated with the Opportunity.
Specifies the end Customer's address details associated with the Opportunity.
Indicates the Customer DUNS number, if available.
Specifies the Customer's account details associated with the Opportunity.
The industry classification of the customer company.
" } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { "smithy.api#documentation": "The name of the customer company.
", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#AccountWebsiteUrl", "traits": { "smithy.api#documentation": "The website URL of the customer company.
" } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { "smithy.api#documentation": "The country of the customer company, as an ISO 3166-1 alpha-2 country code.
" } } }, "traits": { "smithy.api#documentation": "A snapshot of the customer company's identity for an account-planning engagement. The caller can supply these details so that an account can be identified even when it isn't yet mapped to an AWS account.
" } }, "com.amazonaws.partnercentralselling#AccountFilterStringList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "traits": { "smithy.api#documentation": "Information about account filter string list.
", "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.partnercentralselling#AccountPlanningInvitationPayload": { "type": "structure", "members": { "AccountIdentifier": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArnOrIdentifier", "traits": { "smithy.api#documentation": "The identifier of the customer account that the plan concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AccountCustomer", "traits": { "smithy.api#documentation": "A caller-supplied snapshot of the customer company's identity, so that the receiver can tell which account the plan concerns even when the account isn't yet mapped to an AWS account.
" } }, "SenderContacts": { "target": "com.amazonaws.partnercentralselling#SenderContactList", "traits": { "smithy.api#documentation": "The sender's contact information for this account plan.
" } }, "PreferredContact": { "target": "com.amazonaws.partnercentralselling#PreferredContactWindow", "traits": { "smithy.api#documentation": "When the sender prefers to be contacted about this account plan. This information is advisory.
" } } }, "traits": { "smithy.api#documentation": "The content of an account-planning invitation. It carries what the invited party needs to identify which account the plan concerns, because the receiver can't read the account resource directly. The account can be named by its identifier, by a customer identity snapshot, or both.
" } }, "com.amazonaws.partnercentralselling#AccountReceiver": { "type": "structure", "members": { "Alias": { "target": "com.amazonaws.partnercentralselling#Alias", "traits": { "smithy.api#documentation": "Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
" } }, "AwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the account details of the partner who received the Engagement Invitation, including the AWS account ID and company name.
" } }, "com.amazonaws.partnercentralselling#AccountSummary": { "type": "structure", "members": { "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { "smithy.api#documentation": "Specifies which industry the end Customer belongs to associated with the Opportunity. It refers to the category or sector that the customer's business operates in.
To submit a value outside the picklist, use Other.
Conditionally mandatory if Other is selected for Industry Vertical in LOVs.
Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.
Specifies the end Customer's company name associated with the Opportunity.
Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system.
Specifies the end Customer's address details associated with the Opportunity.
An object that contains an Account's subset of fields.
The website URL of the customer's company.
", "smithy.api#length": { "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#Address": { "type": "structure", "members": { "City": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { "smithy.api#documentation": "Specifies the end Customer's city associated with the Opportunity.
Specifies the end Customer's postal code associated with the Opportunity.
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
Specifies the end Customer's country associated with the Opportunity.
Specifies the end Customer's street address associated with the Opportunity.
Specifies the end Customer's address details associated with the Opportunity.
One part of a postal address, such as a street line, a city, a state or region, or a postal code.
", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#AddressSummary": { "type": "structure", "members": { "City": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { "smithy.api#documentation": "Specifies the end Customer's city associated with the Opportunity.
Specifies the end Customer's postal code associated with the Opportunity.
Specifies the end Customer's state or region associated with the Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP
Specifies the end Customer's country associated with the Opportunity.
An object that contains an Address object's subset of fields.
Group by the enrichment status of the customer account.
", "smithy.api#enumValue": "ENRICHMENT_STATUS" } }, "AWS_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the industry of the customer, as classified by AWS.
", "smithy.api#enumValue": "AWS_INDUSTRY" } }, "SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the market segment of the customer.
", "smithy.api#enumValue": "SEGMENT" } }, "REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the region of the customer.
", "smithy.api#enumValue": "REGION" } }, "SOLUTION_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the category of the recommended solution.
", "smithy.api#enumValue": "SOLUTION_CATEGORY" } }, "ACCOUNT_PLANNING_QUALIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by whether the customer qualifies for account planning.
", "smithy.api#enumValue": "ACCOUNT_PLANNING_QUALIFICATION" } }, "PROGRAM_ELIGIBILITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the AWS programs that the customer is eligible for.
", "smithy.api#enumValue": "PROGRAM_ELIGIBILITY" } }, "MARKETPLACE_ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the AWS Marketplace engagement score of the customer.
", "smithy.api#enumValue": "MARKETPLACE_ENGAGEMENT_SCORE" } }, "GEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the geographic area of the customer.
", "smithy.api#enumValue": "GEO" } }, "COUNTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the country of the customer.
", "smithy.api#enumValue": "COUNTRY" } }, "SOLUTION_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Group by the score of the recommended solution.
", "smithy.api#enumValue": "SOLUTION_SCORE" } } }, "traits": { "smithy.api#documentation": "The fields that you can group customer accounts by in GetCustomerAccountStatistics.
Information about aggregatable field list.
", "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.partnercentralselling#AggregationRequest": { "type": "structure", "members": { "GroupBy": { "target": "com.amazonaws.partnercentralselling#AggregatableFieldList", "traits": { "smithy.api#documentation": "The field to group the customer accounts by. Specify one field.
", "smithy.api#length": { "min": 1, "max": 1 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Groups customer accounts by the values of a field.
" } }, "com.amazonaws.partnercentralselling#AggregationRequestList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AggregationRequest" }, "traits": { "smithy.api#documentation": "Information about aggregation request list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#AggregationResult": { "type": "structure", "members": { "GroupBy": { "target": "com.amazonaws.partnercentralselling#AggregatableFieldList", "traits": { "smithy.api#documentation": "The field that the customer accounts are grouped by.
", "smithy.api#required": {} } }, "Buckets": { "target": "com.amazonaws.partnercentralselling#BucketList", "traits": { "smithy.api#documentation": "The groups of customer accounts, one for each value of the field, with the number of accounts in each group.
", "smithy.api#required": {} } }, "OtherCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of customer accounts that have a value not included in Buckets.
The result of an aggregation. It includes the grouped field, the number of customer accounts for each value, and the number of accounts with other values.
" } }, "com.amazonaws.partnercentralselling#AggregationResultList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AggregationResult" }, "traits": { "smithy.api#documentation": "Information about aggregation result list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#Alias": { "type": "string", "traits": { "smithy.api#documentation": "An alias for an AWS account.
", "smithy.api#pattern": "^(?s).{0,80}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#Amount": { "type": "string", "traits": { "smithy.api#documentation": "A monetary amount written as a decimal number with up to two digits after the decimal point.
", "smithy.api#pattern": "^((0|([1-9][0-9]{0,30}))(\\.[0-9]{0,2})?)?$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#AmountMap": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the AWS program or modernization pathway that the spend amount maps to.
" } }, "value": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "The spend amount that maps to the AWS program or modernization pathway.
" } }, "traits": { "smithy.api#documentation": "Maps spend amounts to AWS programs and modernization pathways.
" } }, "com.amazonaws.partnercentralselling#ApnPrograms": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "A list of the AWS Partner Network (APN) programs that the opportunity relates to.
" } }, "com.amazonaws.partnercentralselling#AssignOpportunity": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#AssignOpportunityRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to assign Opportunities on AWS Partner Central" }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/AssignOpportunity", "code": 200 } } }, "com.amazonaws.partnercentralselling#AssignOpportunityRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.
Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the AssignOpportunity operation.
Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.
", "smithy.api#required": {} } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
", "smithy.api#pattern": "^(?s).{0,80}$", "smithy.api#required": {} } }, "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.
", "smithy.api#pattern": "^(?s).{0,80}$", "smithy.api#required": {} } }, "Phone": { "target": "com.amazonaws.partnercentralselling#PhoneNumber", "traits": { "smithy.api#documentation": "Specifies the contact phone number of the assignee responsible for the opportunity or engagement. This field enables direct communication for time-sensitive matters and facilitates coordination between AWS and partner teams.
" } }, "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { "smithy.api#documentation": "Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.
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.
" } }, "com.amazonaws.partnercentralselling#AssociateOpportunity": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#AssociateOpportunityRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:RelatedEntityType" ], "aws.iam#iamAction": { "documentation": "Grants permission to associate Opportunities on AWS Partner Central with other entities" }, "smithy.api#documentation": "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.
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.
Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.
Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.
Contains the request parameters for the AssociateOpportunity operation.
An AWS account ID or an alias for an AWS account. An account ID has 12 digits, and an alias has up to 12 characters.
", "smithy.api#pattern": "^([0-9]{12}|\\w{1,12})$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#AwsAccountIdOrAliasList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsAccount" }, "traits": { "smithy.api#documentation": "A list of AWS account IDs or aliases.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#AwsAccountList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsAccount" }, "traits": { "smithy.api#documentation": "A list of AWS account IDs or aliases.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#AwsClosedLostReason": { "type": "enum", "members": { "ADMINISTRATIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Administrative" } }, "BUSINESS_ASSOCIATE_AGREEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Business Associate Agreement" } }, "COMPANY_ACQUIRED_DISSOLVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Company Acquired/Dissolved" } }, "COMPETITIVE_OFFERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Competitive Offering" } }, "CUSTOMER_DATA_REQUIREMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Data Requirement" } }, "CUSTOMER_DEFICIENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Deficiency" } }, "CUSTOMER_EXPERIENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Experience" } }, "DELAY_CANCELLATION_OF_PROJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Delay / Cancellation of Project" } }, "DUPLICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Duplicate" } }, "DUPLICATE_OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Duplicate Opportunity" } }, "EXECUTIVE_BLOCKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Executive Blocker" } }, "FAILED_VETTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed Vetting" } }, "FEATURE_LIMITATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Feature Limitation" } }, "FINANCIAL_COMMERCIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Financial/Commercial" } }, "INSUFFICIENT_AMAZON_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Insufficient Amazon Value" } }, "INSUFFICIENT_AWS_VALUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Insufficient AWS Value" } }, "INTERNATIONAL_CONSTRAINTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "International Constraints" } }, "LEGAL_TAX_REGULATORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Legal / Tax / Regulatory" } }, "LEGAL_TERMS_AND_CONDITIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Legal Terms and Conditions" } }, "LOST_TO_COMPETITOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor" } }, "LOST_TO_COMPETITOR_GOOGLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Google" } }, "LOST_TO_COMPETITOR_MICROSOFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Microsoft" } }, "LOST_TO_COMPETITOR_OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Other" } }, "LOST_TO_COMPETITOR_RACKSPACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Rackspace" } }, "LOST_TO_COMPETITOR_SOFTLAYER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - SoftLayer" } }, "LOST_TO_COMPETITOR_VMWARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - VMWare" } }, "NO_CUSTOMER_REFERENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Customer Reference" } }, "NO_INTEGRATION_RESOURCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Integration Resources" } }, "NO_OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Opportunity" } }, "NO_PERCEIVED_VALUE_OF_MP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Perceived Value of MP" } }, "NO_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Response" } }, "NOT_COMMITTED_TO_AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Not Committed to AWS" } }, "NO_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Update" } }, "ON_PREMISES_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "On Premises Deployment" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other" } }, "OTHER_DETAILS_IN_DESCRIPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other (Details in Description)" } }, "PARTNER_GAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Partner Gap" } }, "PAST_DUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Past Due" } }, "PEOPLE_RELATIONSHIP_GOVERNANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "People/Relationship/Governance" } }, "PLATFORM_TECHNOLOGY_LIMITATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Platform Technology Limitation" } }, "PREFERENCE_FOR_COMPETITOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Preference for Competitor" } }, "PRICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Price" } }, "PRODUCT_TECHNOLOGY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Product/Technology" } }, "PRODUCT_NOT_ON_AWS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Product Not on AWS" } }, "SECURITY_COMPLIANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Security / Compliance" } }, "SELF_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Self-Service" } }, "TECHNICAL_LIMITATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Technical Limitations" } }, "TERM_SHEET_IMPASSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Term Sheet Impasse" } } }, "traits": { "smithy.api#documentation": "The reason that AWS gives for closing an opportunity as lost.
" } }, "com.amazonaws.partnercentralselling#AwsEnrichment": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#AwsEnrichmentCustomer", "traits": { "smithy.api#documentation": "Information about the customer that AWS provides.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsEnrichmentInsights", "traits": { "smithy.api#documentation": "Insights that AWS computes for the customer.
" } } }, "traits": { "smithy.api#documentation": "The information that we provide about the matched customer, in addition to the details that you supplied. Present only when EnrichmentStatus is ENRICHED.
The name of the customer, as recorded by AWS.
" } }, "Industry": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The industry of the customer, as classified by AWS.
" } }, "SubIndustry": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The sub-industry of the customer, as classified by AWS.
" } }, "Sector": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The sector of the customer, as classified by AWS.
" } }, "Segment": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The market segment of the customer, as classified by AWS.
" } }, "CompanySize": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The size of the customer company.
" } }, "Region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The region of the customer, as classified by AWS.
" } }, "SubRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The sub-region of the customer, as classified by AWS.
" } }, "Geo": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The geographic area of the customer, as classified by AWS.
" } }, "Country": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The country of the customer.
" } }, "CustomerAccountPlanningQualification": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Indicates whether the customer qualifies for account planning with AWS.
" } }, "EligiblePrograms": { "target": "com.amazonaws.partnercentralselling#EligibleProgramList", "traits": { "smithy.api#documentation": "The AWS programs that the customer is eligible for.
" } } }, "traits": { "smithy.api#documentation": "Recorded facts that we hold about the matched customer, such as the industry, sector, company size, and region.
" } }, "com.amazonaws.partnercentralselling#AwsEnrichmentCustomerSummary": { "type": "structure", "members": { "Industry": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The industry of the customer, as classified by AWS.
" } }, "AccountPlanningQualification": { "target": "com.amazonaws.partnercentralselling#EnrichmentValue", "traits": { "smithy.api#documentation": "Indicates whether the customer qualifies for account planning with AWS.
" } }, "EligiblePrograms": { "target": "com.amazonaws.partnercentralselling#EligibleProgramList", "traits": { "smithy.api#documentation": "The AWS programs that the customer is eligible for.
" } }, "Geo": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The geographic area of the customer, as classified by AWS.
" } }, "Country": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The country of the customer.
" } }, "Segment": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The market segment of the customer, as classified by AWS.
" } } }, "traits": { "smithy.api#documentation": "Recorded facts about the matched customer for an account in search results. It carries the fields that you can filter and group by.
" } }, "com.amazonaws.partnercentralselling#AwsEnrichmentInsights": { "type": "structure", "members": { "MarketplaceEngagementScore": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The level of engagement of the customer with AWS Marketplace. Valid values are High, Medium, and Low.
The category of the solution that AWS recommends for the customer.
" } }, "SolutionScore": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The likelihood that the customer adopts the recommended solution. Valid values are High, Medium, and Low.
The sub-category of the solution that AWS recommends for the customer.
" } } }, "traits": { "smithy.api#documentation": "Values that we compute about the matched customer, such as the marketplace engagement score and the solution propensity. These differ from the recorded facts in Customer.
The level of engagement of the customer with AWS Marketplace. Valid values are High, Medium, and Low.
The category of the solution that AWS recommends for the customer.
" } }, "SolutionScore": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The likelihood that the customer adopts the recommended solution. Valid values are High, Medium, and Low.
Computed values about the matched customer for an account in search results. It carries the fields that you can sort and filter by.
" } }, "com.amazonaws.partnercentralselling#AwsEnrichmentSummary": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#AwsEnrichmentCustomerSummary", "traits": { "smithy.api#documentation": "Information about the customer that AWS provides.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsEnrichmentInsightsSummary", "traits": { "smithy.api#documentation": "Insights that AWS computes for the customer.
" } } }, "traits": { "smithy.api#documentation": "The AWS enrichment information for an account in search results. It carries a reduced set of fields compared to the enrichment information that GetCustomerAccount returns. Present only when EnrichmentStatus is ENRICHED.
Specifies whether a marketing development fund (MDF) funds the marketing activity. The value is Yes if an MDF funds the activity, or No if it doesn't.
The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer.
", "smithy.api#pattern": "^arn:aws:aws-marketplace:[a-z]{1,2}-[a-z]*-\\d+:\\d{12}:AWSMarketplace/Offer/.*$" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceOfferIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferIdentifier" }, "traits": { "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) that identify AWS Marketplace offers.
" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceOfferSetIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an AWS Marketplace offer set.
", "smithy.api#pattern": "^arn:aws:aws-marketplace:[a-z]{1,2}-[a-z]*-\\d+:\\d{12}:AWSMarketplace/OfferSet/offerset-.*" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceOfferSetIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferSetIdentifier" }, "traits": { "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) that identify AWS Marketplace offer sets.
" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceProductArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an AWS Marketplace product.
", "smithy.api#length": { "min": 4, "max": 2048 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceProductIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceProductArn" }, "traits": { "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) that identify AWS Marketplace products.
" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
", "smithy.api#length": { "min": 4, "max": 2048 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionArnList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionArn" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an AWS Marketplace solution.
", "smithy.api#length": { "min": 4, "max": 2048 }, "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifier" }, "traits": { "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) that identify AWS Marketplace solutions.
" } }, "com.amazonaws.partnercentralselling#AwsMaturity": { "type": "string", "traits": { "smithy.api#documentation": "The customer's level of experience with and adoption of AWS services.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#AwsMemberBusinessTitle": { "type": "enum", "members": { "AWS_SALES_REP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSSalesRep" } }, "AWS_ACCOUNT_OWNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSAccountOwner" } }, "WWPSPDM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WWPSPDM" } }, "PDM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PDM" } }, "PSM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PSM" } }, "ISVSM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISVSM" } }, "SIGNATORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Signatory" } } }, "traits": { "smithy.api#documentation": "The business title of an AWS team member who works on the opportunity.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityCustomer": { "type": "structure", "members": { "Contacts": { "target": "com.amazonaws.partnercentralselling#CustomerContactsList", "traits": { "smithy.api#documentation": "Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.
" } } }, "traits": { "smithy.api#documentation": "Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityInsights": { "type": "structure", "members": { "NextBestActions": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.
" } }, "EngagementScore": { "target": "com.amazonaws.partnercentralselling#EngagementScore", "traits": { "smithy.api#documentation": "Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.
" } }, "AwsProductsSpendInsightsBySource": { "target": "com.amazonaws.partnercentralselling#AwsProductsSpendInsightsBySource", "traits": { "smithy.api#documentation": "Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
" } }, "OpportunityQuality": { "target": "com.amazonaws.partnercentralselling#OpportunityQuality", "traits": { "smithy.api#documentation": "Opportunity quality assessment. Null if not yet scored.
" } }, "Recommendations": { "target": "com.amazonaws.partnercentralselling#RecommendationList", "traits": { "smithy.api#documentation": "List of recommendations from various agent-driven sources.
" } } }, "traits": { "smithy.api#documentation": "Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityLifeCycle": { "type": "structure", "members": { "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { "smithy.api#documentation": "Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.
" } }, "ClosedLostReason": { "target": "com.amazonaws.partnercentralselling#AwsClosedLostReason", "traits": { "smithy.api#documentation": "Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.
Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.
Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "NextStepsHistory": { "target": "com.amazonaws.partnercentralselling#ProfileNextStepsHistories", "traits": { "smithy.api#documentation": "Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.
", "smithy.api#length": { "max": 50 } } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityProject": { "type": "structure", "members": { "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { "smithy.api#documentation": "Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer\u2019s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
" } }, "AwsPartition": { "target": "com.amazonaws.partnercentralselling#AwsPartition", "traits": { "smithy.api#documentation": "AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityRelatedEntities": { "type": "structure", "members": { "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifiers", "traits": { "smithy.api#documentation": "Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.
" } }, "Solutions": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { "smithy.api#documentation": "Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.
" } }, "AwsMarketplaceSolutions": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifiers", "traits": { "smithy.api#documentation": "The AWS Marketplace solution ARNs associated with this opportunity.
" } }, "AwsMarketplaceProducts": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceProductIdentifiers", "traits": { "smithy.api#documentation": "The AWS Marketplace product ARNs associated with this opportunity.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityStage": { "type": "enum", "members": { "NOT_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Not Started" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "In Progress" } }, "PROSPECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Prospect" } }, "ENGAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Engaged" } }, "IDENTIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Identified" } }, "QUALIFY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Qualify" } }, "RESEARCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Research" } }, "SELLER_ENGAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Seller Engaged" } }, "EVALUATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Evaluating" } }, "SELLER_REGISTERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Seller Registered" } }, "TERM_SHEET_NEGOTIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Term Sheet Negotiation" } }, "CONTRACT_NEGOTIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Contract Negotiation" } }, "ONBOARDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Onboarding" } }, "BUILDING_INTEGRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Building Integration" } }, "QUALIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Qualified" } }, "ON_HOLD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "On-hold" } }, "TECHNICAL_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Technical Validation" } }, "BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Business Validation" } }, "COMMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Committed" } }, "LAUNCHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Launched" } }, "DEFERRED_TO_PARTNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deferred to Partner" } }, "CLOSED_LOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Closed Lost" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "CLOSED_INCOMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Closed Incomplete" } } }, "traits": { "smithy.api#documentation": "The stage of an AWS opportunity in its lifecycle.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunitySummaryFullView": { "type": "structure", "members": { "RelatedOpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "Identifier of the related partner opportunity.
" } }, "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { "smithy.api#documentation": "Source origin of the AWS opportunity.
" } }, "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { "smithy.api#documentation": "Type of AWS involvement in the opportunity.
" } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { "smithy.api#documentation": "Visibility level for the AWS opportunity.
" } }, "LifeCycle": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityLifeCycle", "traits": { "smithy.api#documentation": "Contains lifecycle details of the AWS opportunity, such as its stage, review status, and target close date.
" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList", "traits": { "smithy.api#documentation": "AWS team members involved in the opportunity.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityInsights", "traits": { "smithy.api#documentation": "Contains the insights that AWS provides for the opportunity, such as the engagement score and the recommended next actions.
" } }, "InvolvementTypeChangeReason": { "target": "com.amazonaws.partnercentralselling#InvolvementTypeChangeReason", "traits": { "smithy.api#documentation": "Reason for changes in AWS involvement type for the opportunity.
" } }, "RelatedEntityIds": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityRelatedEntities", "traits": { "smithy.api#documentation": "Lists the identifiers of entities that relate to the AWS opportunity, such as AWS products and partner solutions.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityCustomer", "traits": { "smithy.api#documentation": "Contains details about the customer that the AWS opportunity belongs to.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityProject", "traits": { "smithy.api#documentation": "Contains details about the project that the AWS opportunity covers.
" } }, "CosellMotion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
The plain-language reason for the current CosellMotion value. Read-only. Null when CosellMotion is null.
Seller-provided PARC deal terms: commitment value, discount, and contract dates.
" } } }, "traits": { "smithy.api#documentation": "Provides a comprehensive view of AwsOpportunitySummaryFullView template.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsTeamMember" }, "traits": { "smithy.api#documentation": "A list of AWS team members who work on the opportunity.
" } }, "com.amazonaws.partnercentralselling#AwsPartition": { "type": "enum", "members": { "AWS_EUSC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws-eusc" } } }, "traits": { "smithy.api#documentation": "The AWS partition where the opportunity will run. A partition is a group of AWS Regions with its own endpoints and IAM configuration. The only value is aws-eusc, which stands for the AWS European Sovereign Cloud.
AWS Partner Central product identifier used for opportunity association.
", "smithy.api#required": {} } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Pricing Calculator service code.
" } }, "Categories": { "target": "com.amazonaws.partnercentralselling#StringList", "traits": { "smithy.api#documentation": "List of program and pathway categories this product is eligible for.
", "smithy.api#length": { "min": 0, "max": 20 }, "smithy.api#required": {} } }, "Amount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Baseline service cost before optimizations.
" } }, "OptimizedAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Service cost after applying optimizations.
" } }, "PotentialSavingsAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Service-specific cost reduction through optimizations.
" } }, "Optimizations": { "target": "com.amazonaws.partnercentralselling#AwsProductOptimizationsList", "traits": { "smithy.api#documentation": "List of specific optimization recommendations for this product.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "List of AWS services with program eligibility indicators (MAP, modernization pathways), cost estimates, and optimization recommendations.
" } }, "com.amazonaws.partnercentralselling#AwsProductIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an AWS product.
" } }, "com.amazonaws.partnercentralselling#AwsProductIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifier" }, "traits": { "smithy.api#documentation": "A list of AWS product identifiers.
" } }, "com.amazonaws.partnercentralselling#AwsProductInsights": { "type": "structure", "members": { "CurrencyCode": { "target": "com.amazonaws.partnercentralselling#CurrencyCode", "traits": { "smithy.api#documentation": "ISO 4217 currency code. Supported values are USD and EUR. Returns EUR when the opportunity is in the aws-eusc (AWS European Sovereign Cloud) partition.
Time period for spend amounts.
", "smithy.api#required": {} } }, "TotalAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Total estimated spend for this source before optimizations.
" } }, "TotalOptimizedAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Total estimated spend after applying recommended optimizations.
" } }, "TotalPotentialSavingsAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Quantified savings achievable through implementing optimizations.
" } }, "TotalAmountByCategory": { "target": "com.amazonaws.partnercentralselling#AmountMap", "traits": { "smithy.api#documentation": "Spend amounts mapped to AWS programs and modernization pathways.
", "smithy.api#required": {} } }, "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductsList", "traits": { "smithy.api#documentation": "Product-level details including costs and optimization recommendations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Comprehensive spend analysis for a single source (AWS or Partner) including total amounts, optimization savings, program category breakdowns, and detailed product-level insights.
" } }, "com.amazonaws.partnercentralselling#AwsProductOptimization": { "type": "structure", "members": { "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Human-readable explanation of the optimization strategy.
", "smithy.api#required": {} } }, "SavingsAmount": { "target": "com.amazonaws.partnercentralselling#MonetaryAmount", "traits": { "smithy.api#documentation": "Quantified cost savings achievable by implementing this optimization.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specific optimization strategies partners can implement to reduce costs.
" } }, "com.amazonaws.partnercentralselling#AwsProductOptimizationsList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsProductOptimization" }, "traits": { "smithy.api#documentation": "List of optimization recommendations.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.partnercentralselling#AwsProductsList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#AwsProductDetails" }, "traits": { "smithy.api#documentation": "List of AWS services with program eligibility indicators.
", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.partnercentralselling#AwsProductsSpendInsightsBySource": { "type": "structure", "members": { "Partner": { "target": "com.amazonaws.partnercentralselling#AwsProductInsights", "traits": { "smithy.api#documentation": "Partner-sourced insights derived from Pricing Calculator URLs.
" } }, "AWS": { "target": "com.amazonaws.partnercentralselling#AwsProductInsights", "traits": { "smithy.api#documentation": "AI-generated insights including recommended products from AWS.
" } } }, "traits": { "smithy.api#documentation": "Source-separated spend insights that provide independent analysis for AWS recommendations and partner estimates.
" } }, "com.amazonaws.partnercentralselling#AwsSoftwareRevenue": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.partnercentralselling#MonetaryValue", "traits": { "smithy.api#documentation": "The committed value and currency for the procurement terms.
" } }, "Discount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Discount percentage offered on the software revenue. Percent convention: 15.00 means 15%.
" } }, "EffectiveDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Contract effective (start) date in YYYY-MM-DD format.
" } }, "ExpirationDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Contract expiration (end) date in YYYY-MM-DD format.
" } } }, "traits": { "smithy.api#documentation": "Seller-provided PARC deal terms for the opportunity, including commitment value, discount percentage, and contract dates.
" } }, "com.amazonaws.partnercentralselling#AwsSubmission": { "type": "structure", "members": { "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { "smithy.api#documentation": "Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.
", "smithy.api#required": {} } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { "smithy.api#documentation": "Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.
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.
" } }, "com.amazonaws.partnercentralselling#AwsTeamMember": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { "smithy.api#documentation": "Provides the Amazon Web Services team member's email address.
" } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "Provides the Amazon Web Services team member's first name.
", "smithy.api#pattern": "^(?s).{0,80}$" } }, "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "Provides the Amazon Web Services team member's last name.
", "smithy.api#pattern": "^(?s).{0,80}$" } }, "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#AwsMemberBusinessTitle", "traits": { "smithy.api#documentation": "Specifies the Amazon Web Services team member's business title and indicates their organizational role.
" } } }, "traits": { "smithy.api#documentation": "Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.
" } }, "com.amazonaws.partnercentralselling#BestOutreachWindow": { "type": "structure", "members": { "Day": { "target": "com.amazonaws.partnercentralselling#DayOfWeek", "traits": { "smithy.api#documentation": "The day of the week that this outreach window applies to. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
The inclusive start of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
The exclusive end of the outreach window, in Coordinated Universal Time (UTC), in 24-hour HH:mm format.
A single recommended outreach window for one day, expressed in Coordinated Universal Time (UTC).
" } }, "com.amazonaws.partnercentralselling#BestOutreachWindowList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#BestOutreachWindow" }, "traits": { "smithy.api#documentation": "One to seven distinct complete outreach windows. Multiple windows may use the same day.", "smithy.api#length": { "min": 1, "max": 7 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.partnercentralselling#Bucket": { "type": "structure", "members": { "Values": { "target": "com.amazonaws.partnercentralselling#BucketValueList", "traits": { "smithy.api#documentation": "The field value that defines this group.
", "smithy.api#required": {} } }, "Count": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of customer accounts in this group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One group in an aggregation result. It includes the field values that define the group and the number of customer accounts in it.
" } }, "com.amazonaws.partnercentralselling#BucketList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Bucket" }, "traits": { "smithy.api#documentation": "Information about bucket list.
", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.partnercentralselling#BucketValueList": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "Information about bucket value list.
", "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.partnercentralselling#BulkFileFormat": { "type": "enum", "members": { "CSV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CSV" } } }, "traits": { "smithy.api#documentation": "File format for bulk input and report files." } }, "com.amazonaws.partnercentralselling#BulkFileName": { "type": "string", "traits": { "smithy.api#documentation": "Display name of the uploaded file (derived from the job's file URI), surfaced in\nresponses so a partner can recognise a job by the file they uploaded rather than the\nrandom JobId.", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralselling#BulkJobArn": { "type": "string", "traits": { "smithy.api#documentation": "Information about bulk job arn.
", "smithy.api#pattern": "^arn:[a-z\\-]*:partnercentral:[a-z0-9\\-]*:[0-9]{12}:catalog/[a-zA-Z]+/customer-account-bulk-job/bulkjob-[0-9a-z]{13}$" } }, "com.amazonaws.partnercentralselling#BulkJobArnOrIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "Information about bulk job arn or identifier.
", "smithy.api#pattern": "^(arn:.*|bulkjob-[0-9a-z]{13})$" } }, "com.amazonaws.partnercentralselling#BulkJobId": { "type": "string", "traits": { "smithy.api#documentation": "Unique identifier for a bulk job.", "smithy.api#pattern": "^bulkjob-[0-9a-z]{13}$" } }, "com.amazonaws.partnercentralselling#BulkJobResult": { "type": "structure", "members": { "RequestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the record in the bulk job file.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkRecordStatus", "traits": { "smithy.api#documentation": "The outcome of processing the record.
", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "This value is the identifier of the resource that Partner Central created or updated for the record. A failed record includes this value when Partner Central created the resource before the failure.
" } }, "ErrorCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A code that identifies why the record failed. Present only when the record failed.
" } }, "ErrorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of why the record failed. Present only when the record failed.
" } } }, "traits": { "smithy.api#documentation": "The outcome of processing a single record within a bulk job. It identifies the record and, when the record didn't succeed, carries an error code and message.
" } }, "com.amazonaws.partnercentralselling#BulkJobResultList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#BulkJobResult" }, "traits": { "smithy.api#documentation": "Information about bulk job result list.
" } }, "com.amazonaws.partnercentralselling#BulkJobStatus": { "type": "enum", "members": { "SUBMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job was created and is waiting to start.
", "smithy.api#enumValue": "SUBMITTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job is processing records.
", "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job finished processing all records. Some records might have failed.
", "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job failed. See FailureReason for details.
The job creates new opportunities.
", "smithy.api#enumValue": "BULK_CREATE" } }, "BULK_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The job updates existing opportunities.
", "smithy.api#enumValue": "BULK_UPDATE" } } }, "traits": { "smithy.api#documentation": "The operation a bulk job performs on each record, determined by the template the\npartner uploads: BULK_CREATE creates new records, BULK_UPDATE updates existing ones." } }, "com.amazonaws.partnercentralselling#BulkRecordStatus": { "type": "enum", "members": { "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The record was processed successfully.
", "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The record failed.
", "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "Outcome status for a single record in a bulk job." } }, "com.amazonaws.partnercentralselling#BulkReportStatus": { "type": "enum", "members": { "NOT_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The report hasn't been generated yet.
", "smithy.api#enumValue": "NOT_STARTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The report is being generated.
", "smithy.api#enumValue": "IN_PROGRESS" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The report is ready to download.
", "smithy.api#enumValue": "AVAILABLE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The report couldn't be generated. See FailureReason for details.
The report covers only the records that failed.
", "smithy.api#enumValue": "FAILED_RECORDS" } }, "ALL_RECORDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Reserved for future use.
", "smithy.api#enumValue": "ALL_RECORDS" } } }, "traits": { "smithy.api#documentation": "Type of report to generate." } }, "com.amazonaws.partnercentralselling#BulkReportUrl": { "type": "string", "traits": { "smithy.api#documentation": "Short-lived presigned URL for downloading a report file.", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#CatalogIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "Value space is validated at runtime against an allowlist, so the model keeps only a coarse character-class pattern.", "smithy.api#pattern": "^[a-zA-Z]+$" } }, "com.amazonaws.partnercentralselling#Channel": { "type": "enum", "members": { "AWS_MARKETING_CENTRAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS Marketing Central" } }, "CONTENT_SYNDICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Content Syndication" } }, "DISPLAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Display" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Email" } }, "LIVE_EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Live Event" } }, "OUT_OF_HOME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Out Of Home (OOH)" } }, "PRINT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Print" } }, "SEARCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Search" } }, "SOCIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Social" } }, "TELEMARKETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Telemarketing" } }, "TV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TV" } }, "VIDEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Video" } }, "VIRTUAL_EVENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Virtual Event" } } }, "traits": { "smithy.api#documentation": "A marketing channel that the partner uses for a marketing activity.
" } }, "com.amazonaws.partnercentralselling#ChannelName": { "type": "string", "traits": { "smithy.api#documentation": "Server-validated outreach channel name." } }, "com.amazonaws.partnercentralselling#ChannelRecommendation": { "type": "structure", "members": { "RecommendedChannel": { "target": "com.amazonaws.partnercentralselling#ChannelName", "traits": { "smithy.api#documentation": "The recommended outreach channel for the group of similar leads. Valid values are EMAIL and CALL.
The recommended day-specific outreach windows for the recommended channel, expressed in Coordinated Universal Time (UTC). Each window applies to one day, and more than one window can fall on the same day. This field is optional and appears only when window guidance is available.
" } } }, "traits": { "smithy.api#documentation": "Aggregated outreach guidance for leads that share the same country, geography, region, and company segment. It names the outreach channel most commonly recommended for that group and, optionally, the days and times that channel is best used. This is group-level guidance. It doesn't describe an individual lead's contact history or rank recommendations for a specific lead.
" } }, "com.amazonaws.partnercentralselling#Channels": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Channel" }, "traits": { "smithy.api#documentation": "A list of marketing channels that the partner uses for a marketing activity.
" } }, "com.amazonaws.partnercentralselling#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that the client provides to make a request idempotent.
", "smithy.api#pattern": "^.{1,255}$" } }, "com.amazonaws.partnercentralselling#ClosedLostReason": { "type": "enum", "members": { "CUSTOMER_DEFICIENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Deficiency" } }, "DELAY_CANCELLATION_OF_PROJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Delay / Cancellation of Project" } }, "LEGAL_TAX_REGULATORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Legal / Tax / Regulatory" } }, "LOST_TO_COMPETITOR_GOOGLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Google" } }, "LOST_TO_COMPETITOR_MICROSOFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Microsoft" } }, "LOST_TO_COMPETITOR_SOFTLAYER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - SoftLayer" } }, "LOST_TO_COMPETITOR_VMWARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - VMWare" } }, "LOST_TO_COMPETITOR_OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lost to Competitor - Other" } }, "NO_OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Opportunity" } }, "ON_PREMISES_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "On Premises Deployment" } }, "PARTNER_GAP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Partner Gap" } }, "PRICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Price" } }, "SECURITY_COMPLIANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Security / Compliance" } }, "TECHNICAL_LIMITATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Technical Limitations" } }, "CUSTOMER_EXPERIENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Experience" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other" } }, "PEOPLERELATIONSHIPGOVERNANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "People/Relationship/Governance" } }, "PRODUCTTECHNOLOGY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Product/Technology" } }, "FINANCIALCOMMERCIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Financial/Commercial" } } }, "traits": { "smithy.api#documentation": "The reason that the partner gives for closing an opportunity as lost.
" } }, "com.amazonaws.partnercentralselling#CompanyName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a company.
", "smithy.api#pattern": "^(?s).{1,120}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#CompanyWebsiteUrl": { "type": "string", "traits": { "smithy.api#documentation": "The website URL of a company.
", "smithy.api#pattern": "^(?=.{4,255}$)((http|https)://)??(www[.])??([a-zA-Z0-9]|-)+?([.][a-zA-Z0-9(-|/|=|?)??]+?)+?$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#CompetitorName": { "type": "enum", "members": { "ORACLE_CLOUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Oracle Cloud" } }, "ON_PREM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "On-Prem" } }, "CO_LOCATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-location" } }, "AKAMAI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Akamai" } }, "ALICLOUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AliCloud" } }, "GOOGLE_CLOUD_PLATFORM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Google Cloud Platform" } }, "IBM_SOFTLAYER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IBM Softlayer" } }, "MICROSOFT_AZURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Microsoft Azure" } }, "OTHER_COST_OPTIMIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other- Cost Optimization" } }, "NO_COMPETITION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No Competition" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "*Other" } } }, "traits": { "smithy.api#documentation": "The name of a competitor of the opportunity.
" } }, "com.amazonaws.partnercentralselling#ConflictException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the conflict.
" } } }, "traits": { "smithy.api#documentation": "This error occurs when the request can\u2019t 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.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.partnercentralselling#Contact": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { "smithy.api#documentation": "The contact's email address associated with the Opportunity.
The contact's first name associated with the Opportunity.
The contact's last name associated with the Opportunity.
The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.
The contact's phone number associated with the Opportunity.
An object that contains a Customer Partner's contact details.
A part of the day when a contact prefers to be reached. Valid values are MORNING, AFTERNOON, and EVENING.
The identifier of an engagement context. The value is a whole number that doesn't start with zero.
", "smithy.api#pattern": "^[1-9][0-9]*$" } }, "com.amazonaws.partnercentralselling#ContextIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ContextIdentifier" }, "traits": { "smithy.api#documentation": "A list of engagement context identifiers.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#CosellMotion": { "type": "string", "traits": { "smithy.api#documentation": "The engagement classification of an AWS opportunity, such as AWS Field-engaged, Agent-engaged, or Partner-led.
A two-letter country code, such as US.
Use CreateCustomerAccount to map a customer account from your records to an AWS customer. Provide details about the customer, such as the company name and website. AWS then matches the account to a customer and adds enrichment information about it.
Matching runs asynchronously. The response returns the new customer account with a status of PENDING. Use GetCustomerAccount to check the result and read the enrichment information.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the details of the customer, such as the company name, website, and address. AWS uses these details to match the account to a customer.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Specifies your own identifier for the customer account, such as the account ID in your CRM system. Use it to correlate the customer account with your records.
" } }, "Tags": { "target": "com.amazonaws.partnercentralselling#CustomerAccountTagList", "traits": { "smithy.api#documentation": "Specifies the tags to add to the customer account. Each tag is a key-value pair.
" } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to make the request idempotent. If you retry a request with the same token, the operation returns the result of the original request instead of creating another customer account.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#documentation": "Information about create customer account request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#CreateCustomerAccountResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer account.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#CustomerAccountId", "traits": { "smithy.api#documentation": "The unique identifier of the customer account.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#EnrichmentStatus", "traits": { "smithy.api#documentation": "The enrichment status of the new customer account. A new account starts as PENDING.
The catalog that the customer account belongs to.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Your own identifier for the customer account, if you provided one.
" } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about create customer account response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#CreateEngagement": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#CreateEngagementRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#CreateEngagementResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to creating engagements in AWS Partner Central" }, "smithy.api#documentation": "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.
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.
", "smithy.api#http": { "method": "POST", "uri": "/CreateEngagementContext", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#CreateEngagementContextRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.
The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.
A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.partnercentralselling#EngagementContextType", "traits": { "smithy.api#documentation": "Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
Contains the contextual information to add to the engagement. The structure of this payload depends on the context type in the Type field.
Contains the request parameters for the CreateEngagementContext operation.
The unique identifier of the engagement to which the context was added. This ID confirms the successful association of the context with the specified engagement.
" } }, "EngagementArn": { "target": "com.amazonaws.partnercentralselling#EngagementArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the engagement to which the context was added. This globally unique identifier can be used for cross-service references and IAM policies.
" } }, "EngagementLastModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the engagement was last modified as a result of adding the context, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\".
" } }, "ContextId": { "target": "com.amazonaws.partnercentralselling#EngagementContextIdentifier", "traits": { "smithy.api#documentation": "The unique identifier assigned to the newly created engagement context. This ID can be used to reference the specific context within the engagement for future operations.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the CreateEngagementContext action returns.
This action creates an invitation from a sender to a single receiver to join an engagement.
", "smithy.api#http": { "method": "POST", "uri": "/CreateEngagementInvitation", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#CreateEngagementInvitationRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or LeadInvitation, which includes structures for customer information and interaction details.
Contains the request parameters for the CreateEngagementInvitation operation.
Unique identifier assigned to the newly created engagement invitation.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response that the CreateEngagementInvitation action returns.
The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.
Specifies the title of the Engagement.
Provides a description of the Engagement.
The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
Contains the request parameters for the CreateEngagement operation.
Unique identifier assigned to the newly created engagement.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#EngagementArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the engagement.
" } }, "ModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). For newly created engagements, this value matches the creation timestamp. Example: \"2023-05-01T20:37:46Z\".
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the CreateEngagement action returns.
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.
", "smithy.api#http": { "method": "POST", "uri": "/CreateOpportunity", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#CreateOpportunityRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.
Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.
Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.
Cosell\u2014Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
Cosell\u2014Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.
Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.
Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.
Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.
This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.
", "smithy.api#pattern": "^(?s).{0,64}$" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { "smithy.api#documentation": "Specifies customer details associated with the Opportunity.
An object that contains project details for the Opportunity.
Specifies the opportunity type as a renewal, new, or expansion.
Opportunity types:
New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
This object contains marketing details and is optional for an opportunity.
" } }, "SoftwareRevenue": { "target": "com.amazonaws.partnercentralselling#SoftwareRevenue", "traits": { "smithy.api#documentation": "Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.
" } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { "smithy.api#documentation": "Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.
Default: None
Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: \"Conflicting client token submitted for a new request body.\"
An object that contains lifecycle details for the Opportunity.
Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.
Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.
" } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the CreateOpportunity operation.
Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": " DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.
Contains the response that the CreateOpportunity action returns.
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.
", "smithy.api#http": { "method": "POST", "uri": "/CreateResourceSnapshot", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#CreateResourceSnapshotJob": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#CreateResourceSnapshotJobRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#CreateResourceSnapshotJobResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to creating resource snapshot jobs in AWS Partner Central" }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/CreateResourceSnapshotJob", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#CreateResourceSnapshotJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.
A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "Specifies the identifier of the engagement associated with the resource to be snapshotted.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.
Specifies the name of the template that defines the schema for the snapshot.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the CreateResourceSnapshotJob operation.
The unique identifier for the created snapshot job.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created snapshot job.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the CreateResourceSnapshotJob action returns.
Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.
The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.
The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.
The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.
Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the CreateResourceSnapshot operation.
Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.
" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { "smithy.api#documentation": "Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the CreateResourceSnapshot action returns.
Filter opportunities created after this date.
" } }, "BeforeCreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Filter opportunities created before this date.
" } } }, "traits": { "smithy.api#documentation": "Filter for opportunities based on creation date range.
" } }, "com.amazonaws.partnercentralselling#CurrencyCode": { "type": "enum", "members": { "USD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USD" } }, "EUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EUR" } }, "GBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GBP" } }, "AUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUD" } }, "CAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAD" } }, "CNY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CNY" } }, "NZD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NZD" } }, "INR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INR" } }, "JPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JPY" } }, "CHF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHF" } }, "SEK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEK" } }, "AED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AED" } }, "AFN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFN" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "AMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMD" } }, "ANG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANG" } }, "AOA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AOA" } }, "ARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARS" } }, "AWG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWG" } }, "AZN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AZN" } }, "BAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BAM" } }, "BBD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BBD" } }, "BDT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BDT" } }, "BGN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BGN" } }, "BHD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BHD" } }, "BIF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BIF" } }, "BMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BMD" } }, "BND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BND" } }, "BOB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BOB" } }, "BOV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BOV" } }, "BRL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BRL" } }, "BSD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BSD" } }, "BTN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BTN" } }, "BWP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BWP" } }, "BYN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYN" } }, "BZD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BZD" } }, "CDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CDF" } }, "CHE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHE" } }, "CHW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHW" } }, "CLF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLF" } }, "CLP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLP" } }, "COP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COP" } }, "COU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COU" } }, "CRC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRC" } }, "CUC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUC" } }, "CUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUP" } }, "CVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CVE" } }, "CZK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CZK" } }, "DJF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DJF" } }, "DKK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DKK" } }, "DOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOP" } }, "DZD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DZD" } }, "EGP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EGP" } }, "ERN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERN" } }, "ETB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ETB" } }, "FJD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FJD" } }, "FKP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FKP" } }, "GEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GEL" } }, "GHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GHS" } }, "GIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GIP" } }, "GMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GMD" } }, "GNF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GNF" } }, "GTQ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GTQ" } }, "GYD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GYD" } }, "HKD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HKD" } }, "HNL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HNL" } }, "HRK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HRK" } }, "HTG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTG" } }, "HUF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HUF" } }, "IDR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDR" } }, "ILS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ILS" } }, "IQD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IQD" } }, "IRR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IRR" } }, "ISK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISK" } }, "JMD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JMD" } }, "JOD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JOD" } }, "KES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KES" } }, "KGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KGS" } }, "KHR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KHR" } }, "KMF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMF" } }, "KPW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KPW" } }, "KRW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KRW" } }, "KWD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KWD" } }, "KYD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KYD" } }, "KZT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KZT" } }, "LAK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAK" } }, "LBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LBP" } }, "LKR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LKR" } }, "LRD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LRD" } }, "LSL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LSL" } }, "LYD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LYD" } }, "MAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAD" } }, "MDL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MDL" } }, "MGA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MGA" } }, "MKD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MKD" } }, "MMK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MMK" } }, "MNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MNT" } }, "MOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MOP" } }, "MRU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MRU" } }, "MUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUR" } }, "MVR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MVR" } }, "MWK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MWK" } }, "MXN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MXN" } }, "MXV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MXV" } }, "MYR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MYR" } }, "MZN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MZN" } }, "NAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NAD" } }, "NGN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NGN" } }, "NIO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NIO" } }, "NOK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOK" } }, "NPR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NPR" } }, "OMR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OMR" } }, "PAB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAB" } }, "PEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PEN" } }, "PGK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PGK" } }, "PHP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHP" } }, "PKR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PKR" } }, "PLN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLN" } }, "PYG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PYG" } }, "QAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QAR" } }, "RON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RON" } }, "RSD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RSD" } }, "RUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUB" } }, "RWF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RWF" } }, "SAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAR" } }, "SBD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SBD" } }, "SCR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCR" } }, "SDG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SDG" } }, "SGD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SGD" } }, "SHP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHP" } }, "SLL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SLL" } }, "SOS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOS" } }, "SRD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SRD" } }, "SSP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SSP" } }, "STN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STN" } }, "SVC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SVC" } }, "SYP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SYP" } }, "SZL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SZL" } }, "THB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THB" } }, "TJS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TJS" } }, "TMT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TMT" } }, "TND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TND" } }, "TOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOP" } }, "TRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRY" } }, "TTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TTD" } }, "TWD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TWD" } }, "TZS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TZS" } }, "UAH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UAH" } }, "UGX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UGX" } }, "USN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USN" } }, "UYI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UYI" } }, "UYU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UYU" } }, "UZS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UZS" } }, "VEF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VEF" } }, "VND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VND" } }, "VUV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VUV" } }, "WST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WST" } }, "XAF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XAF" } }, "XCD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XCD" } }, "XDR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XDR" } }, "XOF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XOF" } }, "XPF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XPF" } }, "XSU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XSU" } }, "XUA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XUA" } }, "YER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YER" } }, "ZAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZAR" } }, "ZMW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZMW" } }, "ZWL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZWL" } } }, "traits": { "smithy.api#documentation": "A three-letter ISO 4217 currency code, such as USD.
An object that contains the customer's account details.
" } }, "Contacts": { "target": "com.amazonaws.partnercentralselling#CustomerContactsList", "traits": { "smithy.api#documentation": "Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.
An object that contains the customer's Account and Contact.
Information about customer account arn.
", "smithy.api#pattern": "^arn:[a-z\\-]*:partnercentral:[a-z0-9\\-]*:[0-9]{12}:catalog/[a-zA-Z]+/customer-account/cust-acc-[0-9a-z]{13}$" } }, "com.amazonaws.partnercentralselling#CustomerAccountArnOrIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or the identifier of a customer account. An identifier starts with cust-acc- followed by 13 lowercase letters or digits.
Filters the results to the bulk job with the specified ARN or identifier.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "Filters the results to bulk jobs with the specified status.
" } } }, "traits": { "smithy.api#documentation": "The criteria that limit which bulk jobs ListCustomerAccountBulkJobs returns.
The Amazon Resource Name (ARN) of the bulk job.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#JobId", "traits": { "smithy.api#documentation": "The unique identifier of the bulk job.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "The current status of the bulk job.
", "smithy.api#required": {} } }, "FileName": { "target": "com.amazonaws.partnercentralselling#FileName", "traits": { "smithy.api#documentation": "The name of the file that the job processes.
" } }, "TotalRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of records in the file. The value is 0 until the job reads the file.
", "smithy.api#required": {} } }, "ProcessedRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that the job has finished processing.
", "smithy.api#required": {} } }, "SuccessCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that the job processed successfully.
", "smithy.api#required": {} } }, "FailureCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that failed.
", "smithy.api#required": {} } }, "DeletedCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of accounts imported by this job that have since been deleted. This counter only increases, so the accounts still present equal SuccessCount minus DeletedCount.
The reason that the job failed. Present only when the job status is FAILED.
The date and time when the bulk job was created.
", "smithy.api#required": {} } }, "CompletedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the job finished. Absent while the job is running.
" } } }, "traits": { "smithy.api#documentation": "A bulk job in the results of ListCustomerAccountBulkJobs. It includes the job status, the file name, and the record counts.
Information about customer account bulk job summary list.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.partnercentralselling#CustomerAccountContext": { "type": "structure", "members": { "AccountIdentifier": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArnOrIdentifier", "traits": { "smithy.api#documentation": "The identifier of the customer account that the engagement concerns, as an Amazon Resource Name (ARN) or a customer account identifier.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AccountCustomer", "traits": { "smithy.api#documentation": "A snapshot of the customer company's identity for the account. On read, the service populates this from the account identifier.
" } } }, "traits": { "smithy.api#documentation": "The customer account context for an account-planning engagement. It names the account the plan concerns. The identifying details can be supplied by the caller or derived by the service from the account identifier.
" } }, "com.amazonaws.partnercentralselling#CustomerAccountData": { "type": "structure", "members": { "CompanyName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "The name of the customer company.
", "smithy.api#pattern": "^(?s).{0,120}$", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#WebsiteUrl", "traits": { "smithy.api#documentation": "The website URL of the customer company.
", "smithy.api#pattern": "^(?s).{4,255}$" } }, "Duns": { "target": "com.amazonaws.partnercentralselling#DunsNumber", "traits": { "smithy.api#documentation": "The Data Universal Numbering System (DUNS) number of the customer company.
", "smithy.api#pattern": "^[0-9]{9}$" } }, "Address": { "target": "com.amazonaws.partnercentralselling#Address", "traits": { "smithy.api#documentation": "The address of the customer company.
" } }, "Industry": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The industry of the customer company.
" } }, "OtherIndustry": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the industry, used when the industry is Other.
The internet domain of the customer company, such as example.com.
The name of the parent company of the customer company, if any.
", "smithy.api#pattern": "^(?s).{0,120}$" } } }, "traits": { "smithy.api#documentation": "The customer information that you provide for a customer account, such as the company name, website, and address. We use these details to match the account to a customer.
" } }, "com.amazonaws.partnercentralselling#CustomerAccountDetailsSummary": { "type": "structure", "members": { "CompanyName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "The name of the customer company.
", "smithy.api#pattern": "^(?s).{0,120}$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The customer information for an account in search results. It carries a reduced set of fields compared to the full customer information that GetCustomerAccount returns, omitting sensitive fields such as the Data Universal Numbering System (DUNS) number and the street address. To read those fields, use GetCustomerAccount.
The customer is already mapped by another customer account. ExistingCustomerAccountArn identifies that account.
An error occurred while processing the customer account.
", "smithy.api#enumValue": "PROCESSING_ERROR" } } }, "traits": { "smithy.api#documentation": "The reason that a customer account needs your action.
" } }, "com.amazonaws.partnercentralselling#CustomerAccountId": { "type": "string", "traits": { "smithy.api#documentation": "Information about customer account id.
", "smithy.api#pattern": "^cust-acc-[0-9a-z]{13}$" } }, "com.amazonaws.partnercentralselling#CustomerAccountSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.partnercentralselling#SortableField", "traits": { "smithy.api#documentation": "The field to sort the results by.
", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The direction of the sort, either ascending or descending.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The field to sort customer accounts by, and the sort direction.
" } }, "com.amazonaws.partnercentralselling#CustomerAccountSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer account.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#CustomerAccountId", "traits": { "smithy.api#documentation": "The unique identifier of the customer account.
", "smithy.api#required": {} } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "The catalog that the customer account belongs to.
", "smithy.api#required": {} } }, "EnrichmentStatus": { "target": "com.amazonaws.partnercentralselling#EnrichmentStatus", "traits": { "smithy.api#documentation": "The enrichment status of the customer account.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Your own identifier for the customer account, if you provided one.
" } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was created.
", "smithy.api#required": {} } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was last modified.
", "smithy.api#required": {} } }, "CustomerAccount": { "target": "com.amazonaws.partnercentralselling#CustomerAccountDetailsSummary", "traits": { "smithy.api#documentation": "A summary of the details of the customer that you provided.
", "smithy.api#required": {} } }, "AwsEnrichment": { "target": "com.amazonaws.partnercentralselling#AwsEnrichmentSummary", "traits": { "smithy.api#documentation": "A summary of the enrichment information that AWS provides about the customer. Present only when EnrichmentStatus is ENRICHED.
A customer account in the results of SearchCustomerAccounts. It carries a reduced set of fields compared to the full account that is returned by GetCustomerAccount.
Information about customer account summary list.
" } }, "com.amazonaws.partnercentralselling#CustomerAccountTagList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Tag" }, "traits": { "smithy.api#documentation": "A list of tags to assign to a customer account.
", "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.partnercentralselling#CustomerAction": { "type": "string", "traits": { "smithy.api#documentation": "An action that the customer took during a lead interaction.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#CustomerContactsList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Contact" }, "traits": { "smithy.api#documentation": "A list of contacts at the customer's company.
" } }, "com.amazonaws.partnercentralselling#CustomerProjectsContext": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#EngagementCustomer", "traits": { "smithy.api#documentation": "Contains details about the customer that the customer project belongs to.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#EngagementCustomerProjectDetails", "traits": { "smithy.api#documentation": "Information about the customer project associated with the Engagement.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#CustomerSummary": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.partnercentralselling#AccountSummary", "traits": { "smithy.api#documentation": "An object that contains a customer's account details.
" } } }, "traits": { "smithy.api#documentation": "An object that contains a Customer object's subset of fields.
A date in YYYY-MM-DD format.
A date and time in ISO 8601 date-time format, such as 2023-05-01T20:37:46Z.
The day is Monday.
", "smithy.api#enumValue": "MONDAY" } }, "TUESDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Tuesday.
", "smithy.api#enumValue": "TUESDAY" } }, "WEDNESDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Wednesday.
", "smithy.api#enumValue": "WEDNESDAY" } }, "THURSDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Thursday.
", "smithy.api#enumValue": "THURSDAY" } }, "FRIDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Friday.
", "smithy.api#enumValue": "FRIDAY" } }, "SATURDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Saturday.
", "smithy.api#enumValue": "SATURDAY" } }, "SUNDAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The day is Sunday.
", "smithy.api#enumValue": "SUNDAY" } } }, "traits": { "smithy.api#documentation": "Days of the week \u2014 universally stable set, modeled as enum per API Design Guide." } }, "com.amazonaws.partnercentralselling#DeleteCustomerAccount": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#DeleteCustomerAccountRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#DeleteCustomerAccountResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "smithy.api#documentation": "Use DeleteCustomerAccount to delete a customer account. This operation is idempotent. Deleting a customer account that was already deleted succeeds.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the customer account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about delete customer account request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#DeleteCustomerAccountResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Information about delete customer account response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#DeleteResourceSnapshotJob": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#DeleteResourceSnapshotJobRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to deleting resource snapshot jobs on AWS Partner Central" }, "smithy.api#documentation": "Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteResourceSnapshotJob", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#DeleteResourceSnapshotJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.
The unique identifier of the resource snapshot job to be deleted.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the DeleteResourceSnapshotJob operation.
A model that the partner uses to deliver the solution to the customer.
" } }, "com.amazonaws.partnercentralselling#DeliveryModels": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#DeliveryModel" }, "traits": { "smithy.api#documentation": "A list of models that the partner uses to deliver the solution to the customer.
" } }, "com.amazonaws.partnercentralselling#DisassociateOpportunity": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#DisassociateOpportunityRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "partnercentral:RelatedEntityType" ], "aws.iam#iamAction": { "documentation": "Grants permission to disassociate Opportunities on AWS Partner Central from other entities" }, "smithy.api#documentation": "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.
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } }, "RelatedEntityType": { "target": "com.amazonaws.partnercentralselling#RelatedEntityType", "traits": { "smithy.api#documentation": "The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
", "smithy.api#required": {} } }, "RelatedEntityIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.
For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.
", "smithy.api#pattern": "^(?s).{1,255}$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the DisassociateOpportunity operation.
The internet domain of a company, such as example.com.
A nine-digit Data Universal Numbering System (DUNS) number that identifies a company.
", "smithy.api#pattern": "^[0-9]{9}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#EligibleProgramList": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "Information about eligible program list.
", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.partnercentralselling#EligibleProgramsList": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#documentation": "A list of AWS Greenfield programs that the prospected customer is eligible for.
" } }, "com.amazonaws.partnercentralselling#Email": { "type": "string", "traits": { "smithy.api#documentation": "An email address.
", "smithy.api#pattern": "^(?=.{0,80}$)[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#Engagement": { "type": "resource", "identifiers": { "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier" }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#CreateEngagement" }, "read": { "target": "com.amazonaws.partnercentralselling#GetEngagement" }, "list": { "target": "com.amazonaws.partnercentralselling#ListEngagements" }, "operations": [ { "target": "com.amazonaws.partnercentralselling#ListEngagementMembers" } ], "collectionOperations": [ { "target": "com.amazonaws.partnercentralselling#SearchEngagements" } ], "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/engagement/{Identifier}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents an engagement that is in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#EngagementArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an engagement.
", "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or the identifier of an engagement. An identifier starts with eng- followed by 14 lowercase letters or digits.
The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
" } }, "Type": { "target": "com.amazonaws.partnercentralselling#EngagementContextType", "traits": { "smithy.api#documentation": "Specifies the type of Engagement context. Valid values are \"CustomerProject\" or \"Document\", indicating whether the context relates to a customer project or a document respectively.
", "smithy.api#required": {} } }, "Payload": { "target": "com.amazonaws.partnercentralselling#EngagementContextPayload", "traits": { "smithy.api#documentation": "Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
" } } }, "traits": { "smithy.api#documentation": "Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.
" } }, "com.amazonaws.partnercentralselling#EngagementContextIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an engagement context.
", "smithy.api#pattern": "^(?s).{1,3}$" } }, "com.amazonaws.partnercentralselling#EngagementContextPayload": { "type": "union", "members": { "CustomerProject": { "target": "com.amazonaws.partnercentralselling#CustomerProjectsContext", "traits": { "smithy.api#documentation": "Contains detailed information about a customer project when the context type is \"CustomerProject\". This field is present only when the Type in EngagementContextDetails is set to \"CustomerProject\".
" } }, "Lead": { "target": "com.amazonaws.partnercentralselling#LeadContext", "traits": { "smithy.api#documentation": "Contains detailed information about a lead when the context type is \"Lead\". This field is present only when the Type in EngagementContextDetails is set to \"Lead\".
" } }, "ProspectingResult": { "target": "com.amazonaws.partnercentralselling#ProspectingResult", "traits": { "smithy.api#documentation": "Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is \"ProspectingResult\".
" } }, "CustomerAccount": { "target": "com.amazonaws.partnercentralselling#CustomerAccountContext", "traits": { "smithy.api#documentation": "The customer account context for account planning. This field appears only when the context type is CustomerAccount.
Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.
" } }, "com.amazonaws.partnercentralselling#EngagementContextType": { "type": "enum", "members": { "CUSTOMER_PROJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerProject" } }, "LEAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lead" } }, "PROSPECTING_RESULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ProspectingResult" } }, "CUSTOMER_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerAccount" } } }, "traits": { "smithy.api#documentation": "The type of an engagement context. Valid values are CustomerProject, Lead, ProspectingResult, and CustomerAccount.
A list of engagement context types.
", "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.partnercentralselling#EngagementContexts": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementContextDetails" }, "traits": { "smithy.api#documentation": "A list of engagement contexts.
", "smithy.api#length": { "max": 5 } } }, "com.amazonaws.partnercentralselling#EngagementCustomer": { "type": "structure", "members": { "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { "smithy.api#documentation": "Specifies the industry to which the customer\u2019s company belongs. This field helps categorize the opportunity based on the customer\u2019s business sector.
", "smithy.api#required": {} } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { "smithy.api#documentation": "Represents the name of the customer\u2019s company associated with the Engagement Invitation. This field is used to identify the customer.
", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#CompanyWebsiteUrl", "traits": { "smithy.api#documentation": "Provides the website URL of the customer\u2019s company. This field helps partners verify the legitimacy and size of the customer organization.
", "smithy.api#required": {} } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { "smithy.api#documentation": "Indicates the country in which the customer\u2019s company operates. This field is useful for understanding regional requirements or compliance needs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains details about the customer associated with the Engagement Invitation, including company information and industry.
" } }, "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem": { "type": "string", "traits": { "smithy.api#documentation": "A description of the business problem that the customer wants to solve.
", "smithy.api#pattern": "^(?s).{20,2000}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#EngagementCustomerProjectDetails": { "type": "structure", "members": { "Title": { "target": "com.amazonaws.partnercentralselling#EngagementCustomerProjectTitle", "traits": { "smithy.api#documentation": "The title of the project.
", "smithy.api#required": {} } }, "BusinessProblem": { "target": "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem", "traits": { "smithy.api#documentation": "A description of the business problem the project aims to solve.
", "smithy.api#required": {} } }, "TargetCompletionDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The target completion date for the customer's project.
", "smithy.api#pattern": "^[1-9][0-9]{3}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements.
" } }, "com.amazonaws.partnercentralselling#EngagementCustomerProjectTitle": { "type": "string", "traits": { "smithy.api#documentation": "The title of the customer project in an engagement.
", "smithy.api#pattern": "^(?s).{1,255}$" } }, "com.amazonaws.partnercentralselling#EngagementDescription": { "type": "string", "traits": { "smithy.api#documentation": "The description of an engagement.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "com.amazonaws.partnercentralselling#EngagementFromOpportunityTask": { "type": "resource", "identifiers": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" }, "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#StartEngagementFromOpportunityTask" }, "list": { "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasks" }, "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/engagement-from-opportunity-task/{TaskId}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-from-opportunity-task", "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents a task that starts an Engagement from an Opportunity in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#EngagementGroup": { "type": "resource", "identifiers": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementGroupArnOrIdentifier" } }, "list": { "target": "com.amazonaws.partnercentralselling#ListEngagementGroups" }, "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/engagement-group/{Identifier}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-group", "relativeDocumentation": "working-with-prospecting.html" }, "smithy.api#documentation": "Represents a curated engagement group that a partner can prospect against in AWS Partner Central.
" } }, "com.amazonaws.partnercentralselling#EngagementGroupArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an engagement group.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralselling#EngagementGroupArnOrIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "Specifies an engagement group. You can specify either of the following:
An engagement group identifier.
An engagement group ARN.
The description of the engagement group.
", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.partnercentralselling#EngagementGroupIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementGroupArnOrIdentifier" }, "traits": { "smithy.api#documentation": "A list of engagement group identifiers or ARNs.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#EngagementGroupName": { "type": "string", "traits": { "smithy.api#documentation": "The name of the engagement group.
", "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.partnercentralselling#EngagementGroupSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.partnercentralselling#EngagementGroupSortName", "traits": { "smithy.api#documentation": "The field to sort the results by.
", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The direction of the sort, either ascending or descending.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configures sorting of the engagement groups returned by ListEngagementGroups.
Sort by the number of engagements in the group.
", "smithy.api#enumValue": "Count" } }, "UPDATED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the date and time when the group was last updated.
", "smithy.api#enumValue": "UpdatedAt" } } }, "traits": { "smithy.api#documentation": "The engagement group fields that you can sort on in ListEngagementGroups.
A list of engagement group summaries.
" } }, "com.amazonaws.partnercentralselling#EngagementGroupSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralselling#GroupId", "traits": { "smithy.api#documentation": "The unique identifier of the engagement group. Pass this value to SearchEngagements as GroupId.
The Amazon Resource Name (ARN) of the engagement group.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "The catalog that the engagement group belongs to.
" } }, "Name": { "target": "com.amazonaws.partnercentralselling#EngagementGroupName", "traits": { "smithy.api#documentation": "The name of the engagement group.
" } }, "Description": { "target": "com.amazonaws.partnercentralselling#EngagementGroupDescription", "traits": { "smithy.api#documentation": "A description of the engagements that the group targets.
" } }, "Count": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of engagements in the group that are available to you.
" } }, "ReadinessLevel": { "target": "com.amazonaws.partnercentralselling#ReadinessLevel", "traits": { "smithy.api#documentation": "The readiness level of the engagement group, which indicates the recommended call to action for its leads.
" } }, "UpdatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the engagement group was last updated, in ISO 8601 format, in Coordinated Universal Time (UTC).
" } } }, "traits": { "smithy.api#documentation": "A summary of an engagement group: a curated set of engagements that share common characteristics.
" } }, "com.amazonaws.partnercentralselling#EngagementIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an engagement. An identifier starts with eng- followed by 14 lowercase letters or digits.
A list of engagement identifiers.
", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.partnercentralselling#EngagementIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier" }, "traits": { "smithy.api#documentation": "A list of engagement identifiers or Amazon Resource Names (ARNs).
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#EngagementInvitation": { "type": "resource", "identifiers": { "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier" }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#CreateEngagementInvitation" }, "read": { "target": "com.amazonaws.partnercentralselling#GetEngagementInvitation" }, "list": { "target": "com.amazonaws.partnercentralselling#ListEngagementInvitations" }, "operations": [ { "target": "com.amazonaws.partnercentralselling#AcceptEngagementInvitation" }, { "target": "com.amazonaws.partnercentralselling#RejectEngagementInvitation" } ], "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/engagement-invitation/{Identifier}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-invitation", "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents an Engagement Invitation that allows to join an Engagement on AWS Partner Central" } }, "com.amazonaws.partnercentralselling#EngagementInvitationArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an engagement invitation.
", "smithy.api#pattern": "^arn:aws:partnercentral::[0-9]{12}:[a-zA-Z]+/engagement-invitation/engi-[0-9,a-z]{13}$" } }, "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier": { "type": "string", "traits": { "aws.api#arnReference": { "resource": "com.amazon.partnerintegrationapi.operation#EngagementInvitation" }, "smithy.api#documentation": "The Amazon Resource Name (ARN) or the identifier of an engagement invitation. An identifier starts with engi- followed by 13 lowercase letters or digits.
The identifier of an engagement invitation. An identifier starts with engi- followed by 13 lowercase letters or digits.
A list of engagement invitation identifiers or Amazon Resource Names (ARNs).
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType": { "type": "enum", "members": { "OPPORTUNITY_INVITATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityInvitation" } }, "LEAD_INVITATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LeadInvitation" } }, "ACCOUNT_PLANNING_INVITATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccountPlanningInvitation" } } }, "traits": { "smithy.api#documentation": "The type of payload that an engagement invitation carries. Valid values are OpportunityInvitation, LeadInvitation, and AccountPlanningInvitation.
A list of summaries of engagement invitations.
" } }, "com.amazonaws.partnercentralselling#EngagementInvitationSummary": { "type": "structure", "members": { "Arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
" } }, "PayloadType": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType", "traits": { "smithy.api#documentation": "Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.
Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
", "smithy.api#required": {} } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
" } }, "EngagementTitle": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { "smithy.api#documentation": "Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#InvitationStatus", "traits": { "smithy.api#documentation": "Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.
Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
" } }, "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
" } }, "SenderAwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
" } }, "SenderCompanyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
", "smithy.api#pattern": "^(?s).{0,120}$" } }, "Receiver": { "target": "com.amazonaws.partnercentralselling#Receiver", "traits": { "smithy.api#documentation": "Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.
Identifies the role of the caller in the engagement invitation.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType" }, "traits": { "smithy.api#documentation": "A list of engagement invitation payload types.
" } }, "com.amazonaws.partnercentralselling#EngagementMember": { "type": "structure", "members": { "CompanyName": { "target": "com.amazonaws.partnercentralselling#MemberCompanyName", "traits": { "smithy.api#documentation": "The official name of the member's company or organization.
" } }, "WebsiteUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
" } }, "AccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#EngagementMemberSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementMemberSummary" }, "traits": { "smithy.api#documentation": "A list of summaries of engagement members.
" } }, "com.amazonaws.partnercentralselling#EngagementMemberSummary": { "type": "structure", "members": { "CompanyName": { "target": "com.amazonaws.partnercentralselling#MemberCompanyName", "traits": { "smithy.api#documentation": "The official name of the member's company or organization.
" } }, "WebsiteUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#EngagementMembers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementMember" }, "traits": { "smithy.api#documentation": "A list of engagement members.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.partnercentralselling#EngagementPageSize": { "type": "integer", "traits": { "smithy.api#default": 20, "smithy.api#documentation": "The maximum number of engagements that a single call returns. The default is 20. Valid values range from 1 to 100.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.partnercentralselling#EngagementProspectingResult": { "type": "structure", "members": { "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement that was processed.
", "smithy.api#required": {} } }, "EngagementContextId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.
The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.
A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.
Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task.
" } }, "com.amazonaws.partnercentralselling#EngagementProspectingResultList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementProspectingResult" }, "traits": { "smithy.api#documentation": "A list of engagements that contain prospecting results.
" } }, "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummary": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Indicates the environment in which the resource and engagement exist.
", "smithy.api#required": {} } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "A unique identifier for the engagement associated with the resource.
" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "Categorizes the type of resource associated with the engagement.
" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "A unique identifier for the specific resource. Varies depending on the resource type.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummary" }, "traits": { "smithy.api#documentation": "A list of summaries of resources that are associated with an engagement.
" } }, "com.amazonaws.partnercentralselling#EngagementScore": { "type": "enum", "members": { "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "High" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Medium" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Low" } } }, "traits": { "smithy.api#documentation": "A score that AWS assigns to show how likely an opportunity is to succeed. Valid values are High, Medium, and Low.
The level of engagement that the prospected customer has with AWS Marketplace. Valid values are High, Medium, and Low.
A list of sub-filters that are joined with a logical AND. The node matches only when every sub-filter matches.
" } }, "OrAllFilters": { "target": "com.amazonaws.partnercentralselling#EngagementSearchFilterList", "traits": { "smithy.api#documentation": "A list of sub-filters that are joined with a logical OR. The node matches when at least one sub-filter matches.
" } }, "NotFilter": { "target": "com.amazonaws.partnercentralselling#EngagementSearchFilter", "traits": { "smithy.api#documentation": "A single sub-filter that is negated. The node matches when the sub-filter does not match.
" } }, "EqualsTo": { "target": "com.amazonaws.partnercentralselling#EngagementSearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field equals the supplied StringValue.
A leaf condition that matches when the field contains any of the supplied values as a case-insensitive substring. Specify a single StringValue or a StringListValue. For a field that holds one value for each lead interaction, the condition matches when any of those values contains a supplied value. Supported on string fields only.
A leaf condition that matches when the field holds every supplied value exactly. Specify a single StringValue or a StringListValue. For a field that holds one value for each lead interaction, each supplied value must be present on at least one interaction. For a single-valued field, a list of more than one value returns no results. Supported on string fields only.
A leaf condition that matches when the field is greater than the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
" } }, "GreaterThanOrEquals": { "target": "com.amazonaws.partnercentralselling#EngagementSearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is greater than or equal to the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
" } }, "LessThan": { "target": "com.amazonaws.partnercentralselling#EngagementSearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is less than the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
" } }, "LessThanOrEquals": { "target": "com.amazonaws.partnercentralselling#EngagementSearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is less than or equal to the supplied value. This condition is supported only on ordered fields, such as date and numeric fields.
" } } }, "traits": { "smithy.api#documentation": "A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is limited to a depth of 3, and each combinator list can contain up to 10 entries.
A list of filter nodes combined by a boolean combinator.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#EngagementSearchFilterName": { "type": "enum", "members": { "ENGAGEMENT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the engagement id field.
", "smithy.api#enumValue": "EngagementId" } }, "TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the title field.
", "smithy.api#enumValue": "Title" } }, "PARTNER_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the partner id field.
", "smithy.api#enumValue": "PartnerId" } }, "CREATED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the created at field.
", "smithy.api#enumValue": "CreatedAt" } }, "LAST_MODIFIED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the last modified at field.
", "smithy.api#enumValue": "LastModifiedAt" } }, "MEMBER_COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the member count field.
", "smithy.api#enumValue": "MemberCount" } }, "PROSPECTING_CUSTOMER_GEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer geo field.
", "smithy.api#enumValue": "ProspectingCustomerGeo" } }, "PROSPECTING_CUSTOMER_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer region field.
", "smithy.api#enumValue": "ProspectingCustomerRegion" } }, "PROSPECTING_CUSTOMER_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer industry field.
", "smithy.api#enumValue": "ProspectingCustomerIndustry" } }, "PROSPECTING_CUSTOMER_SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer segment field.
", "smithy.api#enumValue": "ProspectingCustomerSegment" } }, "PROSPECTING_CUSTOMER_COUNTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer country field.
", "smithy.api#enumValue": "ProspectingCustomerCountry" } }, "PROSPECTING_CUSTOMER_COMPANY_SIZE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting customer company size field.
", "smithy.api#enumValue": "ProspectingCustomerCompanySize" } }, "PROSPECTING_INSIGHTS_MARKETPLACE_ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting insights marketplace engagement score field.
", "smithy.api#enumValue": "ProspectingInsightsMarketplaceEngagementScore" } }, "PROSPECTING_INSIGHTS_SOLUTION_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting insights solution category field.
", "smithy.api#enumValue": "ProspectingInsightsSolutionCategory" } }, "PROSPECTING_INSIGHTS_SOLUTION_SUB_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the prospecting insights solution sub category field.
", "smithy.api#enumValue": "ProspectingInsightsSolutionSubCategory" } }, "LEAD_QUALIFICATION_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead qualification status field.
", "smithy.api#enumValue": "LeadQualificationStatus" } }, "LEAD_READINESS_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead readiness score field.
", "smithy.api#enumValue": "LeadReadinessScore" } }, "LEAD_CUSTOMER_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead customer industry field.
", "smithy.api#enumValue": "LeadCustomerIndustry" } }, "LEAD_CUSTOMER_COUNTRY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead customer country code field.
", "smithy.api#enumValue": "LeadCustomerCountryCode" } }, "LEAD_CUSTOMER_AWS_MATURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead customer aws maturity field.
", "smithy.api#enumValue": "LeadCustomerAwsMaturity" } }, "LEAD_CUSTOMER_MARKET_SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead customer market segment field.
", "smithy.api#enumValue": "LeadCustomerMarketSegment" } }, "LEAD_INTERACTIONS_SOURCE_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions source type field.
", "smithy.api#enumValue": "LeadInteractionsSourceType" } }, "LEAD_CUSTOMER_COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead customer company name field.
", "smithy.api#enumValue": "LeadCustomerCompanyName" } }, "LEAD_INTERACTIONS_CONTACT_FIRST_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions contact first name field.
", "smithy.api#enumValue": "LeadInteractionsContactFirstName" } }, "LEAD_INTERACTIONS_CONTACT_LAST_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions contact last name field.
", "smithy.api#enumValue": "LeadInteractionsContactLastName" } }, "LEAD_INTERACTIONS_USECASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions usecase field.
", "smithy.api#enumValue": "LeadInteractionsUsecase" } }, "LEAD_INTERACTIONS_SOURCE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions source name field.
", "smithy.api#enumValue": "LeadInteractionsSourceName" } }, "LEAD_INTERACTIONS_CONTACT_BUSINESS_TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the lead interactions contact business title field.
", "smithy.api#enumValue": "LeadInteractionsContactBusinessTitle" } }, "CONTEXT_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter on the context type field.
", "smithy.api#enumValue": "ContextType" } } }, "traits": { "smithy.api#documentation": "The engagement fields that you can filter on in SearchEngagements.
A single string value, used by EqualsTo, ContainsAny, and ContainsAll.
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
An integral numeric value, used by the range comparisons on numeric fields.
" } }, "DateValue": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "A date-time value in RFC 3339 format, used by the range comparisons on date fields.
" } } }, "traits": { "smithy.api#documentation": "The value that a leaf condition compares against. Specify one of the following:
StringValue: A single string, used with EqualsTo, ContainsAny, and ContainsAll.
StringListValue: A list of strings, used with ContainsAny and ContainsAll.
DateValue: A date and time, used with range comparisons on date fields.
LongValue: A whole number, used with range comparisons on numeric fields.
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
A free-text search term matched against the engagement fields.
", "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#EngagementSearchPredicate": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.partnercentralselling#EngagementSearchFilterName", "traits": { "smithy.api#documentation": "The engagement field that the condition applies to.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralselling#EngagementSearchFilterValue", "traits": { "smithy.api#documentation": "The typed value the condition compares against.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A leaf condition in an EngagementSearchFilter tree. It specifies the field (Key) and the typed value (Value) to compare. The EngagementSearchFilter member that contains the condition specifies the comparison operator.
The field to sort the results by.
", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The direction of the sort, either ascending or descending.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configures sorting of the search results.
" } }, "com.amazonaws.partnercentralselling#EngagementSearchSortName": { "type": "enum", "members": { "ENGAGEMENT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the engagement id field.
", "smithy.api#enumValue": "EngagementId" } }, "TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the title field.
", "smithy.api#enumValue": "Title" } }, "PARTNER_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the partner id field.
", "smithy.api#enumValue": "PartnerId" } }, "CREATED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the created at field.
", "smithy.api#enumValue": "CreatedAt" } }, "LAST_MODIFIED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the last modified at field.
", "smithy.api#enumValue": "LastModifiedAt" } }, "MEMBER_COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the member count field.
", "smithy.api#enumValue": "MemberCount" } }, "PROSPECTING_CUSTOMER_GEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer geo field.
", "smithy.api#enumValue": "ProspectingCustomerGeo" } }, "PROSPECTING_CUSTOMER_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer region field.
", "smithy.api#enumValue": "ProspectingCustomerRegion" } }, "PROSPECTING_CUSTOMER_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer industry field.
", "smithy.api#enumValue": "ProspectingCustomerIndustry" } }, "PROSPECTING_CUSTOMER_SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer segment field.
", "smithy.api#enumValue": "ProspectingCustomerSegment" } }, "PROSPECTING_CUSTOMER_COUNTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer country field.
", "smithy.api#enumValue": "ProspectingCustomerCountry" } }, "PROSPECTING_CUSTOMER_COMPANY_SIZE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting customer company size field.
", "smithy.api#enumValue": "ProspectingCustomerCompanySize" } }, "PROSPECTING_INSIGHTS_MARKETPLACE_ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting insights marketplace engagement score field.
", "smithy.api#enumValue": "ProspectingInsightsMarketplaceEngagementScore" } }, "PROSPECTING_INSIGHTS_SOLUTION_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting insights solution category field.
", "smithy.api#enumValue": "ProspectingInsightsSolutionCategory" } }, "PROSPECTING_INSIGHTS_SOLUTION_SUB_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the prospecting insights solution sub category field.
", "smithy.api#enumValue": "ProspectingInsightsSolutionSubCategory" } }, "LEAD_QUALIFICATION_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead qualification status field.
", "smithy.api#enumValue": "LeadQualificationStatus" } }, "LEAD_READINESS_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead readiness score field.
", "smithy.api#enumValue": "LeadReadinessScore" } }, "LEAD_CUSTOMER_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead customer industry field.
", "smithy.api#enumValue": "LeadCustomerIndustry" } }, "LEAD_CUSTOMER_COUNTRY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead customer country code field.
", "smithy.api#enumValue": "LeadCustomerCountryCode" } }, "LEAD_CUSTOMER_AWS_MATURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead customer aws maturity field.
", "smithy.api#enumValue": "LeadCustomerAwsMaturity" } }, "LEAD_CUSTOMER_MARKET_SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead customer market segment field.
", "smithy.api#enumValue": "LeadCustomerMarketSegment" } }, "LEAD_CUSTOMER_COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead customer company name field.
", "smithy.api#enumValue": "LeadCustomerCompanyName" } }, "LEAD_INTERACTIONS_CONTACT_FIRST_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead interactions contact first name field.
", "smithy.api#enumValue": "LeadInteractionsContactFirstName" } }, "LEAD_INTERACTIONS_CONTACT_LAST_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead interactions contact last name field.
", "smithy.api#enumValue": "LeadInteractionsContactLastName" } }, "LEAD_INTERACTIONS_USECASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead interactions usecase field.
", "smithy.api#enumValue": "LeadInteractionsUsecase" } }, "LEAD_INTERACTIONS_CONTACT_BUSINESS_TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the lead interactions contact business title field.
", "smithy.api#enumValue": "LeadInteractionsContactBusinessTitle" } } }, "traits": { "smithy.api#documentation": "The engagement fields that you can sort on in SearchEngagements. Text and score fields sort in lexical (string) order.
A string value used in a filter condition.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#EngagementSearchSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique resource identifier of the engagement.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#EngagementArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the engagement.
" } }, "Title": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { "smithy.api#documentation": "The title of the engagement.
" } }, "Description": { "target": "com.amazonaws.partnercentralselling#EngagementDescription", "traits": { "smithy.api#documentation": "A description of the engagement.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the engagement was created, in ISO 8601 format, in Coordinated Universal Time (UTC).
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the user who created the engagement.
" } }, "MemberCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of members in the engagement.
" } }, "ModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the engagement was last modified, in ISO 8601 format, in Coordinated Universal Time (UTC).
" } }, "ModifiedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the user who last modified the engagement.
" } }, "Contexts": { "target": "com.amazonaws.partnercentralselling#EngagementContexts", "traits": { "smithy.api#documentation": "The contexts associated with the engagement, such as prospecting results, lead details, and customer project details.
" } } }, "traits": { "smithy.api#documentation": "A summary of an engagement returned by SearchEngagements. It contains the same engagement fields as the GetEngagement response.
A list of engagement search summaries.
" } }, "com.amazonaws.partnercentralselling#EngagementSort": { "type": "structure", "members": { "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The order in which to sort the results.
", "smithy.api#required": {} } }, "SortBy": { "target": "com.amazonaws.partnercentralselling#EngagementSortName", "traits": { "smithy.api#documentation": "The field by which to sort the results.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies the sorting parameters for listing Engagements.
" } }, "com.amazonaws.partnercentralselling#EngagementSortName": { "type": "enum", "members": { "CreatedDate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } } }, "traits": { "smithy.api#documentation": "The name of the field that sorts a list of engagements. The only valid value is CreatedDate.
The Amazon Resource Name (ARN) of the created Engagement.
" } }, "Id": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier for the Engagement.
" } }, "Title": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { "smithy.api#documentation": "The title of the Engagement.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the Engagement was created.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS Account ID of the Engagement creator.
" } }, "MemberCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of members in the Engagement.
" } }, "ModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\".
" } }, "ModifiedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
" } }, "ContextTypes": { "target": "com.amazonaws.partnercentralselling#EngagementContextTypeList", "traits": { "smithy.api#documentation": "An array of context types associated with the engagement, such as \"CustomerProject\" or \"Lead\". This provides a quick overview of the types of contexts included in the engagement.
" } } }, "traits": { "smithy.api#documentation": "An object that contains an Engagement's subset of fields.
A list of engagement summaries.
" } }, "com.amazonaws.partnercentralselling#EngagementTitle": { "type": "string", "traits": { "smithy.api#documentation": "The title of an engagement.
", "smithy.api#pattern": "^(?s).{0,40}$" } }, "com.amazonaws.partnercentralselling#EngagementUseCase": { "type": "string", "traits": { "smithy.api#documentation": "The use case that a lead interaction relates to.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#EnrichmentContext": { "type": "structure", "members": { "ProspectingResultAws": { "target": "com.amazonaws.partnercentralselling#InvitationProspectingResultAws", "traits": { "smithy.api#documentation": "The customer account data and propensity insights for the prospected account. It includes geographic, industry, and segment classifications, along with engagement and solution scoring.
" } }, "LeadInsights": { "target": "com.amazonaws.partnercentralselling#LeadInsights", "traits": { "smithy.api#documentation": "The AI-generated lead readiness score for this lead. Use this score to assess lead quality and prioritize engagement efforts.
" } } }, "traits": { "smithy.api#documentation": "Contains enrichment data for engagement invitations. You can view propensity scores, program eligibility, and lead readiness insights directly in the invitation, before you take action on the invitation.
" } }, "com.amazonaws.partnercentralselling#EnrichmentStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "AWS is matching the customer account to a customer.
", "smithy.api#enumValue": "PENDING" } }, "ENRICHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "AWS matched the customer account to a customer and added enrichment information.
", "smithy.api#enumValue": "ENRICHED" } }, "NO_MATCH_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "AWS couldn't match the customer account to a customer.
", "smithy.api#enumValue": "NO_MATCH_FOUND" } }, "ACTION_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The customer account needs your action. See ReasonCode and Message for details.
The enrichment status of a customer account.
" } }, "com.amazonaws.partnercentralselling#EnrichmentValue": { "type": "string", "traits": { "smithy.api#documentation": "Information about enrichment value.
" } }, "com.amazonaws.partnercentralselling#EstimationUrl": { "type": "string", "traits": { "smithy.api#documentation": "A URL that points to an estimate in the AWS Pricing Calculator.
", "smithy.api#pattern": "^https://(calculator\\.aws|pricing\\.calculator\\.aws\\.eu)/#/estimate\\?id=[a-f0-9]{32,64}$" } }, "com.amazonaws.partnercentralselling#ExpectedContractDuration": { "type": "structure", "members": { "Term": { "target": "com.amazonaws.partnercentralselling#ExpectedContractDurationTerm", "traits": { "smithy.api#documentation": "The unit of measurement for the contract duration value. Currently accepts only Months.
A String representation of the contract duration as an integer, expressed in the unit defined by Term. Valid values range from 1 to 144.
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.
" } }, "com.amazonaws.partnercentralselling#ExpectedContractDurationTerm": { "type": "enum", "members": { "MONTHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Months" } } }, "traits": { "smithy.api#documentation": "The unit of measurement for the contract duration value. Currently accepts only Months.
Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
" } }, "CurrencyCode": { "target": "com.amazonaws.partnercentralselling#CurrencyCode", "traits": { "smithy.api#documentation": "Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Indicates how frequently the customer is expected to spend the projected amount. Use Monthly for recurring monthly spend (required for TargetCompany: \"AWS\" entries). Use None for one-time deal value entries (required for TargetCompany: \"Self\" entries when providing Total Contract Value).
Specifies the entity associated with this spend entry. Use AWS for the system\u2019s AWS Monthly Recurring Revenue (MRR) estimate. Use Self for the partner\u2019s own deal value entry when providing Total Contract Value (TCV) for automatic MRR conversion. When ExpectedContractDuration is present on the Project, only AWS and Self are accepted. When ExpectedContractDuration is not present, only AWS is accepted and any other value will be automatically set to AWS.
A URL providing additional information or context about the spend estimation.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpend" }, "traits": { "smithy.api#documentation": "A list of the amounts that you expect the customer to spend on the project.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.partnercentralselling#FileName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a file.
", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.partnercentralselling#FileUri": { "type": "string", "traits": { "smithy.api#documentation": "URI pointing to the input file (S3 or HTTPS).", "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#pattern": "^(s3://|https://).*$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#Filter": { "type": "structure", "members": { "AndAllFilters": { "target": "com.amazonaws.partnercentralselling#FilterList", "traits": { "smithy.api#documentation": "A list of child filters joined with a logical AND. The node matches only when every child filter matches.
" } }, "OrAllFilters": { "target": "com.amazonaws.partnercentralselling#FilterList", "traits": { "smithy.api#documentation": "A list of child filters joined with a logical OR. The node matches when at least one child filter matches.
" } }, "NotFilter": { "target": "com.amazonaws.partnercentralselling#Filter", "traits": { "smithy.api#documentation": "A single child filter that is negated. The node matches when the child filter doesn't match.
" } }, "EqualsTo": { "target": "com.amazonaws.partnercentralselling#FilterCondition", "traits": { "smithy.api#documentation": "A condition that matches when the field equals the supplied StringValue.
A condition that matches when the field matches any of the values in the supplied StringListValue.
A condition that matches when the field contains every value in the supplied StringListValue. Supported on fields that hold more than one value.
A condition that matches when the date field is later than the supplied DateValue.
A condition that matches when the date field is the same as or later than the supplied DateValue.
A condition that matches when the date field is earlier than the supplied DateValue.
A condition that matches when the date field is the same as or earlier than the supplied DateValue.
A filter node. Specify exactly one member. AndAllFilters, OrAllFilters, and NotFilter combine child filters. The other members compare a single field to a value. Each combinator list can contain up to 10 filters.
The field that the condition applies to.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralselling#FilterValue", "traits": { "smithy.api#documentation": "The value that the condition compares the field against.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A single comparison in a filter. It names the field to compare and the value to compare it against.
" } }, "com.amazonaws.partnercentralselling#FilterIdentifier": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier" } }, "com.amazonaws.partnercentralselling#FilterLifeCycleReviewStatus": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ReviewStatus" } }, "com.amazonaws.partnercentralselling#FilterLifeCycleStage": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Stage" } }, "com.amazonaws.partnercentralselling#FilterList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Filter" }, "traits": { "smithy.api#documentation": "Information about filter list.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#FilterStatus": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#SolutionStatus" } }, "com.amazonaws.partnercentralselling#FilterValue": { "type": "union", "members": { "StringValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A single string value, used by EqualsTo.
A list of 1 to 20 string values, used by ContainsAny and ContainsAll.
Reserved for future use.
" } }, "DateValue": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "A date and time value, used by the range comparisons on date fields.
" } } }, "traits": { "smithy.api#documentation": "Specifies the value that a filter compares a field against. This structure holds a single comparison value. Set the member that matches the type of the field you're filtering on.
" } }, "com.amazonaws.partnercentralselling#FilterableField": { "type": "enum", "members": { "ENRICHMENT_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the enrichment status of the customer account.
", "smithy.api#enumValue": "ENRICHMENT_STATUS" } }, "COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the customer company name.
", "smithy.api#enumValue": "COMPANY_NAME" } }, "AWS_INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the industry of the customer, as classified by AWS.
", "smithy.api#enumValue": "AWS_INDUSTRY" } }, "ACCOUNT_PLANNING_QUALIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by whether the customer qualifies for account planning.
", "smithy.api#enumValue": "ACCOUNT_PLANNING_QUALIFICATION" } }, "PROGRAM_ELIGIBILITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the AWS programs that the customer is eligible for.
", "smithy.api#enumValue": "PROGRAM_ELIGIBILITY" } }, "IMPORT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the import that created the customer account.
", "smithy.api#enumValue": "IMPORT_ID" } }, "CREATED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the date when the customer account was created.
", "smithy.api#enumValue": "CREATED_DATE" } }, "LAST_MODIFIED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the date when the customer account was last modified.
", "smithy.api#enumValue": "LAST_MODIFIED_DATE" } }, "GEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the geographic area of the customer.
", "smithy.api#enumValue": "GEO" } }, "COUNTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the country of the customer.
", "smithy.api#enumValue": "COUNTRY" } }, "SEGMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the market segment of the customer.
", "smithy.api#enumValue": "SEGMENT" } }, "SOLUTION_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the category of the recommended solution.
", "smithy.api#enumValue": "SOLUTION_CATEGORY" } }, "MARKETPLACE_ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the AWS Marketplace engagement score of the customer.
", "smithy.api#enumValue": "MARKETPLACE_ENGAGEMENT_SCORE" } }, "SOLUTION_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Filter by the score of the recommended solution.
", "smithy.api#enumValue": "SOLUTION_SCORE" } } }, "traits": { "smithy.api#documentation": "The fields that you can filter customer accounts on.
" } }, "com.amazonaws.partnercentralselling#GetAwsOpportunitySummary": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to retrieve AWS Opportunity Summaries for Opportunities on AWS Partner Central" }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/GetAwsOpportunitySummary", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.
The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the GetAwsOpportunitySummary operation.
Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.
" } }, "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { "smithy.api#documentation": "Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.
" } }, "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { "smithy.api#documentation": "Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.
" } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { "smithy.api#documentation": "Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.
Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.
" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList", "traits": { "smithy.api#documentation": "Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityInsights", "traits": { "smithy.api#documentation": "Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.
" } }, "InvolvementTypeChangeReason": { "target": "com.amazonaws.partnercentralselling#InvolvementTypeChangeReason", "traits": { "smithy.api#documentation": "Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.
Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityCustomer", "traits": { "smithy.api#documentation": "Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityProject", "traits": { "smithy.api#documentation": "Provides details about the project associated with the AWS Opportunity, including the customer\u2019s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.
" } }, "CosellMotion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Engagement classification for this opportunity. Read-only. Null before scoring. Known values: AWS Field-engaged, Agent-engaged, Partner-led.
The plain-language reason for the current CosellMotion value. Read-only. Null when CosellMotion is null.
Seller-provided PARC deal terms: commitment value, discount, and contract dates.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.
Contains the response that the GetAwsOpportunitySummary action returns.
Use GetCustomerAccount to retrieve the details of a customer account, including the customer information that you provided, the enrichment status, and the enrichment information that AWS provides when the status is ENRICHED.
Use GetCustomerAccountBulkJob to retrieve the status and record counts of a bulk job.
Use GetCustomerAccountBulkJobReportUrl to get a temporary URL for downloading the report of a bulk job, such as the list of records that failed. A report is available only after the job is COMPLETED or FAILED. For a job that is still running, the request fails with a ConflictException.
The report is generated on request. If ReportStatus is not AVAILABLE, call the operation again later.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the bulk job.
", "smithy.api#required": {} } }, "ReportType": { "target": "com.amazonaws.partnercentralselling#BulkReportType", "traits": { "smithy.api#documentation": "Specifies which records the report covers. If you omit this field, the report covers the records that failed.
" } } }, "traits": { "smithy.api#documentation": "Information about get customer account bulk job report url request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountBulkJobReportUrlResponse": { "type": "structure", "members": { "ReportStatus": { "target": "com.amazonaws.partnercentralselling#BulkReportStatus", "traits": { "smithy.api#documentation": "The status of the report. The Url is returned only when the status is AVAILABLE.
The records that the report covers.
", "smithy.api#required": {} } }, "Url": { "target": "com.amazonaws.partnercentralselling#BulkReportUrl", "traits": { "smithy.api#documentation": "A temporary URL for downloading the report. Present only when ReportStatus is AVAILABLE.
The date and time when the URL expires. Present only when ReportStatus is AVAILABLE.
The reason that the report couldn't be generated. Present only when ReportStatus is FAILED.
Information about get customer account bulk job report url response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountBulkJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the bulk job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about get customer account bulk job request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountBulkJobResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#BulkJobArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bulk job.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#JobId", "traits": { "smithy.api#documentation": "The unique identifier of the bulk job.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "The current status of the bulk job.
", "smithy.api#required": {} } }, "FileName": { "target": "com.amazonaws.partnercentralselling#FileName", "traits": { "smithy.api#documentation": "The name of the file that the job processes.
" } }, "TotalRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of records in the file. The value is 0 until the job reads the file.
", "smithy.api#required": {} } }, "ProcessedRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that the job has finished processing.
", "smithy.api#required": {} } }, "SuccessCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that the job processed successfully.
", "smithy.api#required": {} } }, "FailureCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that failed.
", "smithy.api#required": {} } }, "DeletedCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of accounts imported by this job that have since been deleted. This counter only increases, so the accounts still present equal SuccessCount minus DeletedCount.
The reason that the job failed. Present only when the job status is FAILED.
The date and time when the bulk job was created.
", "smithy.api#required": {} } }, "CompletedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the job finished. Absent while the job is running.
" } } }, "traits": { "smithy.api#documentation": "Information about get customer account bulk job response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the customer account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about get customer account request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer account.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#CustomerAccountId", "traits": { "smithy.api#documentation": "The unique identifier of the customer account.
", "smithy.api#required": {} } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "The catalog that the customer account belongs to.
", "smithy.api#required": {} } }, "EnrichmentStatus": { "target": "com.amazonaws.partnercentralselling#EnrichmentStatus", "traits": { "smithy.api#documentation": "The enrichment status of the customer account.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Your own identifier for the customer account, if you provided one.
" } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was created.
", "smithy.api#required": {} } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was last modified.
", "smithy.api#required": {} } }, "Issues": { "target": "com.amazonaws.partnercentralselling#IssueList", "traits": { "smithy.api#documentation": "The issues found with the customer account. Present only when there is at least one issue.
" } }, "AwsEnrichment": { "target": "com.amazonaws.partnercentralselling#AwsEnrichment", "traits": { "smithy.api#documentation": "Enrichment information that AWS provides about the customer. Present only when EnrichmentStatus is ENRICHED.
The reason that the customer account needs your action. Present only when EnrichmentStatus is ACTION_REQUIRED.
A description of the problem and the steps that you can take to resolve it.
" } }, "ExistingCustomerAccountArn": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArn", "traits": { "smithy.api#documentation": "The ARN of the customer account that already maps this customer. Present only when ReasonCode is DUPLICATE_CUSTOMER_MATCH.
The details of the customer that you provided.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "The tags on the customer account. This member is absent if the tags can't be retrieved, which is different from an account that has no tags.
" } } }, "traits": { "smithy.api#documentation": "Information about get customer account response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountStatistics": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#GetCustomerAccountStatisticsRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#GetCustomerAccountStatisticsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "smithy.api#documentation": "Use GetCustomerAccountStatistics to count your customer accounts and group them by fields such as industry, geography, or enrichment status. You can use the same filters as SearchCustomerAccounts.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies a filter tree that narrows the customer accounts. Each node either combines child filters or compares a single field to a value. If you omit this field, the statistics cover all of your customer accounts.
" } }, "Aggregations": { "target": "com.amazonaws.partnercentralselling#AggregationRequestList", "traits": { "smithy.api#documentation": "Specifies how to group the customer accounts. Each aggregation returns the number of accounts for each value of a field.
" } }, "IncludeMissing": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to include a group for customer accounts that have no value for the grouped field.
" } } }, "traits": { "smithy.api#documentation": "Information about get customer account statistics request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetCustomerAccountStatisticsResponse": { "type": "structure", "members": { "TotalCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of customer accounts that match the filter.
", "smithy.api#required": {} } }, "Aggregations": { "target": "com.amazonaws.partnercentralselling#AggregationResultList", "traits": { "smithy.api#documentation": "The results of the aggregations, in the order that you requested them.
" } } }, "traits": { "smithy.api#documentation": "Information about get customer account statistics response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#GetEngagement": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#GetEngagementRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#GetEngagementResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to retrieval of engagement details in AWS Partner Central" }, "smithy.api#documentation": "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\u2019s Payload.Project.Title with opportunity Project.Title.
Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.
Specifies the unique identifier for the retrieved engagement invitation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the GetEngagementInvitation operation.
The Amazon Resource Name (ARN) that identifies the engagement invitation.
" } }, "PayloadType": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType", "traits": { "smithy.api#documentation": "The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
" } }, "Id": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { "smithy.api#documentation": "Unique identifier assigned to the engagement invitation being retrieved.
", "smithy.api#required": {} } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.
" } }, "EngagementTitle": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { "smithy.api#documentation": "The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#InvitationStatus", "traits": { "smithy.api#documentation": "The current status of the engagement invitation.
" } }, "InvitationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date when the engagement invitation was sent to the partner.
" } }, "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Indicates the date on which the engagement invitation will expire if not accepted by the partner.
" } }, "SenderAwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.
" } }, "SenderCompanyName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the AWS organization or team that sent the engagement invitation.
", "smithy.api#pattern": "^(?s).{0,120}$" } }, "Receiver": { "target": "com.amazonaws.partnercentralselling#Receiver", "traits": { "smithy.api#documentation": "Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.
If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
" } }, "Payload": { "target": "com.amazonaws.partnercentralselling#Payload", "traits": { "smithy.api#documentation": "Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
" } }, "InvitationMessage": { "target": "com.amazonaws.partnercentralselling#InvitationMessage", "traits": { "smithy.api#documentation": "The message sent to the invited partner when the invitation was created.
" } }, "EngagementDescription": { "target": "com.amazonaws.partnercentralselling#EngagementDescription", "traits": { "smithy.api#documentation": "The description of the engagement associated with this invitation.
" } }, "ExistingMembers": { "target": "com.amazonaws.partnercentralselling#EngagementMemberSummaries", "traits": { "smithy.api#documentation": "A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.
CompanyName: The name of the member's company.
WebsiteUrl: The website URL of the member's company.
The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetEngagementInvitation action returns.
Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.
Specifies the identifier of the Engagement record to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the GetEngagement operation.
The unique resource identifier of the engagement retrieved.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#EngagementArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the engagement retrieved.
" } }, "Title": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { "smithy.api#documentation": "The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
" } }, "Description": { "target": "com.amazonaws.partnercentralselling#EngagementDescription", "traits": { "smithy.api#documentation": "A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the Engagement.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
" } }, "MemberCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
" } }, "ModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\". This helps track the most recent changes to the engagement.
" } }, "ModifiedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.
" } }, "Contexts": { "target": "com.amazonaws.partnercentralselling#EngagementContexts", "traits": { "smithy.api#documentation": "A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetEngagement action returns.
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.
Gets the status of the failed-records report for a finished opportunity bulk job and, when the report is ready, a temporary URL to download it.
A report is available only after the job is COMPLETED or FAILED. The URL expires after 15 minutes, and the report expires after about 7 days.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the identifier of the bulk job.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } }, "ReportFormat": { "target": "com.amazonaws.partnercentralselling#BulkFileFormat", "traits": { "smithy.api#documentation": "Specifies the format of the report. The only supported value is CSV.
Specifies which records the report covers. If you omit this field, the report covers the records that failed. ALL_RECORDS isn't supported yet, and a request for it fails with a ValidationException.
Specifies the catalog, job identifier, and report format for getting the report URL of an opportunity bulk job.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetOpportunityBulkJobReportUrlResponse": { "type": "structure", "members": { "ReportStatus": { "target": "com.amazonaws.partnercentralselling#BulkReportStatus", "traits": { "smithy.api#documentation": "The status of the report. The Url is returned only when the status is AVAILABLE.
The records that the report covers.
", "smithy.api#required": {} } }, "ReportFormat": { "target": "com.amazonaws.partnercentralselling#BulkFileFormat", "traits": { "smithy.api#documentation": "The format of the report.
", "smithy.api#required": {} } }, "Url": { "target": "com.amazonaws.partnercentralselling#BulkReportUrl", "traits": { "smithy.api#documentation": "A temporary URL for downloading the report. Present only when ReportStatus is AVAILABLE.
The date and time, in UTC, when the URL expires. Present only when ReportStatus is AVAILABLE.
The reason that Partner Central couldn't generate the report. Present only when ReportStatus is FAILED.
The status of the report and, when it is ready, the URL to download it.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#GetOpportunityRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.
Read-only, system generated Opportunity unique identifier.
Contains the request parameters for the GetOpportunity operation.
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.
Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.
Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.
Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.
Cosell\u2014Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
Cosell\u2014Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.
Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.
Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.
Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.
", "smithy.api#pattern": "^(?s).{0,64}$" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { "smithy.api#documentation": "Specifies details of the customer associated with the Opportunity.
An object that contains project details summary for the Opportunity.
Specifies the opportunity type as renewal, new, or expansion.
Opportunity types:
New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, which helps to ensure service continuity.
Expansion opportunity: Represents an opportunity to expand the scope of a customer's contract or subscription, either by adding new services or increasing the volume of existing services.
An object that contains marketing details for the Opportunity.
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
" } }, "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "Read-only, system generated Opportunity unique identifier.
The Amazon Resource Name (ARN) that uniquely identifies the opportunity.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": " DateTime when the opportunity was last modified.
DateTime when the Opportunity was last created.
Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.
An object that contains lifecycle details for the Opportunity.
Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetOpportunity action returns.
Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.
Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.
The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.
Represents the request structure for retrieving the status and results of a prospecting task.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#GetProspectingFromEngagementTaskResponse": { "type": "structure", "members": { "TaskId": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the task.
", "smithy.api#required": {} } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
", "smithy.api#required": {} } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskName", "traits": { "smithy.api#documentation": "The descriptive name of the task that you provided when you created it.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.
" } }, "Engagements": { "target": "com.amazonaws.partnercentralselling#EngagementProspectingResultList", "traits": { "smithy.api#documentation": "An array of EngagementProspectingResult entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message.
Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the Status field of each EngagementProspectingResult entry to determine individual outcomes.
Use this action to retrieve a specific snapshot record.
", "smithy.api#http": { "method": "POST", "uri": "/GetResourceSnapshot", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#GetResourceSnapshotJob": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#GetResourceSnapshotJobRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#GetResourceSnapshotJobResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to retrieving resource snapshot job details in AWS Partner Central" }, "smithy.api#documentation": "Use this action to retrieves information about a specific resource snapshot job.
", "smithy.api#http": { "method": "POST", "uri": "/GetResourceSnapshotJob", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#GetResourceSnapshotJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the snapshot job from the production AWS environment.
Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes.
The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the GetResourceSnapshotJob operation.
The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.
" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "The type of resource being snapshotted. This would have \"Opportunity\" as a value as it is dependent on the supported resource type.
" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
" } }, "ResourceArn": { "target": "com.amazonaws.partnercentralselling#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
" } }, "ResourceSnapshotTemplateName": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { "smithy.api#documentation": "The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { "smithy.api#documentation": "The current status of the snapshot job. Valid values:
STOPPED: The job is not currently running.
RUNNING: The job is actively executing.
The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"
" } }, "LastFailure": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetResourceSnapshotJob action returns.
Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the snapshot from the production AWS environment.
Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.
The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.
The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID
he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.
Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the GetResourceSnapshot operation.
The catalog in which the snapshot was created. Matches the Catalog specified in the request.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.
" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp when the snapshot was created, in ISO 8601 format (e.g., \"2023-06-01T14:30:00Z\"). This allows for precise tracking of when the snapshot was taken.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.
" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "The type of the resource that was snapshotted. Matches the ResourceType specified in the request.
" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.
" } }, "ResourceSnapshotTemplateName": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { "smithy.api#documentation": "The name of the view used for this snapshot. This is the same as the template name.
" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { "smithy.api#documentation": "The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.
" } }, "Payload": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotPayload", "traits": { "smithy.api#documentation": "Contains the data of the resource snapshot. The structure of this payload depends on the resource type and the snapshot template.
" } }, "TargetMemberAccounts": { "target": "com.amazonaws.partnercentralselling#AwsAccountIdOrAliasList", "traits": { "smithy.api#documentation": "Target member accounts associated with the resource snapshot.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetResourceSnapshot action returns.
Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.
", "smithy.api#http": { "method": "POST", "uri": "/GetSellingSystemSettings", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#GetSellingSystemSettingsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
Contains the request parameters for the GetSellingSystemSettings operation.
Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
Specifies the ARN of the IAM Role used for resource snapshot job executions.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the GetSellingSystemSettings action returns.
The unique identifier of an engagement group.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^eng-grp-[0-9a-z]{14}$" } }, "com.amazonaws.partnercentralselling#Industry": { "type": "enum", "members": { "AEROSPACE_SATELLITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Aerospace" } }, "AGRICULTURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Agriculture" } }, "AUTOMOTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Automotive" } }, "COMPUTERS_ELECTRONICS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Computers and Electronics" } }, "CONSUMER_GOODS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Consumer Goods" } }, "EDUCATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Education" } }, "ENERGY_OIL_GAS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Energy - Oil and Gas" } }, "ENERGY_POWER_UTILITIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Energy - Power and Utilities" } }, "FINANCIAL_SERVICES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Financial Services" } }, "GAMING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gaming" } }, "GOVERNMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Government" } }, "HEALTHCARE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Healthcare" } }, "HOSPITALITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hospitality" } }, "LIFE_SCIENCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Life Sciences" } }, "MANUFACTURING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Manufacturing" } }, "MARKETING_ADVERTISING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Marketing and Advertising" } }, "MEDIA_ENTERTAINMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Media and Entertainment" } }, "MINING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Mining" } }, "NON_PROFIT_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Non-Profit Organization" } }, "PROFESSIONAL_SERVICES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Professional Services" } }, "REALESTATE_CONSTRUCTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Real Estate and Construction" } }, "RETAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Retail" } }, "SOFTWARE_INTERNET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Software and Internet" } }, "TELECOMMUNICATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Telecommunications" } }, "TRANSPORTATION_LOGISTICS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Transportation and Logistics" } }, "TRAVEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Travel" } }, "WHOLESALE_DISTRIBUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Wholesale and Distribution" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Other" } } }, "traits": { "smithy.api#documentation": "The industry that a company belongs to.
" } }, "com.amazonaws.partnercentralselling#InternalServerException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the internal error.
" } } }, "traits": { "smithy.api#documentation": "This error occurs when the specified resource can\u2019t 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.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.partnercentralselling#Invitation": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.partnercentralselling#InvitationMessage", "traits": { "smithy.api#documentation": "A message accompanying the invitation.
", "smithy.api#required": {} } }, "Receiver": { "target": "com.amazonaws.partnercentralselling#Receiver", "traits": { "smithy.api#documentation": "Specifies the partner that receives the invitation.
", "smithy.api#required": {} } }, "Payload": { "target": "com.amazonaws.partnercentralselling#Payload", "traits": { "smithy.api#documentation": "Contains the details that the invitation carries, such as the opportunity or the account planning details that the partner receives.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#InvitationMessage": { "type": "string", "traits": { "smithy.api#documentation": "A message that the sender includes with an engagement invitation.
", "smithy.api#pattern": "^(?s).{1,255}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#InvitationProspectingResultAws": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#ProspectingResultCustomer", "traits": { "smithy.api#documentation": "The prospected customer account details, including geographic classification, industry segmentation, company size, and program eligibility.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#ProspectingInsights", "traits": { "smithy.api#documentation": "The AI-generated insights from the prospecting analysis, including marketplace engagement scoring, solution fit assessments, and solution categorization.
" } } }, "traits": { "smithy.api#documentation": "A subset of prospecting result data visible to invitation receivers. It includes customer account details and AI-generated insights.
" } }, "com.amazonaws.partnercentralselling#InvitationStatus": { "type": "enum", "members": { "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } } }, "traits": { "smithy.api#documentation": "The status of an engagement invitation. PENDING means the receiver hasn't responded yet. ACCEPTED and REJECTED mean the receiver accepted or rejected the invitation. EXPIRED means the invitation expired before the receiver responded.
A list of engagement invitation statuses.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#InvolvementTypeChangeReason": { "type": "enum", "members": { "EXPANSION_OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Expansion Opportunity" } }, "CHANGE_IN_DEAL_INFORMATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Change in Deal Information" } }, "CUSTOMER_REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer Requested" } }, "TECHNICAL_COMPLEXITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Technical Complexity" } }, "RISK_MITIGATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Risk Mitigation" } } }, "traits": { "smithy.api#documentation": "The reason that the AWS involvement type of an opportunity changed.
" } }, "com.amazonaws.partnercentralselling#Issue": { "type": "structure", "members": { "Severity": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The severity of the issue.
" } }, "Code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A code that identifies the type of issue.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the issue.
" } } }, "traits": { "smithy.api#documentation": "An issue found with a customer account. It includes the severity, a machine-readable code, and a description.
" } }, "com.amazonaws.partnercentralselling#IssueList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Issue" }, "traits": { "smithy.api#documentation": "A list of issues that were found when the service processed a record.
" } }, "com.amazonaws.partnercentralselling#JobId": { "type": "string", "traits": { "smithy.api#documentation": "Information about job id.
", "smithy.api#pattern": "^bulkjob-[0-9a-z]{13}$" } }, "com.amazonaws.partnercentralselling#JobTitle": { "type": "string", "traits": { "smithy.api#documentation": "The business title of a person.
", "smithy.api#pattern": "^(?s).{0,80}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LastModifiedDate": { "type": "structure", "members": { "AfterLastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Specifies the date after which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified after a given timestamp.
" } }, "BeforeLastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Specifies the date before which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified before a given timestamp.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadAddress": { "type": "structure", "members": { "City": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The city of the lead customer's address.
", "smithy.api#length": { "max": 255 } } }, "PostalCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The postal code of the lead customer's address.
", "smithy.api#length": { "max": 20 } } }, "StateOrRegion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The state or region of the lead customer's address.
", "smithy.api#length": { "max": 255 } } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#LeadCountryCode", "traits": { "smithy.api#documentation": "The country code of the lead customer's address.
" } } }, "traits": { "smithy.api#documentation": "The address information for a lead customer, including city, state or region, postal code, and country code.
" } }, "com.amazonaws.partnercentralselling#LeadBusinessProblem": { "type": "string", "traits": { "smithy.api#documentation": "A description of the business problem that the lead wants to solve.
", "smithy.api#length": { "max": 2000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadContact": { "type": "structure", "members": { "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#LeadJobTitle", "traits": { "smithy.api#documentation": "The lead contact's business title or job role associated with the engagement.
", "smithy.api#required": {} } }, "Email": { "target": "com.amazonaws.partnercentralselling#LeadEmail", "traits": { "smithy.api#documentation": "The lead contact's email address associated with the engagement.
", "smithy.api#required": {} } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "The lead contact's first name associated with the engagement.
", "smithy.api#required": {} } }, "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { "smithy.api#documentation": "The lead contact's last name associated with the engagement.
", "smithy.api#required": {} } }, "Phone": { "target": "com.amazonaws.partnercentralselling#LeadPhoneNumber", "traits": { "smithy.api#documentation": "The lead contact's phone number associated with the engagement.
" } } }, "traits": { "smithy.api#documentation": "An object that contains a lead contact's details associated with the engagement. This provides contact information for individuals involved in lead-related activities.
" } }, "com.amazonaws.partnercentralselling#LeadContext": { "type": "structure", "members": { "Insights": { "target": "com.amazonaws.partnercentralselling#LeadInsights", "traits": { "smithy.api#documentation": "Insights that AI generates and associates with the lead. These insights provide automated analysis such as lead readiness scoring to help partners assess the lead quality.
" } }, "QualificationStatus": { "target": "com.amazonaws.partnercentralselling#LeadQualificationStatus", "traits": { "smithy.api#default": "Unqualified", "smithy.api#documentation": "Indicates the current qualification status of the lead, such as whether it has been qualified, disqualified, or is still under evaluation. This helps track the lead's progression through the qualification process.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#LeadCustomer", "traits": { "smithy.api#documentation": "Contains detailed information about the customer associated with the lead, including company information, contact details, and other relevant customer data.
", "smithy.api#required": {} } }, "Interactions": { "target": "com.amazonaws.partnercentralselling#LeadInteractionList", "traits": { "smithy.api#documentation": "An array of interactions that have occurred with the lead, providing a history of communications, meetings, and other engagement activities related to the lead.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadCountryCode": { "type": "string", "traits": { "smithy.api#documentation": "The country code of a lead's address.
", "smithy.api#length": { "max": 10 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadCustomer": { "type": "structure", "members": { "Industry": { "target": "com.amazonaws.partnercentralselling#LeadIndustry", "traits": { "smithy.api#documentation": "Specifies the industry sector to which the lead customer's company belongs. This categorization helps in understanding the customer's business context and tailoring appropriate solutions.
" } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { "smithy.api#documentation": "The name of the lead customer's company. This field is essential for identifying and tracking the customer organization associated with the lead.
", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#LeadWebsiteUrl", "traits": { "smithy.api#documentation": "The website URL of the lead customer's company. This provides additional context about the customer organization and helps verify company legitimacy and size.
" } }, "Address": { "target": "com.amazonaws.partnercentralselling#LeadAddress", "traits": { "smithy.api#documentation": "The address information for the lead customer.
" } }, "AwsMaturity": { "target": "com.amazonaws.partnercentralselling#AwsMaturity", "traits": { "smithy.api#documentation": "Indicates the customer's level of experience and adoption with AWS services. This assessment helps determine the appropriate engagement approach and solution complexity.
" } }, "MarketSegment": { "target": "com.amazonaws.partnercentralselling#LeadMarketSegment", "traits": { "smithy.api#documentation": "Specifies the market segment classification of the lead customer, such as enterprise, mid-market, or small business. This segmentation helps in targeting appropriate solutions and engagement strategies.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadEmail": { "type": "string", "traits": { "smithy.api#documentation": "The email address of a lead contact.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadIndustry": { "type": "string", "traits": { "smithy.api#documentation": "The industry that a lead's company belongs to.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#LeadInsights": { "type": "structure", "members": { "LeadReadinessScore": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A score that indicates the lead's readiness for engagement. Valid values are Low, Medium, and High. Use this score to prioritize leads based on their likelihood of conversion.
The outreach channel most commonly recommended for leads that share this lead's country, geography, region, and company segment. It includes the days and the Coordinated Universal Time (UTC) hours when that channel is best used. This is guidance for the group of similar leads. It doesn't describe this lead's own contact history. Present only when a recommendation is available for the lead.
" } } }, "traits": { "smithy.api#documentation": "Contains insights that AI generates for a lead. These insights provide automated analysis to help partners evaluate the lead quality and prioritize engagement efforts.
" } }, "com.amazonaws.partnercentralselling#LeadInteraction": { "type": "structure", "members": { "SourceType": { "target": "com.amazonaws.partnercentralselling#LeadSourceType", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "Specifies the type of source that generated the lead interaction, such as \"Event\", \"Website\", \"Referral\", or \"Campaign\". This categorization helps track lead generation effectiveness across different channels.
" } }, "SourceId": { "target": "com.amazonaws.partnercentralselling#LeadSourceId", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The unique identifier of the specific source that generated the lead interaction. This ID provides traceability back to the original lead generation activity.
" } }, "SourceName": { "target": "com.amazonaws.partnercentralselling#LeadSourceName", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The descriptive name of the source that generated the lead interaction, providing a human-readable identifier for the lead generation channel or activity.
" } }, "Usecase": { "target": "com.amazonaws.partnercentralselling#EngagementUseCase", "traits": { "smithy.api#documentation": "Describes the specific use case or business scenario discussed during the lead interaction. This helps categorize the customer's interests and potential solutions.
" } }, "InteractionDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the lead interaction occurred, in ISO 8601 format (UTC). This timestamp helps track the chronology of lead engagement activities.
" } }, "CustomerAction": { "target": "com.amazonaws.partnercentralselling#CustomerAction", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "Describes the action taken by the customer during or as a result of the interaction, such as requesting information, scheduling a meeting, or expressing interest in a solution.
" } }, "BusinessProblem": { "target": "com.amazonaws.partnercentralselling#LeadBusinessProblem", "traits": { "smithy.api#documentation": "Describes the business problem or challenge that the customer discussed during the interaction. This information helps qualify the lead and identify appropriate solutions.
" } }, "Contact": { "target": "com.amazonaws.partnercentralselling#LeadContact", "traits": { "smithy.api#documentation": "Contains contact information for the customer representative involved in the lead interaction, including their name, title, and contact details.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadInteractionList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#LeadInteraction" }, "traits": { "smithy.api#documentation": "A list of interactions with a lead.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#LeadInvitationCustomer": { "type": "structure", "members": { "Industry": { "target": "com.amazonaws.partnercentralselling#LeadIndustry", "traits": { "smithy.api#documentation": "Specifies the industry sector of the customer company associated with the lead invitation. This categorization helps partners understand the customer's business context and assess solution fit.
" } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { "smithy.api#documentation": "The name of the customer company associated with the lead invitation. This field identifies the target organization for the lead engagement opportunity.
", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#LeadWebsiteUrl", "traits": { "smithy.api#documentation": "The website URL of the customer company. This provides additional context about the customer organization and helps partners verify company details and assess business size and legitimacy.
" } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#LeadCountryCode", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The country code indicating the geographic location of the customer company. This information helps partners understand regional requirements and assess their ability to serve the customer effectively.
" } }, "AwsMaturity": { "target": "com.amazonaws.partnercentralselling#AwsMaturity", "traits": { "smithy.api#documentation": "Indicates the customer's level of experience and adoption with AWS services. This assessment helps partners understand the customer's cloud maturity and tailor their engagement approach accordingly.
" } }, "MarketSegment": { "target": "com.amazonaws.partnercentralselling#LeadMarketSegment", "traits": { "smithy.api#documentation": "Specifies the market segment classification of the customer, such as enterprise, mid-market, or small business. This segmentation helps partners determine the appropriate solution complexity and engagement strategy.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadInvitationInteraction": { "type": "structure", "members": { "SourceType": { "target": "com.amazonaws.partnercentralselling#LeadSourceType", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "Specifies the type of source that generated the lead interaction, such as \"Event\", \"Website\", or \"Campaign\". This helps partners understand the lead generation channel and assess lead quality based on the source type.
" } }, "SourceId": { "target": "com.amazonaws.partnercentralselling#LeadSourceId", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The unique identifier of the specific source that generated the lead interaction. This provides traceability to the original lead generation activity for reference and follow-up purposes.
" } }, "SourceName": { "target": "com.amazonaws.partnercentralselling#LeadSourceName", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The descriptive name of the source that generated the lead interaction. This human-readable identifier helps partners understand the specific lead generation channel or campaign that created the opportunity.
" } }, "Usecase": { "target": "com.amazonaws.partnercentralselling#EngagementUseCase", "traits": { "smithy.api#documentation": "Describes the specific use case or business scenario associated with the lead interaction. This information helps partners understand the customer's interests and potential solution requirements.
" } }, "ContactBusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { "smithy.api#documentation": "The business title or job role of the customer contact involved in the lead interaction. This helps partners identify the decision-making level and engagement approach for the lead.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadInvitationPayload": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#LeadInvitationCustomer", "traits": { "smithy.api#documentation": "Contains information about the customer associated with the lead invitation. This data helps partners understand the customer's profile, industry, and business context to assess the lead opportunity.
", "smithy.api#required": {} } }, "Interaction": { "target": "com.amazonaws.partnercentralselling#LeadInvitationInteraction", "traits": { "smithy.api#documentation": "Describes the interaction details associated with the lead, including the source of the lead generation and customer engagement information. This context helps partners evaluate the lead quality and engagement approach.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#LeadJobTitle": { "type": "string", "traits": { "smithy.api#documentation": "The business title of a lead contact.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadMarketSegment": { "type": "string", "traits": { "smithy.api#documentation": "The market segment that a lead's company belongs to.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#LeadPhoneNumber": { "type": "string", "traits": { "smithy.api#documentation": "The phone number of a lead contact.
", "smithy.api#length": { "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadQualificationStatus": { "type": "string", "traits": { "smithy.api#default": "Unqualified", "smithy.api#documentation": "The qualification status of a lead. The default value is Unqualified. The value can contain 1 to 255 characters.
The identifier of the source that a lead interaction came from.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "com.amazonaws.partnercentralselling#LeadSourceName": { "type": "string", "traits": { "smithy.api#documentation": "The name of the source that a lead interaction came from.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "com.amazonaws.partnercentralselling#LeadSourceType": { "type": "string", "traits": { "smithy.api#documentation": "The type of the source that a lead interaction came from.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "com.amazonaws.partnercentralselling#LeadWebsiteUrl": { "type": "string", "traits": { "smithy.api#documentation": "The website URL of a lead's company.
", "smithy.api#length": { "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#LeadsNextToken": { "type": "string", "traits": { "smithy.api#documentation": "A pagination token.
", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.partnercentralselling#LifeCycle": { "type": "structure", "members": { "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { "smithy.api#documentation": "Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
The descriptions of each sales stage are:
Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).
Qualified: Your account team engaged with the customer to discuss viability and requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs.
Technical Validation: All parties understand the implementation plan.
Business Validation: Pricing was proposed, and all parties agree to the steps to close.
Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.
Launched: The workload is complete, and Amazon Web Services has started billing.
Closed Lost: The opportunity is lost, and there are no steps to move forward.
Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:
Customer Deficiency: The customer lacked necessary resources or capabilities.
Delay/Cancellation of Project: The project was delayed or canceled.
Legal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
Lost to Competitor\u2014Google: The opportunity was lost to Google.
Lost to Competitor\u2014Microsoft: The opportunity was lost to Microsoft.
Lost to Competitor\u2014SoftLayer: The opportunity was lost to SoftLayer.
Lost to Competitor\u2014VMWare: The opportunity was lost to VMWare.
Lost to Competitor\u2014Other: The opportunity was lost to a competitor not listed above.
No Opportunity: There was no opportunity to pursue.
On Premises Deployment: The customer chose an on-premises solution.
Partner Gap: The partner lacked necessary resources or capabilities.
Price: The price was not competitive or acceptable to the customer.
Security/Compliance: Security or compliance issues prevented progress.
Technical Limitations: Technical limitations prevented progress.
Customer Experience: Issues related to the customer's experience impacted the decision.
Other: Any reason not covered by the other values.
People/Relationship/Governance: Issues related to people, relationships, or governance.
Product/Technology: Issues related to the product or technology.
Financial/Commercial: Financial or commercial issues impacted the decision.
Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.
Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.
Ensure the Target Close Date isn't in the past.
Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:
Pending Submission: Not submitted for validation (editable).
Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).
In Review: Amazon Web Services is validating (read-only).
Action Required: Issues that Amazon Web Services highlights need to be addressed. Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made. Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:
Customer.Account.Address.City
Customer.Account.Address.CountryCode
Customer.Account.Address.PostalCode
Customer.Account.Address.StateOrRegion
Customer.Account.Address.StreetAddress
Customer.Account.WebsiteUrl
LifeCycle.TargetCloseDate
Project.ExpectedMonthlyAWSRevenue.Amount
Project.ExpectedMonthlyAWSRevenue.CurrencyCode
Project.CustomerBusinessProblem
PartnerOpportunityIdentifier
After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.
Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).
Rejected: Disqualified (read-only).
Contains detailed feedback from Amazon Web Services when requesting additional information from partners. Provides specific guidance on what partners need to provide or clarify for opportunity validation, complementing the ReviewStatusReason field.
Code indicating the validation decision during the Amazon Web Services opportunity review. Applies when status is Rejected or Action Required. Used to document validation results for AWS Partner Referrals and indicate when additional information is needed from partners as part of the APN Customer Engagement (ACE) program.
Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.
", "smithy.api#length": { "max": 50 } } } }, "traits": { "smithy.api#documentation": "An object that contains the Opportunity lifecycle's details.
The projected launch date of the opportunity shared through a snapshot.
" } }, "ReviewStatus": { "target": "com.amazonaws.partnercentralselling#ReviewStatus", "traits": { "smithy.api#documentation": "Defines the approval status of the opportunity shared through a snapshot.
" } }, "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { "smithy.api#documentation": "Defines the current stage of the opportunity shared through a snapshot.
" } }, "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { "smithy.api#documentation": "Describes the next steps for the opportunity shared through a snapshot.
", "smithy.api#pattern": "^(?s).{0,255}$" } } }, "traits": { "smithy.api#documentation": "Provides the lifecycle view of an opportunity resource shared through a snapshot.
" } }, "com.amazonaws.partnercentralselling#LifeCycleSummary": { "type": "structure", "members": { "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { "smithy.api#documentation": "Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.
A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.
The descriptions of each sales stage are:
Prospect: Amazon Web Services identifies the opportunity. It can be active (Comes directly from the end customer through a lead) or latent (Your account team believes it exists based on research, account plans, sales plays).
Qualified: Your account team engaged with the customer to discuss viability and understand requirements. The customer agreed that the opportunity is real, of interest, and may solve business/technical needs.
Technical Validation: All parties understand the implementation plan.
Business Validation: Pricing was proposed, and all parties agree to the steps to close.
Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.
Launched: The workload is complete, and Amazon Web Services has started billing.
Closed Lost: The opportunity is lost, and there are no steps to move forward.
Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.
Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.
Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.
Ensure the Target Close Date isn't in the past.
Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:
Pending Submission: Not submitted for validation (editable).
Submitted: Submitted for validation and not yet Amazon Web Services reviewed (read-only).
In Review: Undergoing Amazon Web Services validation (read-only).
Action Required: Address any issues Amazon Web Services highlights. Use the UpdateOpportunity API action to update the opportunity, and ensure you make all required changes. Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:
Customer.Account.Address.City
Customer.Account.Address.CountryCode
Customer.Account.Address.PostalCode
Customer.Account.Address.StateOrRegion
Customer.Account.Address.StreetAddress
Customer.Account.WebsiteUrl
LifeCycle.TargetCloseDate
Project.ExpectedCustomerSpend.Amount
Project.ExpectedCustomerSpend.CurrencyCode
Project.CustomerBusinessProblem
PartnerOpportunityIdentifier
After updates, the opportunity re-enters the validation phase. This process repeats until all issues are resolved, and the opportunity's Lifecycle.ReviewStatus is set to Approved or Rejected.
Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).
Rejected: Disqualified (read-only).
Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
Indicates the reason a specific decision was taken during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provides clarity for why an opportunity was disqualified or required further action.
" } } }, "traits": { "smithy.api#documentation": "An object that contains a LifeCycle object's subset of fields.
Use ListCustomerAccountBulkJobResults to list the outcome of each record in a bulk job. You can filter the results to records that succeeded or failed. A job that failed before it processed any records returns an empty list.
Results are paginated. Use NextToken to retrieve additional results.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the bulk job.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkRecordStatus", "traits": { "smithy.api#documentation": "Filters the results to records with the specified outcome. If you omit this field, records with all outcomes are returned.
" } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#MaxResults", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
Information about list customer account bulk job results request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#ListCustomerAccountBulkJobResultsResponse": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.partnercentralselling#BulkJobResultList", "traits": { "smithy.api#documentation": "The outcome of each record in the bulk job.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.partnercentralselling#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results. This value is absent when there are no more results.
" } } }, "traits": { "smithy.api#documentation": "Information about list customer account bulk job results response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#ListCustomerAccountBulkJobs": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#ListCustomerAccountBulkJobsRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#ListCustomerAccountBulkJobsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "smithy.api#documentation": "Use ListCustomerAccountBulkJobs to list the bulk jobs in the specified catalog. You can filter the results by job identifier or status.
Results are paginated. Use NextToken to retrieve additional results.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies criteria to filter the bulk jobs, such as the job identifier or status.
" } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#MaxResults", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
Information about list customer account bulk jobs request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#ListCustomerAccountBulkJobsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.partnercentralselling#CustomerAccountBulkJobSummaryList", "traits": { "smithy.api#documentation": "The bulk jobs that match the request.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.partnercentralselling#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results. This value is absent when there are no more results.
" } } }, "traits": { "smithy.api#documentation": "Information about list customer account bulk jobs response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTaskSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTaskSummary" }, "traits": { "smithy.api#documentation": "A list of summaries of tasks that start engagements by accepting invitations.
" } }, "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTaskSummary": { "type": "structure", "members": { "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier", "traits": { "smithy.api#documentation": "Unique identifier of the task.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the task.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Task start timestamp.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "Status of the task.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Detailed message describing the failure and possible recovery steps.
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "A code pointing to the specific reason for the failure.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "Unique identifier of opportunity that was created.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "Unique identifier of the resource snapshot job that was created.
" } }, "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement invitation that was accepted.
" } } }, "traits": { "smithy.api#documentation": "Specifies a subset of fields associated with tasks related to accepting an engagement invitation.
" } }, "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasks": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasksRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasksResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to listing engagements by accepting invitation tasks in AWS Partner\nCentral" }, "smithy.api#documentation": "Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.
", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementByAcceptingInvitationTasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TaskSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasksRequest": { "type": "structure", "members": { "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.
", "smithy.api#pattern": "^(?s).{1,2048}$" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", "traits": { "smithy.api#documentation": "Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the request from the production AWS environment.
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
" } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the opportunities they created or are associated with.
" } }, "EngagementInvitationIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the engagement invitations they are processing.
" } }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagementByAcceptingInvitationTasks operation.
An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagementByAcceptingInvitationTasks action returns.
A list of summaries of tasks that start engagements from opportunities.
" } }, "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummary": { "type": "structure", "members": { "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier", "traits": { "smithy.api#documentation": "A unique identifier for a specific task.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "The current status of the task.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
" } }, "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the Engagement Invitation.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasks": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasksRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasksResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to listing engagements from opportunity tasks in AWS Partner Central" }, "smithy.api#documentation": "Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.
", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementFromOpportunityTasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TaskSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasksRequest": { "type": "structure", "members": { "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
", "smithy.api#pattern": "^(?s).{1,2048}$" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", "traits": { "smithy.api#documentation": "Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
AWS: Retrieves the request from the production AWS environment.
Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.
Filters the tasks based on their current status. This allows you to focus on tasks in specific states.
" } }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.
" } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", "traits": { "smithy.api#documentation": "The identifier of the original opportunity associated with this task.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the engagements they created or are associated with.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagementFromOpportunityTasks operation.
TaskSummaries An array of TaskSummary objects containing details about each task.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagementFromOpportunityTasks action returns.
Lists the active, fully curated AWS Partner Central engagement groups that are available to you in the specified catalog. An engagement group is a curated set of engagements that share common characteristics, such as customer geography, industry, or solution category. To retrieve the engagements in a group, pass the group Id to SearchEngagements as GroupId, and use NextToken to retrieve additional pages of groups.
Specifies the catalog in which to list engagement groups. The following values are valid:
AWS: Production.
Sandbox: Testing environments.
Filters the results to engagement groups with the specified readiness level. If you omit this field, the operation returns groups of all readiness levels.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#EngagementGroupSort", "traits": { "smithy.api#documentation": "Specifies the field and direction used to sort the results. You can sort by Count or UpdatedAt. If you omit this field, the operation returns groups in recommended order.
Filters the results to the specified engagement groups. Each entry can be an engagement group identifier or an engagement group ARN. You can specify 1 to 10 entries. Identifiers that don't match an active group available to you are ignored.
" } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single call. If you omit this value, the operation returns up to 20 results. Use this value to control pagination together with NextToken.
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
" } } }, "traits": { "smithy.api#documentation": "The request for the ListEngagementGroups operation.
An array of engagement groups that are available to you in the specified catalog. The array is empty when no groups are available.
" } }, "NextToken": { "target": "com.amazonaws.partnercentralselling#LeadsNextToken", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. The response includes this token only when additional result pages are available.
" } } }, "traits": { "smithy.api#documentation": "The response from the ListEngagementGroups operation.
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.
", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementInvitations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "EngagementInvitationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListEngagementInvitationsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSort", "traits": { "smithy.api#documentation": "Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
" } }, "ParticipantType": { "target": "com.amazonaws.partnercentralselling#ParticipantType", "traits": { "smithy.api#documentation": "Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#InvitationStatusList", "traits": { "smithy.api#documentation": "Status values to filter the invitations.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { "smithy.api#documentation": "Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.
" } }, "SenderAwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccountIdOrAliasList", "traits": { "smithy.api#documentation": "List of sender AWS account IDs to filter the invitations.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagementInvitations operation.
An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagementInvitations action returns.
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.
The catalog related to the request.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier", "traits": { "smithy.api#documentation": "Identifier of the Engagement record to retrieve members from.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#MemberPageSize", "traits": { "smithy.api#default": 5, "smithy.api#documentation": "The maximum number of results to return in a single call.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagementMembers operation.
Provides a list of engagement members.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagementMembers action returns.
Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.
", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementResourceAssociations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "EngagementResourceAssociationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListEngagementResourceAssociationsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which to search for engagement-resource associations. Valid Values: \"AWS\" or \"Sandbox\"
AWS for production environments.
Sandbox for testing and development purposes.
Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.
" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "Filters the results to include only associations with resources of the specified type.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagementResourceAssociations operation.
A list of engagement-resource association summaries.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagementResourceAssociations action returns.
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.
", "smithy.api#http": { "method": "POST", "uri": "/ListEngagements", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "EngagementSummaryList" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListEngagementsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request.
", "smithy.api#required": {} } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { "smithy.api#documentation": "A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.
" } }, "ExcludeCreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { "smithy.api#documentation": "An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.
" } }, "ContextTypes": { "target": "com.amazonaws.partnercentralselling#EngagementContextTypeList", "traits": { "smithy.api#documentation": "Filters engagements to include only those containing the specified context types, such as \"CustomerProject\" or \"Lead\". Use this to find engagements that have specific types of contextual information associated with them.
" } }, "ExcludeContextTypes": { "target": "com.amazonaws.partnercentralselling#EngagementContextTypeList", "traits": { "smithy.api#documentation": "Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#EngagementSort", "traits": { "smithy.api#documentation": "Specifies how to sort the returned engagements.
" } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#EngagementPageSize", "traits": { "smithy.api#default": 20, "smithy.api#documentation": "The maximum number of results to return in a single call.
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results. This value is returned from a previous call.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { "smithy.api#documentation": "An array of strings representing engagement identifiers to retrieve.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListEngagements operation.
An array of engagement summary objects.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token to retrieve the next set of results. This field will be null if there are no more results.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListEngagements action returns.
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\u2019s 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\u2019t 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.
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.
Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.
Default: 20
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#OpportunitySort", "traits": { "smithy.api#documentation": "An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.
Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.
" } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#FilterIdentifier", "traits": { "smithy.api#documentation": "Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.
", "smithy.api#length": { "max": 20 } } }, "LifeCycleStage": { "target": "com.amazonaws.partnercentralselling#FilterLifeCycleStage", "traits": { "smithy.api#documentation": "Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.
Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.
Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.
", "smithy.api#length": { "max": 10 } } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#CreatedDateFilter", "traits": { "smithy.api#documentation": "Filter opportunities by creation date criteria.
" } }, "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#TargetCloseDateFilter", "traits": { "smithy.api#documentation": "Filters opportunities based on their target close date. This filter helps retrieve opportunities with an expected close date before or after a specified date.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListOpportunities operation.
An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListOpportunities action returns.
Lists the outcome of each record in an opportunity bulk job. You can filter the results by record status.
Results are paginated. Use NextToken to retrieve additional results.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the maximum number of results to return in a single call.
Default: 20
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } }, "JobId": { "target": "com.amazonaws.partnercentralselling#BulkJobId", "traits": { "smithy.api#documentation": "Specifies the identifier of the bulk job.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkRecordStatus", "traits": { "smithy.api#documentation": "Filters the results to records with this status.
" } } }, "traits": { "smithy.api#documentation": "Specifies the catalog, job identifier, filter, and pagination settings for listing the results of an opportunity bulk job.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#ListOpportunityBulkJobResultsResponse": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.partnercentralselling#BulkJobResultList", "traits": { "smithy.api#documentation": "The outcome of each record in the bulk job.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } } }, "traits": { "smithy.api#documentation": "The results of an opportunity bulk job.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#ListOpportunityBulkJobs": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#ListOpportunityBulkJobsRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#ListOpportunityBulkJobsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to list opportunity bulk jobs in AWS Partner Central" }, "smithy.api#documentation": "Lists the opportunity bulk jobs in the specified catalog, newest first. You can filter the results by job identifier or status.
Results are paginated. Use NextToken to retrieve additional results.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the maximum number of results to return in a single call.
Default: 20
", "smithy.api#range": { "min": 1, "max": 100 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } }, "JobId": { "target": "com.amazonaws.partnercentralselling#BulkJobId", "traits": { "smithy.api#documentation": "Filters the results to the bulk job with this identifier.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "Filters the results to bulk jobs with this status.
" } } }, "traits": { "smithy.api#documentation": "Specifies the catalog, filters, and pagination settings for listing opportunity bulk jobs.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#ListOpportunityBulkJobsResponse": { "type": "structure", "members": { "OpportunityBulkJobSummaries": { "target": "com.amazonaws.partnercentralselling#OpportunityBulkJobSummaryList", "traits": { "smithy.api#documentation": "The bulk jobs that match the request, newest first.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } } }, "traits": { "smithy.api#documentation": "The opportunity bulk jobs that match the request.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTaskSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTaskSummary" }, "traits": { "smithy.api#documentation": "A list of summaries of tasks that start opportunities from engagements.
" } }, "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTaskSummary": { "type": "structure", "members": { "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the task for creating an opportunity from an engagement.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated, in RFC 3339 format.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution.
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.
" } }, "ContextId": { "target": "com.amazonaws.partnercentralselling#ContextIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTasks": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTasksRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTasksResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to list opportunity from engagement tasks in AWS Partner Central" }, "smithy.api#documentation": "Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.
", "smithy.api#http": { "method": "POST", "uri": "/ListOpportunityFromEngagementTasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TaskSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListOpportunityFromEngagementTasksRequest": { "type": "structure", "members": { "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single page of the response. Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.
", "smithy.api#pattern": "^(?s).{1,2048}$" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", "traits": { "smithy.api#documentation": "Specifies how to sort the returned tasks. You can sort by the time that the tasks started.
" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.
Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.
Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.
" } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.
" } }, "ContextIdentifier": { "target": "com.amazonaws.partnercentralselling#ContextIdentifiers", "traits": { "smithy.api#documentation": "Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListOpportunityFromEngagementTasks operation.
An array of ListOpportunityFromEngagementTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.
A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListOpportunityFromEngagementTasks action returns.
Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the NextToken value from each response to retrieve subsequent pages.
Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.
The maximum number of results to return in a single page. If additional results exist, the response includes a NextToken value for retrieving the next page. If omitted, the API uses a service-defined default page size.
The pagination token from a previous call to this API. Include this value to retrieve the next page of results. If omitted, the first page is returned.
" } }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#TaskIdentifierList", "traits": { "smithy.api#documentation": "Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.
" } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskNameList", "traits": { "smithy.api#documentation": "Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.
" } }, "StartAfter": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.
Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.
Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.
" } } }, "traits": { "smithy.api#documentation": "Represents the request structure for listing prospecting tasks. All filter parameters are optional. Results are paginated \u2014 uses NextToken from the response to retrieve subsequent pages.
A pagination token used to retrieve the next page of results. If this field is present, pass its value as NextToken in the next call. If absent or empty, there are no further pages.
Prospecting task summaries matching the specified filters. Each summary includes the task identifier, name, status counters, and timing information. If no tasks match the filter criteria, the list is empty.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through NextToken when additional results are available.
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.
", "smithy.api#http": { "method": "POST", "uri": "/ListResourceSnapshotJobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ResourceSnapshotJobSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListResourceSnapshotJobsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "The maximum number of results to return in a single call. If omitted, defaults to 50.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the engagement to filter the response.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { "smithy.api#documentation": "The status of the jobs to filter the response.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#SortObject", "traits": { "smithy.api#documentation": "Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListResourceSnapshotJobs operation.
An array of resource snapshot job summary objects.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token to retrieve the next set of results. If there are no additional results, this value is null.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListResourceSnapshotJobs action returns.
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.
Specifies the catalog related to the request.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "The maximum number of results to return in a single call.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token for the next set of results.
" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement associated with the snapshots.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "Filters the response to include only snapshots of the specified resource type.
" } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "Filters the response to include only snapshots of the specified resource.
" } }, "ResourceSnapshotTemplateIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { "smithy.api#documentation": "Filters the response to include only snapshots created using the specified template.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "Filters the response to include only snapshots of resources owned by the specified AWS account.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListResourceSnapshots operation.
An array of resource snapshot summary objects.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The token to retrieve the next set of results. If there are no additional results, this value is null.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListResourceSnapshots action returns.
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.
", "smithy.api#http": { "method": "POST", "uri": "/ListSolutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "SolutionSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListSolutionsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.
The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.
Default: 20
" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#SolutionSort", "traits": { "smithy.api#documentation": "Object that configures sorting done on the response. Default Sort.SortBy is Identifier.
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
", "smithy.api#length": { "max": 10 } } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { "smithy.api#documentation": "Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.
", "smithy.api#length": { "max": 20 } } }, "Category": { "target": "com.amazonaws.partnercentralselling#StringList", "traits": { "smithy.api#documentation": "Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.
Filters results by AWS Marketplace solution ARN. You can provide up to 10 ARNs.
", "smithy.api#length": { "max": 10 } } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListSolutions operation.
An array with minimal details for solutions matching the request criteria.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListSolutions action returns.
Returns a list of tags for a resource.
", "smithy.api#http": { "method": "POST", "uri": "/ListTagsForResource", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.partnercentralselling#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.partnercentralselling#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the ListTagsForResource operation.
A map of the key-value pairs for the tag or tags assigned to the specified resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response that the ListTagsForResource action returns.
Determines the order in which the sorted results are presented.
", "smithy.api#required": {} } }, "SortBy": { "target": "com.amazonaws.partnercentralselling#ListTasksSortName", "traits": { "smithy.api#documentation": "Specifies the field by which the task list should be sorted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.
" } }, "com.amazonaws.partnercentralselling#ListTasksSortName": { "type": "enum", "members": { "START_TIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StartTime" } } }, "traits": { "smithy.api#documentation": "The name of the field that sorts a list of tasks. The only valid value is StartTime.
Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.
Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.
Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.
Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR
Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.
Indicates if the Opportunity is a marketing development fund (MDF) funded activity.
An object that contains marketing details for the Opportunity.
The source of the marketing activity. Valid values are Marketing Activity and None.
Information about max results.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.partnercentralselling#MemberCompanyName": { "type": "string", "traits": { "smithy.api#documentation": "The name of the company that an engagement member belongs to.
", "smithy.api#pattern": "^(?s).{1,120}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#MemberPageSize": { "type": "integer", "traits": { "smithy.api#default": 5, "smithy.api#documentation": "The maximum number of engagement members that a single call returns. The default is 5. Valid values range from 1 to 10.
", "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#MonetaryAmount": { "type": "string", "traits": { "smithy.api#documentation": "A monetary amount written as a decimal number with up to two digits after the decimal point.
", "smithy.api#pattern": "^(0|([1-9][0-9]{0,30}))(\\.[0-9]{0,2})?$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#MonetaryValue": { "type": "structure", "members": { "Amount": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the payment amount.
", "smithy.api#pattern": "^(0|([1-9][0-9]{0,30}))(\\.[0-9]{0,2})?$", "smithy.api#required": {} } }, "CurrencyCode": { "target": "com.amazonaws.partnercentralselling#CurrencyCode", "traits": { "smithy.api#documentation": "Specifies the payment currency. Accepted values are USD (US Dollars) and EUR (Euros). If the AWS Partition is aws-eusc (AWS European Sovereign Cloud), the currency code must be EUR.
Specifies payments details.
" } }, "com.amazonaws.partnercentralselling#Name": { "type": "string", "traits": { "smithy.api#documentation": "The name of a person or a company.
", "smithy.api#pattern": "^(?s).{0,80}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#NationalSecurity": { "type": "enum", "members": { "YES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Yes" } }, "NO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "No" } } }, "traits": { "smithy.api#documentation": "Specifies whether the opportunity involves national security. The value is Yes if it does, or No if it doesn't.
Indicates the step's execution details.
", "smithy.api#required": {} } }, "Time": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Indicates the step execution time.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Read-only; shows the last 50 values and change dates for the NextSteps field.
Information about next token.
" } }, "com.amazonaws.partnercentralselling#Opportunity": { "type": "resource", "identifiers": { "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier" }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#CreateOpportunity" }, "read": { "target": "com.amazonaws.partnercentralselling#GetOpportunity" }, "update": { "target": "com.amazonaws.partnercentralselling#UpdateOpportunity" }, "list": { "target": "com.amazonaws.partnercentralselling#ListOpportunities" }, "operations": [ { "target": "com.amazonaws.partnercentralselling#AssignOpportunity" }, { "target": "com.amazonaws.partnercentralselling#AssociateOpportunity" }, { "target": "com.amazonaws.partnercentralselling#DisassociateOpportunity" }, { "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummary" }, { "target": "com.amazonaws.partnercentralselling#SubmitOpportunity" } ], "collectionOperations": [ { "target": "com.amazonaws.partnercentralselling#SearchOpportunities" } ], "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/opportunity/{Identifier}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-your-opportunities.html" }, "smithy.api#documentation": "Represents an Opportunity that captures deal details in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#OpportunityArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies an opportunity.
", "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.partnercentralselling#OpportunityBulkJob": { "type": "resource", "identifiers": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" }, "Identifier": { "target": "com.amazonaws.partnercentralselling#BulkJobId" } }, "list": { "target": "com.amazonaws.partnercentralselling#ListOpportunityBulkJobs" }, "operations": [ { "target": "com.amazonaws.partnercentralselling#GetOpportunityBulkJobReportUrl" }, { "target": "com.amazonaws.partnercentralselling#ListOpportunityBulkJobResults" } ], "collectionOperations": [ { "target": "com.amazonaws.partnercentralselling#StartOpportunityBulkJob" } ], "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/opportunity-bulk-job/{Identifier}" }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-bulk-jobs.html", "name": "opportunity-bulk-job" }, "smithy.api#documentation": "Represents an asynchronous bulk job for Opportunity records in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#OpportunityBulkJobSummary": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.partnercentralselling#BulkJobId", "traits": { "smithy.api#documentation": "The unique identifier of the bulk job.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "The current status of the bulk job.
", "smithy.api#required": {} } }, "TotalRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of records in the input file.
", "smithy.api#required": {} } }, "ProcessedRecords": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that Partner Central has processed so far.
", "smithy.api#required": {} } }, "SuccessCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that succeeded.
", "smithy.api#required": {} } }, "FailureCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of records that failed.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time, in UTC, when you created the bulk job.
", "smithy.api#required": {} } }, "StartedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time, in UTC, when the bulk job started processing records.
" } }, "CompletedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time, in UTC, when the bulk job finished.
" } }, "FailureReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason that the bulk job failed. Present only when Status is FAILED.
The name of the input file that started the bulk job. Use it to identify the job by its file.
" } }, "OperationType": { "target": "com.amazonaws.partnercentralselling#BulkOperationType", "traits": { "smithy.api#documentation": "Indicates whether the bulk job creates or updates opportunities, based on the template of the input file. Partner Central doesn't set this field until it reads the file.
" } } }, "traits": { "smithy.api#documentation": "The status, record counts, and input file name of an opportunity bulk job.
" } }, "com.amazonaws.partnercentralselling#OpportunityBulkJobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunityBulkJobSummary" }, "traits": { "smithy.api#documentation": "The list of opportunity bulk job summaries.
" } }, "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSort": { "type": "structure", "members": { "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
Defines sorting options for retrieving Engagement Invitations. Sorting can be done based on various criteria like the invitation date or status.
" } }, "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSortName": { "type": "enum", "members": { "INVITATION_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvitationDate" } } }, "traits": { "smithy.api#documentation": "The name of the field that sorts a list of engagement invitations. The only valid value is InvitationDate.
The identifier of an opportunity. An identifier starts with the letter O followed by up to 19 digits.
A list of opportunity identifiers.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#OpportunityInvitationPayload": { "type": "structure", "members": { "SenderContacts": { "target": "com.amazonaws.partnercentralselling#SenderContactList", "traits": { "smithy.api#documentation": "Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.
" } }, "ReceiverResponsibilities": { "target": "com.amazonaws.partnercentralselling#ReceiverResponsibilityList", "traits": { "smithy.api#documentation": "Outlines the responsibilities or expectations of the receiver in the context of the invitation.
", "smithy.api#required": {} } }, "Customer": { "target": "com.amazonaws.partnercentralselling#EngagementCustomer", "traits": { "smithy.api#documentation": "Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer\u2019s profile and requirements.
", "smithy.api#required": {} } }, "Project": { "target": "com.amazonaws.partnercentralselling#ProjectDetails", "traits": { "smithy.api#documentation": "Describes the project details associated with the opportunity, including the customer\u2019s needs and the scope of work expected to be performed.
", "smithy.api#required": {} } }, "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { "smithy.api#documentation": "The type of the opportunity being shared. The sender of the invitation sets it. Valid values:
Net New Business: A new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Flat Renewal: An opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion: An opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.
" } }, "com.amazonaws.partnercentralselling#OpportunityOrigin": { "type": "enum", "members": { "AWS_REFERRAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS Referral" } }, "PARTNER_REFERRAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Partner Referral" } } }, "traits": { "smithy.api#documentation": "The origin of an opportunity. Valid values are AWS Referral and Partner Referral.
Deal quality score assigned to the opportunity. Values range from 0 to 100.
", "smithy.api#range": { "min": 0, "max": 100 } } }, "Trend": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Direction of score change since last scoring iteration. Known values: Improving, Declining, No Change.
Opportunity quality score and trend.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchAccount": { "type": "structure", "members": { "CompanyName": { "target": "com.amazonaws.partnercentralselling#SearchCompanyName", "traits": { "smithy.api#documentation": "The name of the end customer company on the opportunity.
", "smithy.api#pattern": "^(?s).{0,120}$" } }, "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { "smithy.api#documentation": "The industry of the end customer on the opportunity.
" } }, "AwsAccountId": { "target": "com.amazonaws.partnercentralselling#SearchAwsAccount", "traits": { "smithy.api#documentation": "The end customer company's AWS account ID, if known or available.
" } }, "Address": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchAddress", "traits": { "smithy.api#documentation": "The end customer address details for the opportunity.
" } } }, "traits": { "smithy.api#documentation": "Contains the end customer account fields (company name, industry, AWS account ID, and address) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchAddress": { "type": "structure", "members": { "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { "smithy.api#documentation": "The country of the end customer, in ISO 3166 alpha-2 format.
" } } }, "traits": { "smithy.api#documentation": "Contains the end customer address fields (country) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchAwsSummary": { "type": "structure", "members": { "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { "smithy.api#documentation": "Specifies whether the opportunity originated from AWS or from the partner.
" } }, "CosellMotion": { "target": "com.amazonaws.partnercentralselling#CosellMotion", "traits": { "smithy.api#documentation": "The engagement classification for this opportunity. Read-only.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchInsights", "traits": { "smithy.api#documentation": "Curated insights returned in search results: the engagement score and quality score.
" } } }, "traits": { "smithy.api#documentation": "Contains the AWS-sourced fields (co-sell motion and a trimmed set of insights) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchCustomer": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchAccount", "traits": { "smithy.api#documentation": "The end customer account details for the opportunity.
" } } }, "traits": { "smithy.api#documentation": "Contains the end customer fields (company name, industry, AWS account, and country) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchExpectedCustomerSpend": { "type": "structure", "members": { "Amount": { "target": "com.amazonaws.partnercentralselling#Amount", "traits": { "smithy.api#documentation": "The estimated monthly recurring revenue amount.
" } }, "CurrencyCode": { "target": "com.amazonaws.partnercentralselling#CurrencyCode", "traits": { "smithy.api#documentation": "The currency of the estimated amount, in ISO 4217 format.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A curated expected-spend entry: amount and currency only. Frequency and target company are omitted from search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchExpectedCustomerSpendList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchExpectedCustomerSpend" }, "traits": { "smithy.api#documentation": "A list of the amounts that you expect the customer to spend, as shown in search results.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.partnercentralselling#OpportunitySearchFilter": { "type": "structure", "members": { "AndAllFilters": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchFilterList", "traits": { "smithy.api#documentation": "A list of sub-filters that are joined with a logical AND. The node matches only when every sub-filter matches.
" } }, "OrAllFilters": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchFilterList", "traits": { "smithy.api#documentation": "A list of sub-filters that are joined with a logical OR. The node matches when at least one sub-filter matches.
" } }, "NotFilter": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchFilter", "traits": { "smithy.api#documentation": "A single sub-filter that is negated. The node matches when the sub-filter does not match.
" } }, "EqualsTo": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field equals the supplied value.
" } }, "ContainsAny": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field contains any of the supplied values as a case-insensitive substring. On a multi-valued field, the condition matches when any element contains the substring.
" } }, "ContainsAll": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field holds every supplied value. On a multi-valued field, every listed value must be present.
" } }, "GreaterThan": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is greater than the supplied value. Supported on ordered fields only (date or numeric).
" } }, "GreaterThanOrEquals": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is greater than or equal to the supplied value. Supported on ordered fields only (date or numeric).
" } }, "LessThan": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is less than the supplied value. Supported on ordered fields only (date or numeric).
" } }, "LessThanOrEquals": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchPredicate", "traits": { "smithy.api#documentation": "A leaf condition that matches when the field is less than or equal to the supplied value. Supported on ordered fields only (date or numeric).
" } } }, "traits": { "smithy.api#documentation": "A recursive filter node. Exactly one member must be set. The boolean combinators nest sub-filters: AndAllFilters joins its children with AND, OrAllFilters matches when at least one child matches, and NotFilter negates its single child. The remaining members are leaf conditions over a single field. Nesting is bounded (depth up to 3, each combinator list up to 10 entries, and up to 20 leaf conditions per tree). If a request exceeds these limits, the service returns a ValidationException.
A list of sub-filters in an opportunity search filter.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#OpportunitySearchFilterName": { "type": "enum", "members": { "OPPORTUNITY_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityId" } }, "STAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stage" } }, "REVIEW_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReviewStatus" } }, "CUSTOMER_COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerCompanyName" } }, "LAST_MODIFIED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } }, "TARGET_CLOSE_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetCloseDate" } }, "CREATED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } }, "COUNTRY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CountryCode" } }, "PARTNER_PROJECT_TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PartnerProjectTitle" } }, "OPPORTUNITY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityType" } }, "PARTNER_OPPORTUNITY_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PartnerOpportunityIdentifier" } }, "INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Industry" } }, "AWS_ACCOUNT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AwsAccountId" } }, "APN_PROGRAMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApnPrograms" } }, "ORIGIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Origin" } }, "TAGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Tags" } }, "NEXT_STEP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NextStep" } }, "OFFER_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfferId" } }, "OFFER_SET_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfferSetId" } }, "AWS_MARKETPLACE_SOLUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AwsMarketplaceSolution" } }, "COSELL_MOTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CosellMotion" } }, "OPPORTUNITY_OWNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityOwner" } }, "ESTIMATED_MRR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EstimatedMrr" } }, "ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementScore" } } }, "traits": { "smithy.api#documentation": "The name of an opportunity field that an opportunity search condition can apply to.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchFilterValue": { "type": "union", "members": { "StringValue": { "target": "com.amazonaws.partnercentralselling#SearchFilterValue", "traits": { "smithy.api#documentation": "A single string value. Used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values. Used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value, used by the range comparisons on integral numeric fields.
" } }, "DoubleValue": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "A fractional numeric value, used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format, used by the range comparisons on date fields.
" } } }, "traits": { "smithy.api#documentation": "Contains the value that a search predicate compares against. Specify exactly one member. The member you choose must match the field type and the comparison operator of the predicate.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchFilterValues": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#SearchFilterValue" }, "traits": { "smithy.api#documentation": "A list of string values that an opportunity search condition compares against.
", "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.partnercentralselling#OpportunitySearchInsights": { "type": "structure", "members": { "EngagementScore": { "target": "com.amazonaws.partnercentralselling#SearchEngagementScore", "traits": { "smithy.api#documentation": "The level of engagement with the opportunity. The value is High, Medium, or Low.
The opportunity quality score. Null when the opportunity has not yet been scored.
" } } }, "traits": { "smithy.api#documentation": "Contains the insight scores (engagement score and opportunity quality score) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchLifeCycle": { "type": "structure", "members": { "ReviewStatus": { "target": "com.amazonaws.partnercentralselling#ReviewStatus", "traits": { "smithy.api#documentation": "The approval status of the opportunity.
" } }, "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { "smithy.api#documentation": "The stage of the opportunity.
" } }, "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { "smithy.api#documentation": "The next steps for the opportunity. Mandatory for co-sell opportunities.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { "smithy.api#documentation": "The projected launch date of the opportunity, in ISO 8601 (YYYY-MM-DD) format.
" } } }, "traits": { "smithy.api#documentation": "Contains the lifecycle fields (review status, stage, next steps, and target close date) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchOpportunityQuality": { "type": "structure", "members": { "Score": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "A deal quality score (0-100) assigned to the opportunity.
", "smithy.api#range": { "min": 0, "max": 100 } } } }, "traits": { "smithy.api#documentation": "Curated opportunity quality: score only.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchPredicate": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchFilterName", "traits": { "smithy.api#documentation": "The opportunity field that the condition applies to.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchFilterValue", "traits": { "smithy.api#documentation": "The typed value the condition compares against. Specify one of the following:
A single string value \u2013 used by EqualsTo, and by ContainsAny or ContainsAll for a single-value match.
A list of string values \u2013 used by ContainsAny or ContainsAll to match against multiple values.
An integral numeric value \u2013 used by the range comparisons on integral numeric fields.
A fractional numeric value \u2013 used by the range comparisons on numeric amount fields such as EstimatedMrr.
A date-time value in RFC 3339 format \u2013 used by the range comparisons on date fields.
A leaf filter condition. It carries the field (Key) and the typed value (Value) to compare against. The enclosing OpportunitySearchFilter member determines the comparison operator.
The partner opportunity name.
", "smithy.api#pattern": "^(?s).{0,255}$" } }, "ApnPrograms": { "target": "com.amazonaws.partnercentralselling#ApnPrograms", "traits": { "smithy.api#documentation": "The AWS Partner Network (APN) programs associated with the opportunity's products or services.
" } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchExpectedCustomerSpendList", "traits": { "smithy.api#documentation": "The estimated AWS monthly recurring revenue (MRR): amount and currency only.
" } } }, "traits": { "smithy.api#documentation": "Contains the project fields (title, AWS Partner Network (APN) programs, and expected customer spend) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchRelatedEntityIdentifiers": { "type": "structure", "members": { "AwsMarketplaceOffers": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferIdentifiers", "traits": { "smithy.api#documentation": "The AWS Marketplace offers associated with this opportunity.
" } }, "AwsMarketplaceOfferSets": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferSetIdentifiers", "traits": { "smithy.api#documentation": "The AWS Marketplace offer sets associated with this opportunity.
" } }, "AwsMarketplaceSolutions": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifiers", "traits": { "smithy.api#documentation": "The AWS Marketplace solutions associated with this opportunity.
" } }, "Solutions": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { "smithy.api#documentation": "The proposed solutions to address the customer's business problem.
" } } }, "traits": { "smithy.api#documentation": "Contains the related-entity identifiers (AWS Marketplace offers, offer sets, and solutions) returned for an opportunity in search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchSort": { "type": "structure", "members": { "SortBy": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchSortName", "traits": { "smithy.api#documentation": "The field to sort the results by.
", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The direction of the sort, either ascending or descending.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configures sorting of the search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchSortName": { "type": "enum", "members": { "OPPORTUNITY_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityId" } }, "STAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stage" } }, "REVIEW_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReviewStatus" } }, "CUSTOMER_COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerCompanyName" } }, "LAST_MODIFIED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } }, "TARGET_CLOSE_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetCloseDate" } }, "CREATED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } }, "COUNTRY_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CountryCode" } }, "PARTNER_PROJECT_TITLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PartnerProjectTitle" } }, "OPPORTUNITY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityType" } }, "PARTNER_OPPORTUNITY_IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PartnerOpportunityIdentifier" } }, "INDUSTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Industry" } }, "AWS_ACCOUNT_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AwsAccountId" } }, "ORIGIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Origin" } }, "NEXT_STEP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NextStep" } }, "COSELL_MOTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CosellMotion" } }, "OPPORTUNITY_OWNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityOwner" } }, "ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementScore" } }, "ESTIMATED_MRR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EstimatedMrr" } }, "TAGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Tags" } }, "OFFER_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfferId" } }, "OFFER_SET_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OfferSetId" } }, "APN_PROGRAMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApnPrograms" } } }, "traits": { "smithy.api#documentation": "The name of an opportunity field that you can use to sort opportunity search results.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchSummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchSummary" }, "traits": { "smithy.api#documentation": "A list of opportunity summaries that an opportunity search returns.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "The read-only, system-generated unique identifier of the opportunity.
", "smithy.api#required": {} } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the opportunity was last modified, in UTC.
", "smithy.api#required": {} } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the opportunity was created, in UTC.
", "smithy.api#required": {} } }, "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { "smithy.api#documentation": "Specifies whether the opportunity is a new business opportunity, a renewal, or an expansion.
" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the opportunity in your customer relationship management (CRM) system. This value lets you link the opportunity to your CRM.
", "smithy.api#pattern": "^(?s).{0,64}$" } }, "LifeCycle": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchLifeCycle", "traits": { "smithy.api#documentation": "A curated lifecycle view: review status, stage, next steps, and target close date.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchCustomer", "traits": { "smithy.api#documentation": "A curated customer view: company name, industry, AWS account, and country.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchProject", "traits": { "smithy.api#documentation": "A curated project view: title, AWS Partner Network (APN) programs, and expected customer spend.
" } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "The tags associated with the opportunity, returned as key-value pairs.
" } }, "RelatedEntityIdentifiers": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchRelatedEntityIdentifiers", "traits": { "smithy.api#documentation": "Curated related-entity identifiers surfaced in search: AWS Marketplace offers, offer sets, and solutions.
" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchTeamMembersList", "traits": { "smithy.api#documentation": "The opportunity owner and team members. Search results include only each member's name and business title, and exclude contact email and phone.
" } }, "AwsOpportunitySummary": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchAwsSummary", "traits": { "smithy.api#documentation": "The AWS-side view of this opportunity. Absent when no AWS opportunity summary record exists yet.
" } } }, "traits": { "smithy.api#documentation": "A curated summary view of an opportunity returned by a search. It holds the fields needed to render a search result row, take action, and run follow-up filters.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchTeamMember": { "type": "structure", "members": { "FirstName": { "target": "com.amazonaws.partnercentralselling#SearchTeamMemberName", "traits": { "smithy.api#documentation": "The team member's first name.
", "smithy.api#pattern": "^(?s).{0,80}$" } }, "LastName": { "target": "com.amazonaws.partnercentralselling#SearchTeamMemberName", "traits": { "smithy.api#documentation": "The team member's last name.
", "smithy.api#pattern": "^(?s).{0,80}$" } }, "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { "smithy.api#documentation": "The team member's business title.
" } } }, "traits": { "smithy.api#documentation": "An opportunity team member surfaced in search: name and business title only, with no contact details.
" } }, "com.amazonaws.partnercentralselling#OpportunitySearchTeamMembersList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunitySearchTeamMember" }, "traits": { "smithy.api#documentation": "A list of the opportunity team members that search results show.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.partnercentralselling#OpportunitySort": { "type": "structure", "members": { "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "Sort order.
Default: Descending
Field name to sort by.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Object that configures response sorting.
" } }, "com.amazonaws.partnercentralselling#OpportunitySortName": { "type": "enum", "members": { "LAST_MODIFIEDDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedDate" } }, "IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Identifier" } }, "CUSTOMER_COMPANY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerCompanyName" } }, "CREATED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } }, "TARGET_CLOSE_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TargetCloseDate" } } }, "traits": { "smithy.api#documentation": "The name of the field that sorts a list of opportunities.
" } }, "com.amazonaws.partnercentralselling#OpportunitySummaries": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#OpportunitySummary" }, "traits": { "smithy.api#documentation": "A list of opportunity summaries.
" } }, "com.amazonaws.partnercentralselling#OpportunitySummary": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.
Read-only, system-generated Opportunity unique identifier.
The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.
" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.
Specifies opportunity type as a renewal, new, or expansion.
Opportunity types:
New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
DateTime when the Opportunity was last modified.
DateTime when the Opportunity was last created.
An object that contains the Opportunity's lifecycle details.
An object that contains the Opportunity's customer details.
An object that contains the Opportunity's project details summary.
An object that contains an Opportunity's subset of fields.
Specifies the opportunity type.
" } }, "Lifecycle": { "target": "com.amazonaws.partnercentralselling#LifeCycleForView", "traits": { "smithy.api#documentation": "Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.
" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList", "traits": { "smithy.api#documentation": "Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.
" } }, "PrimaryNeedsFromAws": { "target": "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws", "traits": { "smithy.api#documentation": "Identifies the type of support the partner needs from AWS.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { "smithy.api#documentation": "Contains details about the customer that the opportunity belongs to.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#ProjectView", "traits": { "smithy.api#documentation": "Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.
" } }, "RelatedEntityIdentifiers": { "target": "com.amazonaws.partnercentralselling#RelatedEntityIdentifiers", "traits": { "smithy.api#documentation": "Lists the identifiers of entities that relate to the opportunity, such as AWS products, partner solutions, and AWS Marketplace offers.
" } } }, "traits": { "smithy.api#documentation": "Provides a comprehensive view of an opportunity summary, including lifecycle information, team details, opportunity type, primary needs from AWS, and associated project information.
" } }, "com.amazonaws.partnercentralselling#OpportunityType": { "type": "enum", "members": { "NET_NEW_BUSINESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Net New Business" } }, "FLAT_RENEWAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Flat Renewal" } }, "EXPANSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Expansion" } } }, "traits": { "smithy.api#documentation": "The type of an opportunity. Valid values are Net New Business, Flat Renewal, and Expansion.
The maximum number of results that a single call returns. Valid values range from 1 to 100. If you don't specify a value, the operation uses its default page size.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.partnercentralselling#ParticipantType": { "type": "enum", "members": { "SENDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SENDER" } }, "RECEIVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECEIVER" } } }, "traits": { "smithy.api#documentation": "The role of the caller in an engagement invitation. Valid values are SENDER and RECEIVER.
Information about partner account identifier.
", "smithy.api#pattern": "^(?s).{0,64}$" } }, "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Contact" }, "traits": { "smithy.api#documentation": "A list of the partner's team members who work on the opportunity.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.partnercentralselling#Payload": { "type": "union", "members": { "OpportunityInvitation": { "target": "com.amazonaws.partnercentralselling#OpportunityInvitationPayload", "traits": { "smithy.api#documentation": "Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.
" } }, "LeadInvitation": { "target": "com.amazonaws.partnercentralselling#LeadInvitationPayload", "traits": { "smithy.api#documentation": "Specifies the details of the lead invitation within the Engagement Invitation payload. This data helps partners understand the lead context, customer information, and interaction history for the lead opportunity from AWS.
" } }, "AccountPlanningInvitation": { "target": "com.amazonaws.partnercentralselling#AccountPlanningInvitationPayload", "traits": { "smithy.api#documentation": "The content of an account-planning invitation. This field is present when the invitation is for account planning.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#PaymentFrequency": { "type": "enum", "members": { "MONTHLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Monthly" } } }, "traits": { "smithy.api#documentation": "How often the customer pays the expected spend. Set this value to Monthly.
A phone number in international format, which starts with a plus sign followed by the country code and the number.
", "smithy.api#pattern": "^\\+[1-9]\\d{1,14}$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#PiiString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#PreferredContactWindow": { "type": "structure", "members": { "Window": { "target": "com.amazonaws.partnercentralselling#ContactWindow", "traits": { "smithy.api#documentation": "The preferred time-of-day band for contact.
" } }, "Timezone": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The IANA time zone name that the window is expressed in, for example America/Chicago.
The time window during which the sender prefers to be contacted about an account plan. This information is advisory. Both fields are optional.
" } }, "com.amazonaws.partnercentralselling#PrimaryNeedFromAws": { "type": "enum", "members": { "CO_SELL_ARCHITECTURAL_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Architectural Validation" } }, "CO_SELL_BUSINESS_PRESENTATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Business Presentation" } }, "CO_SELL_COMPETITIVE_INFORMATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Competitive Information" } }, "CO_SELL_PRICING_ASSISTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Pricing Assistance" } }, "CO_SELL_TECHNICAL_CONSULTATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Technical Consultation" } }, "CO_SELL_TOTAL_COST_OF_OWNERSHIP_EVALUATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Total Cost of Ownership Evaluation" } }, "CO_SELL_DEAL_SUPPORT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Deal Support" } }, "CO_SELL_SUPPORT_FOR_PUBLIC_TENDER_RFX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell - Support for Public Tender / RFx" } } }, "traits": { "smithy.api#documentation": "A type of help that the partner needs from AWS on an opportunity.
" } }, "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#PrimaryNeedFromAws" }, "traits": { "smithy.api#documentation": "A list of the types of help that the partner needs from AWS on an opportunity.
" } }, "com.amazonaws.partnercentralselling#ProfileNextStepsHistories": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ProfileNextStepsHistory" } }, "com.amazonaws.partnercentralselling#ProfileNextStepsHistory": { "type": "structure", "members": { "Value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.
", "smithy.api#required": {} } }, "Time": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.
" } }, "com.amazonaws.partnercentralselling#Project": { "type": "structure", "members": { "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { "smithy.api#documentation": "Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.
Options' descriptions from the Delivery Model field are:
SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.
BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.
Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).
Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).
Resell: Amazon Web Services accounts and billing management for your customers.
Other: Delivery model not described above.
Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.
" } }, "ExpectedContractDuration": { "target": "com.amazonaws.partnercentralselling#ExpectedContractDuration", "traits": { "smithy.api#documentation": "Optional. The expected duration of the contract associated with this opportunity. Partners use this value alongside expected customer spend to convert Total Contract Value (TCV) into Monthly Recurring Revenue (MRR).
" } }, "Title": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { "smithy.api#documentation": "Specifies the Opportunity's title or name.
Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.
Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP
Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.
Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.
Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps
Specifies the current opportunity's parent opportunity identifier.
" } }, "SalesActivities": { "target": "com.amazonaws.partnercentralselling#SalesActivities", "traits": { "smithy.api#documentation": "Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.
Valid values:
Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.
Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.
Conducted POC/demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.
In evaluation/planning stage: The customer is evaluating the solution and planning potential implementation.
Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.
Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.
Finalized Deployment Need: Both parties agree with and finalized the deployment needs.
SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.
Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.
Only allowed when CompetitorNames has Other selected.
Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.
Captures additional comments or information for the Opportunity that weren't captured in other fields.
AWS partition where the opportunity will be deployed. Possible values: aws-eusc for AWS European Sovereign Cloud, null for all other partitions.
An object that contains the Opportunity's project details.
Describes the business problem that the project aims to solve. This information is crucial for understanding the project\u2019s goals and objectives.
", "smithy.api#required": {} } }, "Title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.
", "smithy.api#pattern": "^(?s).{1,255}$", "smithy.api#required": {} } }, "TargetCompletionDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { "smithy.api#documentation": "Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
", "smithy.api#required": {} } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { "smithy.api#documentation": "Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.
" } }, "com.amazonaws.partnercentralselling#ProjectSummary": { "type": "structure", "members": { "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { "smithy.api#documentation": "Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.
Options' descriptions from the Delivery Model field are:
SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.
BYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.
Managed Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).
Professional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).
Resell: Amazon Web Services accounts and billing management for your customers.
Other: Delivery model not described above.
Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.
" } }, "ExpectedContractDuration": { "target": "com.amazonaws.partnercentralselling#ExpectedContractDuration", "traits": { "smithy.api#documentation": "Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
An object that contains a Project object's subset of fields.
Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.
" } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { "smithy.api#documentation": "Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.
" } }, "ExpectedContractDuration": { "target": "com.amazonaws.partnercentralselling#ExpectedContractDuration", "traits": { "smithy.api#documentation": "Optional. The expected contract duration for this opportunity, representing the anticipated length of the contract in the unit specified by Term.
Specifies the proposed solution focus or type of workload for the project.
" } }, "SalesActivities": { "target": "com.amazonaws.partnercentralselling#SalesActivities", "traits": { "smithy.api#documentation": "Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.
" } }, "OtherSolutionDescription": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { "smithy.api#documentation": "Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.
", "smithy.api#pattern": "^(?s).{0,255}$" } } }, "traits": { "smithy.api#documentation": "Provides the project view of an opportunity resource shared through a snapshot.
" } }, "com.amazonaws.partnercentralselling#ProspectingAccountName": { "type": "string", "traits": { "smithy.api#documentation": "The name of the prospected customer account.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingCompanySize": { "type": "string", "traits": { "smithy.api#documentation": "The size of the prospected customer's company.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingFromEngagementTask": { "type": "resource", "identifiers": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#StartProspectingFromEngagementTask" }, "read": { "target": "com.amazonaws.partnercentralselling#GetProspectingFromEngagementTask" }, "list": { "target": "com.amazonaws.partnercentralselling#ListProspectingFromEngagementTasks" }, "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/prospecting-from-engagement-task/{TaskIdentifier}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "prospecting-from-engagement-task", "relativeDocumentation": "working-with-prospecting.html" }, "smithy.api#documentation": "Represents a task that runs prospecting from engagement in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#ProspectingFromEngagementTaskSort": { "type": "structure", "members": { "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.
The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).
Specifies the sort configuration for ListProspectingFromEngagementTasks. Contains the field to sort by and the sort direction.
The fields available for sorting results from ListProspectingFromEngagementTasks. Valid values are StartTime, TaskName, and FailedEngagementCount.
The geographic area of the prospected customer.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingInsights": { "type": "structure", "members": { "MarketplaceEngagementScore": { "target": "com.amazonaws.partnercentralselling#EngagementScoreLevel", "traits": { "smithy.api#documentation": "A score that indicates the prospected customer's level of engagement with AWS Marketplace. Valid values are High, Medium, and Low.
A score that indicates how well the partner's solution fits the prospected customer's needs.
" } }, "SolutionCategory": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The primary solution category classification for the prospected customer. This indicates the type of solution that best addresses their needs.
" } }, "SolutionSubCategory": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The solution sub-category classification for the prospected customer. This provides more granular categorization of the recommended solution type.
" } } }, "traits": { "smithy.api#documentation": "Contains insights that AI generates from the prospecting analysis. These insights include marketplace engagement scoring, solution fit assessments, and solution categorization for the prospected customer.
" } }, "com.amazonaws.partnercentralselling#ProspectingPublicProfileSummary": { "type": "string", "traits": { "smithy.api#documentation": "A summary of the public profile of the prospected customer.
", "smithy.api#length": { "max": 5000 } } }, "com.amazonaws.partnercentralselling#ProspectingRegion": { "type": "string", "traits": { "smithy.api#documentation": "The region of the prospected customer.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingResult": { "type": "structure", "members": { "Aws": { "target": "com.amazonaws.partnercentralselling#ProspectingResultAws", "traits": { "smithy.api#documentation": "Prospecting data and insights that AWS provides during the prospecting job. This includes customer details, task information, and scoring that AI generates.
" } } }, "traits": { "smithy.api#documentation": "Contains the results of an autonomous prospecting job. This includes data and insights that AWS provides about a prospected customer account.
" } }, "com.amazonaws.partnercentralselling#ProspectingResultAws": { "type": "structure", "members": { "Customer": { "target": "com.amazonaws.partnercentralselling#ProspectingResultCustomer", "traits": { "smithy.api#documentation": "Contains details about the prospected customer account, including geographic, industry, and segment classifications.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#ProspectingInsights", "traits": { "smithy.api#documentation": "Insights that AI generates from the prospecting analysis. These insights include engagement scores and solution fit assessments for the prospected customer.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp when the prospecting result context was created. The format is ISO 8601 (UTC).
" } }, "EndTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp when the prospecting task completed processing. The format is ISO 8601 (UTC).
" } }, "TaskId": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the prospecting task that generates this result.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prospecting task. Use this ARN to track and manage the task within AWS.
" } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskName", "traits": { "smithy.api#documentation": "The name that the user provides for the prospecting task that generates this result.
" } } }, "traits": { "smithy.api#documentation": "Contains the prospecting data that AWS sources. This includes task execution details, customer account information, and insights that AI generates from the prospecting analysis.
" } }, "com.amazonaws.partnercentralselling#ProspectingResultCustomer": { "type": "structure", "members": { "AccountName": { "target": "com.amazonaws.partnercentralselling#ProspectingAccountName", "traits": { "smithy.api#documentation": "The name of the prospected customer account.
" } }, "Geo": { "target": "com.amazonaws.partnercentralselling#ProspectingGeo", "traits": { "smithy.api#documentation": "The geographic region classification of the prospected customer account.
" } }, "Region": { "target": "com.amazonaws.partnercentralselling#ProspectingRegion", "traits": { "smithy.api#documentation": "The specific region of the prospected customer account.
" } }, "SubRegion": { "target": "com.amazonaws.partnercentralselling#ProspectingSubRegion", "traits": { "smithy.api#documentation": "The subregion classification of the prospected customer account.
" } }, "Country": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { "smithy.api#documentation": "The country code of the prospected customer account.
" } }, "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { "smithy.api#documentation": "The industry classification of the prospected customer account.
" } }, "SubIndustry": { "target": "com.amazonaws.partnercentralselling#ProspectingSubIndustry", "traits": { "smithy.api#documentation": "The sub-industry classification of the prospected customer account. This provides more granular categorization within the primary industry.
" } }, "Segment": { "target": "com.amazonaws.partnercentralselling#ProspectingSegment", "traits": { "smithy.api#documentation": "The market segment classification of the prospected customer account.
" } }, "CompanySize": { "target": "com.amazonaws.partnercentralselling#ProspectingCompanySize", "traits": { "smithy.api#documentation": "The company size classification of the prospected customer account.
" } }, "EligiblePrograms": { "target": "com.amazonaws.partnercentralselling#EligibleProgramsList", "traits": { "smithy.api#documentation": "A list of AWS Greenfield programs that the prospected customer is eligible for. Use this list to identify relevant go-to-market opportunities.
" } }, "PublicProfileSummary": { "target": "com.amazonaws.partnercentralselling#ProspectingPublicProfileSummary", "traits": { "smithy.api#documentation": "A summary of publicly available information about the prospected customer. The system uses this summary to generate customer insights and inform engagement strategies.
" } } }, "traits": { "smithy.api#documentation": "Contains detailed information about the prospected customer account, including company identifiers, geographic classification, industry segmentation, and program eligibility.
" } }, "com.amazonaws.partnercentralselling#ProspectingSegment": { "type": "string", "traits": { "smithy.api#documentation": "The market segment of the prospected customer.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingSubIndustry": { "type": "string", "traits": { "smithy.api#documentation": "The sub-industry of the prospected customer.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingSubRegion": { "type": "string", "traits": { "smithy.api#documentation": "The sub-region of the prospected customer.
", "smithy.api#length": { "max": 255 } } }, "com.amazonaws.partnercentralselling#ProspectingTaskArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies a prospecting task.
", "smithy.api#pattern": "^arn:.*$" } }, "com.amazonaws.partnercentralselling#ProspectingTaskIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a prospecting task. An identifier starts with task- followed by 14 lowercase letters or digits.
The current execution state of a prospecting task. A task transitions from PENDING to IN_PROGRESS when processing begins, and then to either COMPLETED or FAILED when processing ends.
The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.
The Amazon Resource Name (ARN) of the task.
", "smithy.api#required": {} } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskName", "traits": { "smithy.api#documentation": "The descriptive name of the task provided when it was created.
", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.
" } }, "TotalEngagementCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of engagements included in the task.
", "smithy.api#required": {} } }, "CompletedEngagementCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of engagements that have been successfully converted into prospecting leads.
", "smithy.api#required": {} } }, "FailedEngagementCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.
A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask.
A list of summaries of prospecting tasks.
" } }, "com.amazonaws.partnercentralselling#PutSellingSystemSettings": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#PutSellingSystemSettingsRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#PutSellingSystemSettingsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to put selling system settings in AWS Partner Central" }, "smithy.api#documentation": "Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.
", "smithy.api#http": { "method": "POST", "uri": "/PutSellingSystemSettings", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#PutSellingSystemSettingsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.
Specifies the ARN of the IAM Role used for resource snapshot job executions.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the PutSellingSystemSettings operation.
Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.
Specifies the ARN of the IAM Role used for resource snapshot job executions.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the PutSellingSystemSettings action returns.
Leads that are ready for direct sales outreach.
", "smithy.api#enumValue": "SalesReady" } }, "MARKETING_READY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Leads that are suited to a marketing campaign rather than direct outreach.
", "smithy.api#enumValue": "MarketingReady" } }, "LOW_POTENTIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Leads with low potential that are suited to a nurture campaign.
", "smithy.api#enumValue": "LowPotential" } } }, "traits": { "smithy.api#documentation": "The readiness level of an engagement group, which indicates the recommended call to action for its leads.
" } }, "com.amazonaws.partnercentralselling#ReasonCode": { "type": "enum", "members": { "INVITATION_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvitationAccessDenied" } }, "INVITATION_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvitationValidationFailed" } }, "ENGAGEMENT_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementAccessDenied" } }, "OPPORTUNITY_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityAccessDenied" } }, "RESOURCE_SNAPSHOT_JOB_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotJobAccessDenied" } }, "RESOURCE_SNAPSHOT_JOB_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotJobValidationFailed" } }, "RESOURCE_SNAPSHOT_JOB_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotJobConflict" } }, "ENGAGEMENT_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementValidationFailed" } }, "ENGAGEMENT_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementConflict" } }, "OPPORTUNITY_SUBMISSION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunitySubmissionFailed" } }, "ENGAGEMENT_INVITATION_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EngagementInvitationConflict" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalError" } }, "OPPORTUNITY_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityValidationFailed" } }, "OPPORTUNITY_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpportunityConflict" } }, "RESOURCE_SNAPSHOT_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotAccessDenied" } }, "RESOURCE_SNAPSHOT_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotValidationFailed" } }, "RESOURCE_SNAPSHOT_CONFLICT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceSnapshotConflict" } }, "SERVICE_QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ServiceQuotaExceeded" } }, "REQUEST_THROTTLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequestThrottled" } }, "CONTEXT_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ContextNotFound" } }, "CUSTOMER_PROJECT_CONTEXT_NOT_PERMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerProjectContextNotPermitted" } }, "DISQUALIFIED_LEAD_NOT_PERMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DisqualifiedLeadNotPermitted" } } }, "traits": { "smithy.api#documentation": "A code that identifies the reason that a task failed.
" } }, "com.amazonaws.partnercentralselling#Receiver": { "type": "union", "members": { "Account": { "target": "com.amazonaws.partnercentralselling#AccountReceiver", "traits": { "smithy.api#documentation": "Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#ReceiverResponsibility": { "type": "enum", "members": { "DISTRIBUTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Distributor" } }, "RESELLER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Reseller" } }, "HARDWARE_PARTNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hardware Partner" } }, "MANAGED_SERVICE_PROVIDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Managed Service Provider" } }, "SOFTWARE_PARTNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Software Partner" } }, "SERVICES_PARTNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Services Partner" } }, "TRAINING_PARTNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Training Partner" } }, "CO_SELL_FACILITATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell Facilitator" } }, "FACILITATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Facilitator" } } }, "traits": { "smithy.api#documentation": "A responsibility that the receiver of an engagement invitation has in the engagement.
" } }, "com.amazonaws.partnercentralselling#ReceiverResponsibilityList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ReceiverResponsibility" }, "traits": { "smithy.api#documentation": "A list of responsibilities that the receiver of an engagement invitation has in the engagement.
" } }, "com.amazonaws.partnercentralselling#Recommendation": { "type": "structure", "members": { "Type": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The recommendation source type. Known values: OpportunityQuality, SolutionRecommendation, SpecialistRecommendation.
Human-readable recommendation text from this source.
", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.partnercentralselling#RecommendationAttributeMap", "traits": { "smithy.api#documentation": "Source-specific metadata as key-value pairs.
" } } }, "traits": { "smithy.api#documentation": "A recommendation from an agent-driven source.
" } }, "com.amazonaws.partnercentralselling#RecommendationAttributeMap": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the attribute.
" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the attribute.
" } }, "traits": { "smithy.api#documentation": "A map of key-value pairs that hold extra details about a recommendation. The map can contain up to 25 entries.
", "smithy.api#length": { "max": 25 } } }, "com.amazonaws.partnercentralselling#RecommendationList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Recommendation" }, "traits": { "smithy.api#documentation": "A list of recommendations.
", "smithy.api#length": { "max": 5 } } }, "com.amazonaws.partnercentralselling#RejectEngagementInvitation": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#RejectEngagementInvitationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to reject Engagement Invitations on AWS Partner Central" }, "smithy.api#documentation": "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.
This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.
This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.
This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:
Customer problem unclear: The customer's problem isn't understood.
Next steps unclear: The next steps required to proceed aren't understood.
Unable to support: The partner is unable to provide support due to resource or capability constraints.
Duplicate of partner referral: The opportunity is a duplicate of an existing referral.
Other: Any reason not covered by other values.
Contains the request parameters for the RejectEngagementInvitation operation.
The reason for rejecting an engagement invitation.
", "smithy.api#pattern": "^[\\u0020-\\u007E\\u00A0-\\uD7FF\\uE000-\\uFFFD]{1,80}$" } }, "com.amazonaws.partnercentralselling#RelatedEntityIdentifiers": { "type": "structure", "members": { "AwsMarketplaceOffers": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferIdentifiers", "traits": { "smithy.api#documentation": "Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: \"offers\": [\"arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32\"].
Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.
" } }, "AwsMarketplaceOfferSets": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferSetIdentifiers", "traits": { "smithy.api#documentation": "Enables the association of AWS Marketplace offer sets with the Opportunity. Offer sets allow grouping multiple related marketplace offers together for comprehensive solution packaging. Each value is an Amazon Resource Name (ARN) in this format: arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/OfferSet/offerset-sampleOfferSet32.
Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.
If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.
By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.
" } }, "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifiers", "traits": { "smithy.api#documentation": "Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].
Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.
" } }, "AwsMarketplaceSolutions": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionIdentifiers", "traits": { "smithy.api#documentation": "Specifies the AWS Marketplace solutions to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a solution listing in AWS Marketplace.
Specifies the AWS Marketplace products to associate with the Opportunity. Each value is an Amazon Resource Name (ARN) that identifies a product listing in AWS Marketplace.
This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.
The type of an entity that you associate with an opportunity. Valid values are Solutions, AwsProducts, AwsMarketplaceOffers, AwsMarketplaceOfferSets, AwsMarketplaceSolutions, and AwsMarketplaceProducts.
The Amazon Resource Name (ARN) that identifies a resource.
", "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.partnercentralselling#ResourceIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a resource. For the Opportunity resource type, the identifier is an opportunity identifier.
A message that describes which resource the service couldn't find.
" } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.partnercentralselling#ResourceSnapshot": { "type": "resource", "operations": [ { "target": "com.amazonaws.partnercentralselling#CreateResourceSnapshot" }, { "target": "com.amazonaws.partnercentralselling#GetResourceSnapshot" }, { "target": "com.amazonaws.partnercentralselling#ListEngagementResourceAssociations" }, { "target": "com.amazonaws.partnercentralselling#ListResourceSnapshots" } ], "traits": { "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents a snapshot of a resource that is in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies a resource snapshot.
", "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJob": { "type": "resource", "identifiers": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" }, "Identifier": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier" } }, "create": { "target": "com.amazonaws.partnercentralselling#CreateResourceSnapshotJob" }, "read": { "target": "com.amazonaws.partnercentralselling#GetResourceSnapshotJob" }, "delete": { "target": "com.amazonaws.partnercentralselling#DeleteResourceSnapshotJob" }, "list": { "target": "com.amazonaws.partnercentralselling#ListResourceSnapshotJobs" }, "operations": [ { "target": "com.amazonaws.partnercentralselling#StartResourceSnapshotJob" }, { "target": "com.amazonaws.partnercentralselling#StopResourceSnapshotJob" } ], "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/resource-snapshot-job/{Identifier}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "working-with-multi-partner-opportunities.html", "name": "resource-snapshot-job" }, "smithy.api#documentation": "Represents a job that captures snapshot resource in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies a resource snapshot job.
", "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a resource snapshot job. An identifier starts with job- followed by 13 lowercase letters or digits.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that a resource snapshot job uses.
", "smithy.api#pattern": "^(?=.{0,2048}$)arn:aws:iam::\\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*[-+=,.@_a-zA-Z0-9]{1,64}$" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobRoleIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or the name of the AWS Identity and Access Management (IAM) role that a resource snapshot job uses.
", "smithy.api#pattern": "^(?=.{0,2048}$)(arn:aws:iam::\\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*)?[-+=,.@_a-zA-Z0-9]{1,64}$" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Running" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stopped" } } }, "traits": { "smithy.api#documentation": "The status of a resource snapshot job. Running means the job is actively running. Stopped means the job isn't running.
The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.
" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource snapshot job.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the Engagement.
" } }, "Status": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { "smithy.api#documentation": "The current status of the snapshot job.
Valid values:
STOPPED: The job is not currently running.
RUNNING: The job is actively executing.
An object that contains a Resource Snapshot Job's subset of fields.
A list of summaries of resource snapshot jobs.
" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotPayload": { "type": "union", "members": { "OpportunitySummary": { "target": "com.amazonaws.partnercentralselling#OpportunitySummaryView", "traits": { "smithy.api#documentation": "An object that contains an opportunity's subset of fields.
Provides a comprehensive view of AwsOpportunitySummaryFullView template.
" } } }, "traits": { "smithy.api#documentation": "Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.
" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotRevision": { "type": "integer", "traits": { "smithy.api#documentation": "The revision number of a resource snapshot. The first revision is 1.
", "smithy.api#range": { "min": 1 } } }, "com.amazonaws.partnercentralselling#ResourceSnapshotSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.
" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { "smithy.api#documentation": "The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.
" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { "smithy.api#documentation": "The type of resource snapshotted.
" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { "smithy.api#documentation": "The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.
" } }, "ResourceSnapshotTemplateName": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { "smithy.api#documentation": "The name of the template used to create the snapshot.
" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { "smithy.api#documentation": "The AWS account ID of the entity that owns the resource from which the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotSummaryList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotSummary" }, "traits": { "smithy.api#documentation": "A list of summaries of resource snapshots.
" } }, "com.amazonaws.partnercentralselling#ResourceTemplateName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a template that defines which data a resource snapshot includes. The name contains 3 to 80 letters or digits.
", "smithy.api#pattern": "^[a-zA-Z0-9]{3,80}$" } }, "com.amazonaws.partnercentralselling#ResourceType": { "type": "enum", "members": { "OPPORTUNITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Opportunity" } } }, "traits": { "smithy.api#documentation": "The type of a resource. The only valid value is Opportunity.
The payment type or procurement method that the customer uses to acquire the solution. You can specify Contract, Pay-as-you-go, or Subscription.
The review status of an opportunity.
" } }, "com.amazonaws.partnercentralselling#SalesActivities": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#SalesActivity" }, "traits": { "smithy.api#documentation": "A list of sales activities that the partner completed for the opportunity.
" } }, "com.amazonaws.partnercentralselling#SalesActivity": { "type": "enum", "members": { "INITIALIZED_DISCUSSIONS_WITH_CUSTOMER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Initialized discussions with customer" } }, "CUSTOMER_HAS_SHOWN_INTEREST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Customer has shown interest in solution" } }, "CONDUCTED_POC_DEMO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Conducted POC / Demo" } }, "IN_EVALUATION_PLANNING_STAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "In evaluation / planning stage" } }, "AGREED_ON_SOLUTION_TO_BUSINESS_PROBLEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Agreed on solution to Business Problem" } }, "COMPLETED_ACTION_PLAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed Action Plan" } }, "FINALIZED_DEPLOYMENT_NEEDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Finalized Deployment Need" } }, "SOW_SIGNED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOW Signed" } } }, "traits": { "smithy.api#documentation": "A sales activity that the partner completed for the opportunity.
" } }, "com.amazonaws.partnercentralselling#SalesInvolvementType": { "type": "enum", "members": { "FOR_VISIBILITY_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "For Visibility Only" } }, "CO_SELL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Co-Sell" } } }, "traits": { "smithy.api#documentation": "The type of AWS involvement in an opportunity. Valid values are For Visibility Only and Co-Sell.
The AWS account ID of the end customer's company.
", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#SearchCompanyName": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#SearchCustomerAccounts": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#SearchCustomerAccountsRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#SearchCustomerAccountsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "smithy.api#documentation": "Use SearchCustomerAccounts to find customer accounts in the specified catalog. You can filter the results by fields such as enrichment status, industry, geography, and creation date, and sort them by company name, date, or score.
Results are paginated. Use NextToken to retrieve additional results.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies a filter tree that narrows the customer accounts. Each node either combines child filters or compares a single field to a value.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#CustomerAccountSort", "traits": { "smithy.api#documentation": "Specifies the field and direction used to sort the results.
" } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single call. Use this value together with NextToken to control pagination.
Specifies the token for the next page of results. Use the NextToken value from a previous response to retrieve the next page.
Information about search customer accounts request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#SearchCustomerAccountsResponse": { "type": "structure", "members": { "CustomerAccountSummaries": { "target": "com.amazonaws.partnercentralselling#CustomerAccountSummaryList", "traits": { "smithy.api#documentation": "The customer accounts that match the request.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.partnercentralselling#NextToken", "traits": { "smithy.api#documentation": "The token to retrieve the next page of results. This value is absent when there are no more results.
" } } }, "traits": { "smithy.api#documentation": "Information about search customer accounts response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#SearchEngagementScore": { "type": "enum", "members": { "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "High" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Medium" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Low" } } }, "traits": { "smithy.api#documentation": "A score that AWS assigns to show how likely an opportunity is to succeed. Valid values are High, Medium, and Low.
Searches the engagements in AWS Partner Central that match your criteria, such as customer industry or geography. You can combine a free-text Keyword, a structured Filter tree, an engagement group (GroupId), and Sort options, and each search criterion that you specify narrows the results. Results are paginated, so use NextToken to retrieve additional results.
Specifies the catalog to search. The following values are valid:
AWS: Production.
Sandbox: Testing environments.
An optional free-text query string matched against the engagement title, description, customer company name, and member company names. When provided together with Filter or GroupId, each one narrows the result set.
A recursive, structured filter tree. Each node is either a boolean combinator (AndAllFilters, OrAllFilters, or NotFilter) or a leaf predicate (a single comparison such as EqualsTo). When provided together with Keyword or GroupId, each one narrows the result set.
The identifier of an engagement group that ListEngagementGroups returns. When you specify a group, the operation returns only the engagements that match the criteria that define the group. The group must be active and available to you in the specified catalog. Otherwise, the request fails with a ValidationException.
Specifies the field and direction used to sort the search results. If you omit this field, results are sorted by creation time, newest first.
" } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#documentation": "Specifies the maximum number of results to return in a single call. If you omit this value, the operation returns up to 20 results. Use this value to control pagination together with NextToken.
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
" } } }, "traits": { "smithy.api#documentation": "The request for the SearchEngagements operation.
An array of summaries, one for each engagement that matches the request criteria.
" } }, "NextToken": { "target": "com.amazonaws.partnercentralselling#LeadsNextToken", "traits": { "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. The response includes this token only when additional result pages are available.
" } } }, "traits": { "smithy.api#documentation": "The response from the SearchEngagements operation.
A text value that a search filter compares against.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#SearchKeyword": { "type": "string", "traits": { "smithy.api#documentation": "A word or phrase to look for in an opportunity search.
", "smithy.api#length": { "min": 1, "max": 500 }, "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#SearchOpportunities": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#SearchOpportunitiesRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#SearchOpportunitiesResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to search Opportunities on AWS Partner Central" }, "smithy.api#documentation": "The SearchOpportunities operation in the AWS Partner Central Selling API searches and filters the opportunities available to you in AWS Partner Central.
You can optionally provide a free-text Keyword, a structured Filter tree, and Sort options. The operation returns a curated summary view of each matching opportunity. If you supply both Keyword and Filter, the operation combines them with a logical AND, so each one narrows the result set.
Results are paginated. Use the NextToken parameter to retrieve additional pages of results.
Specifies the catalog in which you run the search. Use AWS to search production opportunities, or use Sandbox to search opportunities in a testing environment.
The maximum number of results to return in a single call. Use this value to control pagination together with NextToken. If you omit this parameter, the service applies a default page size and returns the remaining results on subsequent pages.
A pagination token returned by a previous call. Pass it in a subsequent call to retrieve the next page of results. Omit it on the first call.
" } }, "Keyword": { "target": "com.amazonaws.partnercentralselling#SearchKeyword", "traits": { "smithy.api#documentation": "An optional free-text query string matched against opportunity fields. When provided together with Filter, both narrow the result set.
A recursive, structured filter tree. Each node is either a boolean combinator (AndAllFilters, OrAllFilters, or NotFilter) or a leaf predicate (a single comparison such as EqualsTo). When provided together with Keyword, both narrow the result set.
Specifies the field and direction used to sort the search results.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the SearchOpportunities operation.
An array of curated summary views, one for each opportunity that matches the request criteria.
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A pagination token for retrieving the next set of results. Pass this token in a subsequent call to get the next page. The response includes this token only when additional result pages are available.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the SearchOpportunities action returns.
The sender-provided contact's email address associated with the EngagementInvitation.
The sender-provided contact's last name associated with the EngagementInvitation.
The sender-provided contact's first name associated with the EngagementInvitation.
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.
The sender-provided contact's phone number associated with the EngagementInvitation.
An object that contains the details of the sender-provided contact person for the EngagementInvitation.
The email address of an engagement invitation sender.
", "smithy.api#pattern": "^(?=.{1,80}$)[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$", "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#SenderContactList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#SenderContact" }, "traits": { "smithy.api#documentation": "A list of contacts at the sender of an engagement invitation.
", "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.partnercentralselling#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes which quota the request exceeded.
" } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.partnercentralselling#SoftwareRevenue": { "type": "structure", "members": { "DeliveryModel": { "target": "com.amazonaws.partnercentralselling#RevenueModel", "traits": { "smithy.api#documentation": "Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.
Specifies the payment value (amount and currency).
" } }, "EffectiveDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { "smithy.api#documentation": "Specifies the Opportunity's customer engagement start date for the contract's effectiveness.
Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.
" } } }, "traits": { "smithy.api#documentation": "Specifies a customer's procurement terms details. Required only for partners in eligible programs.
" } }, "com.amazonaws.partnercentralselling#Solution": { "type": "resource", "identifiers": { "Identifier": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifier" }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" } }, "list": { "target": "com.amazonaws.partnercentralselling#ListSolutions" }, "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/solution/{Identifier}" }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "relativeDocumentation": "API_ListSolutions.html" }, "smithy.api#documentation": "Represents a Solution that is listed on AWS Partner Central" } }, "com.amazonaws.partnercentralselling#SolutionArn": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a partner solution.
", "smithy.api#pattern": "^S-[0-9]{1,19}$" } }, "com.amazonaws.partnercentralselling#SolutionBase": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the solution is hosted, either AWS or Sandbox. This helps partners differentiate between live solutions and those in testing environments.
Enables the association of solutions (offerings) to opportunities.
", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.partnercentralselling#SolutionArn", "traits": { "smithy.api#documentation": "The SolutionBase structure provides essential information about a solution.
" } }, "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the solution name.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#SolutionStatus", "traits": { "smithy.api#documentation": "Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.
Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.
Indicates the solution creation date. This is useful to track and audit.
", "smithy.api#required": {} } }, "AwsMarketplaceSolutionArn": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceSolutionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Marketplace solution associated with this partner solution.
" } } }, "traits": { "smithy.api#documentation": "Specifies minimal information for the solution offered to solve the customer's business problem.
" } }, "com.amazonaws.partnercentralselling#SolutionIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a partner solution. An identifier starts with S- followed by up to 19 digits.
A list of partner solution identifiers.
" } }, "com.amazonaws.partnercentralselling#SolutionList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#SolutionBase" }, "traits": { "smithy.api#documentation": "A list of partner solutions.
" } }, "com.amazonaws.partnercentralselling#SolutionSort": { "type": "structure", "members": { "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "Specifies the sorting order, either Ascending or Descending. The default is Descending.
Specifies the attribute to sort by, such as Name, CreatedDate, or Status.
Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.
" } }, "com.amazonaws.partnercentralselling#SolutionSortName": { "type": "enum", "members": { "IDENTIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Identifier" } }, "NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Name" } }, "STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Status" } }, "CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Category" } }, "CREATEDDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedDate" } } }, "traits": { "smithy.api#documentation": "The name of the field that sorts a list of solutions.
" } }, "com.amazonaws.partnercentralselling#SolutionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Inactive" } }, "DRAFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Draft" } } }, "traits": { "smithy.api#documentation": "The status of a partner solution. Active means the solution is available, Inactive means it is no longer available, and Draft means it isn't published yet.
The name of the field that sorts a list of resource snapshot jobs. The only valid value is CreatedDate.
Specifies the field by which to sort the resource snapshot jobs.
" } }, "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { "smithy.api#documentation": "Determines the order in which the sorted results are presented.
" } } }, "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.partnercentralselling#SortOrder": { "type": "enum", "members": { "ASCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASCENDING" } }, "DESCENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESCENDING" } } }, "traits": { "smithy.api#documentation": "The direction of a sort. Valid values are ASCENDING and DESCENDING.
Sort by the customer company name.
", "smithy.api#enumValue": "COMPANY_NAME" } }, "CREATED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the date when the customer account was created.
", "smithy.api#enumValue": "CREATED_DATE" } }, "LAST_MODIFIED_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the date when the customer account was last modified.
", "smithy.api#enumValue": "LAST_MODIFIED_DATE" } }, "MARKETPLACE_ENGAGEMENT_SCORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Sort by the AWS Marketplace engagement score. Scores sort in the order High, Medium, Low, with accounts that have no score last.
Sort by the score of the recommended solution. Scores sort in the order High, Medium, Low, with accounts that have no score last.
The fields that you can sort customer accounts by.
" } }, "com.amazonaws.partnercentralselling#Stage": { "type": "enum", "members": { "PROSPECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Prospect" } }, "QUALIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Qualified" } }, "TECHNICAL_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Technical Validation" } }, "BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Business Validation" } }, "COMMITTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Committed" } }, "LAUNCHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Launched" } }, "CLOSED_LOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Closed Lost" } } }, "traits": { "smithy.api#documentation": "The stage of an opportunity in its lifecycle.
" } }, "com.amazonaws.partnercentralselling#StartCustomerAccountBulkJob": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#StartCustomerAccountBulkJobRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#StartCustomerAccountBulkJobResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "smithy.api#documentation": "Use StartCustomerAccountBulkJob to create many customer accounts from a single file. The job starts processing as soon as it is created.
Use GetCustomerAccountBulkJob to track progress, ListCustomerAccountBulkJobResults to review the outcome of each record, and GetCustomerAccountBulkJobReportUrl to download a report when the job finishes.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies a unique, case-sensitive identifier that you provide to make the request idempotent. If you retry a request with the same token, the operation returns the original job instead of starting another one.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "FileUri": { "target": "com.amazonaws.partnercentralselling#FileUri", "traits": { "smithy.api#documentation": "Specifies the location of the file that contains the customer accounts to create.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about start customer account bulk job request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#StartCustomerAccountBulkJobResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#BulkJobArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bulk job.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#JobId", "traits": { "smithy.api#documentation": "The unique identifier of the bulk job.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#BulkJobStatus", "traits": { "smithy.api#documentation": "The current status of the bulk job.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the bulk job was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about start customer account bulk job response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#StartEngagementByAcceptingInvitationTask": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#StartEngagementByAcceptingInvitationTaskRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#StartEngagementByAcceptingInvitationTaskResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "requiredActions": [ "partnercentral:CreateOpportunity", "partnercentral:SubmitOpportunity", "partnercentral:GetEngagementInvitation", "partnercentral:AcceptEngagementInvitation", "partnercentral:CreateResourceSnapshotJob", "partnercentral:StartResourceSnapshotJob" ], "documentation": "Grants permission to initiate tasks that start Engagements on AWS Partner Central by accepting an Engagement Invitation" }, "smithy.api#documentation": "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\u2019s 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.
Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.
A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { "smithy.api#documentation": "Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.
A map of the key-value pairs of the tag or tags to assign.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the StartEngagementByAcceptingInvitationTask operation.
The unique identifier of the task, used to track the task\u2019s progress.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "Indicates the current status of the task.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "Indicates the reason for task failure using an enumerated code.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The identifier of the Resource Snapshot Job created as part of this task.
" } }, "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { "smithy.api#documentation": "Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the StartEngagementByAcceptingInvitationTask action returns.
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.
Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.
", "smithy.api#required": {} } }, "AwsSubmission": { "target": "com.amazonaws.partnercentralselling#AwsSubmission", "traits": { "smithy.api#documentation": "Specifies the level of AWS involvement for the opportunity. The value includes the involvement type and the visibility of that involvement.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the StartEngagementFromOpportunityTask operation.
The unique identifier of the task, used to track the task\u2019s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "Indicates the reason for task failure using an enumerated code.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner\u2019s system.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
" } }, "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { "smithy.api#documentation": "The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the StartEngagementFromOpportunityTask action returns.
The StartOpportunityBulkJob operation creates or updates many opportunities in AWS Partner Central (Partner Central) from a single CSV file. The column headers in the file determine whether the job creates or updates opportunities.
Returns a JobId for the job. Use ListOpportunityBulkJobs to track the job, ListOpportunityBulkJobResults to review each record, and GetOpportunityBulkJobReportUrl to download a report of the failed records.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If this token matches a previous request with the same parameters, the operation returns the JobId of the original job. If you reuse the token with different parameters, the request fails with a ConflictException.
Specifies the location of the CSV file that contains the opportunities to create or update. Use one of the following:
An s3:// URI of a file that you uploaded to Partner Central for your account. You can add only the versionId query parameter.
An https:// presigned Amazon S3 URL
The file must be a plain-text CSV file no larger than 100 MB.
", "smithy.api#required": {} } }, "FileFormat": { "target": "com.amazonaws.partnercentralselling#BulkFileFormat", "traits": { "smithy.api#documentation": "Specifies the format of the input file. The only supported value is CSV.
Specifies the input file location, file format, and client token for starting an opportunity bulk job.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#StartOpportunityBulkJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.partnercentralselling#BulkJobId", "traits": { "smithy.api#documentation": "The unique identifier of the bulk job. Use it with the other opportunity bulk job operations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The response to a request to start an opportunity bulk job.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#StartOpportunityFromEngagementTask": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#StartOpportunityFromEngagementTaskRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#StartOpportunityFromEngagementTaskResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "requiredActions": [ "partnercentral:GetEngagement", "partnercentral:CreateEngagementContext", "partnercentral:CreateOpportunity", "partnercentral:CreateResourceSnapshot", "partnercentral:CreateResourceSnapshotJob", "partnercentral:StartResourceSnapshotJob" ], "documentation": "Grants permission to initiate tasks that start Opportunities from Engagements on AWS Partner Central" }, "smithy.api#documentation": "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.
", "smithy.api#http": { "method": "POST", "uri": "/StartOpportunityFromEngagementTask", "code": 200 } } }, "com.amazonaws.partnercentralselling#StartOpportunityFromEngagementTaskRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog in which the opportunity creation task is executed. Acceptable values include AWS for production and Sandbox for testing environments.
A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement from which the opportunity creation task is to be initiated. This helps ensure that the task is applied to the correct engagement.
", "smithy.api#required": {} } }, "ContextIdentifier": { "target": "com.amazonaws.partnercentralselling#ContextIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement context from which to create the opportunity. This specifies the specific contextual information within the engagement that will be used for opportunity creation.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign.
" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the StartOpportunityFromEngagementTask operation.
The unique identifier of the task, used to track the task's progress.
" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { "smithy.api#documentation": "Indicates the current status of the task.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { "smithy.api#documentation": "Indicates the reason for task failure using an enumerated code.
" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.
" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { "smithy.api#documentation": "The identifier of the resource snapshot job created as part of the opportunity creation process.
" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement from which the opportunity was created.
" } }, "ContextId": { "target": "com.amazonaws.partnercentralselling#ContextIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement context used to create the opportunity.
" } } }, "traits": { "smithy.api#documentation": "Contains the response that the StartOpportunityFromEngagementTask action returns.
Starts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use GetProspectingFromEngagementTask, or use ListProspectingFromEngagementTasks to monitor multiple tasks.
Specifies the catalog in which the task is initiated. Specify AWS for production environments and Sandbox for testing and development purposes.
The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task.
", "smithy.api#required": {} } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskName", "traits": { "smithy.api#documentation": "A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same ClientToken returns the same response without creating a duplicate task.
Represents the request structure for starting a prospecting task. Includes up to 100 engagement identifiers and a task name. Uses ClientToken to ensure idempotency.
The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
", "smithy.api#required": {} } }, "TaskName": { "target": "com.amazonaws.partnercentralselling#TaskName", "traits": { "smithy.api#documentation": "The task name from the request.
", "smithy.api#required": {} } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.
" } }, "ReasonCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
", "smithy.api#required": {} } }, "TaskId": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskIdentifier", "traits": { "smithy.api#documentation": "The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.
The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.
" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#ProspectingTaskStatus", "traits": { "smithy.api#documentation": "The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.
Starts a resource snapshot job that has been previously created.
", "smithy.api#http": { "method": "POST", "uri": "/StartResourceSnapshotJob", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#StartResourceSnapshotJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
AWS: Starts the request from the production AWS environment.
Sandbox: Starts the request from a sandbox environment used for testing or development purposes.
The identifier of the resource snapshot job to start.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the StartResourceSnapshotJob operation.
Stops a resource snapshot job. The job must be started prior to being stopped.
", "smithy.api#http": { "method": "POST", "uri": "/StopResourceSnapshotJob", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#StopResourceSnapshotJobRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
AWS: Stops the request from the production AWS environment.
Sandbox: Stops the request from a sandbox environment used for testing or development purposes.
The identifier of the job to stop.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the StopResourceSnapshotJob operation.
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.
Specifies the catalog related to the request. Valid values are:
AWS: Submits the opportunity request from the production AWS environment.
Sandbox: Submits the opportunity request from a sandbox environment used for testing or development purposes.
The identifier of the Opportunity previously created by partner and needs to be submitted.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } }, "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { "smithy.api#documentation": "Specifies the level of AWS sellers' involvement on the opportunity. Valid values:
Co-sell: Indicates the user wants to co-sell with AWS. Share the opportunity with AWS to receive deal assistance and support.
For Visibility Only: Indicates that the user does not need support from AWS Sales Rep. Share this opportunity with AWS for visibility only, you will not receive deal assistance and support.
Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:
Full: The opportunity is fully visible to AWS sales.
Limited: The opportunity has restricted visibility to AWS sales.
Contains the request parameters for the SubmitOpportunity operation.
The key in the tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.partnercentralselling#TagValue", "traits": { "smithy.api#documentation": "The value in the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The key-value pair assigned to a specified resource.
" } }, "com.amazonaws.partnercentralselling#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "The key of a tag.
", "smithy.api#pattern": "^(?=.{1,128}$)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.partnercentralselling#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#TagKey" }, "traits": { "smithy.api#documentation": "A list of tag keys.
", "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.partnercentralselling#TagList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#Tag" }, "traits": { "smithy.api#documentation": "A list of tags.
", "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.partnercentralselling#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#TagResourceRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to add new tags to a resource. Supported resources: ResourceSnapshotJob, OpportunityBulkJob" }, "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified resource.
", "smithy.api#http": { "method": "POST", "uri": "/TagResource", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.partnercentralselling#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the TagResource operation.
Contains the response of the TagResource operation. The response has no members.
The value of a tag.
", "smithy.api#pattern": "^(?=.{0,256}$)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.partnercentralselling#TaggableResourceArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a resource that you can tag.
", "smithy.api#pattern": "^(?=.{1,1000}$)arn:[\\w+=/,.@-]+:partnercentral:[\\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" } }, "com.amazonaws.partnercentralselling#TargetCloseDateFilter": { "type": "structure", "members": { "AfterTargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { "smithy.api#documentation": "Filters opportunities with a target close date after this date. Use the YYYY-MM-DD format.
Filters opportunities with a target close date before this date. Use the YYYY-MM-DD format.
Filters opportunities based on their target close date.
" } }, "com.amazonaws.partnercentralselling#TaskArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies a task.
", "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.partnercentralselling#TaskArnOrIdentifier": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) or the identifier of a task. An identifier starts with task- followed by 13 lowercase letters or digits.
The identifier of a task. An identifier starts with task- followed by 13 lowercase letters or digits.
A list of prospecting task identifiers.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.partnercentralselling#TaskIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#TaskArnOrIdentifier" }, "traits": { "smithy.api#documentation": "A list of task identifiers or Amazon Resource Names (ARNs).
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.partnercentralselling#TaskName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a prospecting task.
", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.partnercentralselling#TaskNameList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#TaskName" }, "traits": { "smithy.api#documentation": "A list of prospecting task names.
", "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.partnercentralselling#TaskStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "The status of a task. IN_PROGRESS means the task is still running, COMPLETE means it finished successfully, and FAILED means it encountered an error.
A list of task statuses.
", "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.partnercentralselling#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes why the service throttled the request.
" } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.partnercentralselling#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#UntagResourceRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a resource. Supported resources: ResourceSnapshotJob, OpportunityBulkJob" }, "smithy.api#documentation": "Removes a tag or tags from a resource.
", "smithy.api#http": { "method": "POST", "uri": "/UntagResource", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.partnercentralselling#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.partnercentralselling#TaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to untag.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.partnercentralselling#TagKeyList", "traits": { "smithy.api#documentation": "The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the UntagResource operation.
Contains the response of the UntagResource operation. The response has no members.
Use UpdateCustomerAccount to replace the customer information on an existing customer account. AWS matches the account again with the updated information.
To prevent concurrent changes from overwriting each other, specify the LastModifiedDate value that you last read for the account. If the account changed since then, the request fails with a ConflictException.
Specifies the catalog for the request. Valid values:
AWS: Production.
Sandbox: Testing environments.
Specifies the ARN or the identifier of the customer account.
", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.partnercentralselling#CustomerAccountData", "traits": { "smithy.api#documentation": "Specifies the complete, updated details of the customer. These details replace the existing details on the customer account.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Specifies your own identifier for the customer account, such as the account ID in your CRM system. Use it to correlate the customer account with your records.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "Specifies the LastModifiedDate of the customer account as you last read it. If it doesn't match the current value, the request fails with a ConflictException.
Information about update customer account request.
", "smithy.api#input": {} } }, "com.amazonaws.partnercentralselling#UpdateCustomerAccountResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.partnercentralselling#CustomerAccountArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer account.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#CustomerAccountId", "traits": { "smithy.api#documentation": "The unique identifier of the customer account.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.partnercentralselling#EnrichmentStatus", "traits": { "smithy.api#documentation": "The enrichment status of the customer account.
", "smithy.api#required": {} } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "The catalog that the customer account belongs to.
", "smithy.api#required": {} } }, "PartnerAccountIdentifier": { "target": "com.amazonaws.partnercentralselling#PartnerAccountIdentifier", "traits": { "smithy.api#documentation": "Your own identifier for the customer account, if you provided one.
" } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was created.
", "smithy.api#required": {} } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The date and time when the customer account was last modified.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about update customer account response.
", "smithy.api#output": {} } }, "com.amazonaws.partnercentralselling#UpdateEngagementContext": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#UpdateEngagementContextRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#UpdateEngagementContextResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to update engagement contexts in AWS Partner Central" }, "smithy.api#documentation": "Updates the context information for an existing engagement with new or modified data.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateEngagementContext", "code": 200 } } }, "com.amazonaws.partnercentralselling#UpdateEngagementContextPayload": { "type": "union", "members": { "Lead": { "target": "com.amazonaws.partnercentralselling#UpdateLeadContext", "traits": { "smithy.api#documentation": "Contains updated information about a lead when the context type is \"Lead\". This field is present only when updating a lead context within the engagement.
" } }, "CustomerProject": { "target": "com.amazonaws.partnercentralselling#CustomerProjectsContext", "traits": { "smithy.api#documentation": "Contains the updated details of a customer project when the context type is CustomerProject.
Contains updated prospecting result data when the context type is \"ProspectingResult\". This field includes enriched data and insights that the system generates when a partner runs an autonomous prospecting job on leads.
" } } }, "traits": { "smithy.api#documentation": "Represents the updated payload of an engagement context. The structure of this payload varies based on the context type being updated.
" } }, "com.amazonaws.partnercentralselling#UpdateEngagementContextRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { "smithy.api#documentation": "Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.
The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.
The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.
", "smithy.api#required": {} } }, "EngagementLastModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.partnercentralselling#EngagementContextType", "traits": { "smithy.api#documentation": "Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
", "smithy.api#required": {} } }, "Payload": { "target": "com.amazonaws.partnercentralselling#UpdateEngagementContextPayload", "traits": { "smithy.api#documentation": "Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the request parameters for the UpdateEngagementContext operation.
The unique identifier of the engagement that was updated.
", "smithy.api#required": {} } }, "EngagementArn": { "target": "com.amazonaws.partnercentralselling#EngagementArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated engagement.
", "smithy.api#required": {} } }, "EngagementLastModifiedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": "The timestamp when the engagement context was last modified.
", "smithy.api#required": {} } }, "ContextId": { "target": "com.amazonaws.partnercentralselling#EngagementContextIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the engagement context that was updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response that the UpdateEngagementContext action returns.
The updated qualification status of the lead.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#LeadCustomer", "traits": { "smithy.api#documentation": "Updated customer information associated with the lead.
", "smithy.api#required": {} } }, "Interaction": { "target": "com.amazonaws.partnercentralselling#LeadInteraction", "traits": { "smithy.api#documentation": "Updated interaction details for the lead context.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#LeadInsights", "traits": { "smithy.api#documentation": "Insights that AI generates and associates with the lead. These insights provide automated analysis to help partners assess the lead quality and readiness.
" } } }, "traits": { "smithy.api#documentation": "Updates the context information for a lead with qualification status, customer details, and interaction data.
" } }, "com.amazonaws.partnercentralselling#UpdateOpportunity": { "type": "operation", "input": { "target": "com.amazonaws.partnercentralselling#UpdateOpportunityRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#UpdateOpportunityResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, { "target": "com.amazonaws.partnercentralselling#ConflictException" }, { "target": "com.amazonaws.partnercentralselling#InternalServerException" }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, { "target": "com.amazonaws.partnercentralselling#ThrottlingException" }, { "target": "com.amazonaws.partnercentralselling#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "partnercentral:Catalog" ], "aws.iam#iamAction": { "documentation": "Grants permission to update Opportunities on AWS Partner Central" }, "smithy.api#documentation": "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.
Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.
Identifies the type of support the partner needs from Amazon Web Services.
Valid values:
Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.
Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.
Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.
Cosell\u2014Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).
Cosell\u2014Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.
Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.
Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).
Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.
Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.
", "smithy.api#pattern": "^(?s).{0,64}$" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { "smithy.api#documentation": "Specifies details of the customer associated with the Opportunity.
An object that contains project details summary for the Opportunity.
Specifies the opportunity type as a renewal, new, or expansion.
Opportunity types:
New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.
Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.
Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.
An object that contains marketing details for the Opportunity.
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { "smithy.api#documentation": " DateTime when the opportunity was last modified.
Read-only, system generated Opportunity unique identifier.
An object that contains lifecycle details for the Opportunity.
Contains the request parameters for the UpdateOpportunity operation.
Read-only, system generated Opportunity unique identifier.
DateTime when the opportunity was last modified.
Contains the response that the UpdateOpportunity action returns.
A list of the use cases that the marketing activity addresses.
" } }, "com.amazonaws.partnercentralselling#UtcTimeOfDay": { "type": "string", "traits": { "smithy.api#documentation": "UTC time of day in strict zero-padded 24-hour HH:mm format.", "smithy.api#length": { "min": 5, "max": 5 }, "smithy.api#pattern": "^(?:[01][0-9]|2[0-3]):[0-5][0-9]$" } }, "com.amazonaws.partnercentralselling#ValidationException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the validation error.
", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.partnercentralselling#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The primary reason for this validation exception to occur.
REQUEST_VALIDATION_FAILED: The request format is not valid.
Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
BUSINESS_VALIDATION_FAILED: The requested change doesn't pass the business validation rules.
Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
A list of issues that were discovered in the submitted request or the resource state.
" } } }, "traits": { "smithy.api#documentation": "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.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.partnercentralselling#ValidationExceptionError": { "type": "structure", "members": { "FieldName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the field name with the invalid value.
" } }, "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies the detailed error message for the invalid field value.
", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.partnercentralselling#ValidationExceptionErrorCode", "traits": { "smithy.api#documentation": "Specifies the error code for the invalid field value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "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.
The code that identifies the type of validation error.
" } }, "com.amazonaws.partnercentralselling#ValidationExceptionErrorList": { "type": "list", "member": { "target": "com.amazonaws.partnercentralselling#ValidationExceptionError" }, "traits": { "smithy.api#documentation": "A list of validation errors.
" } }, "com.amazonaws.partnercentralselling#ValidationExceptionReason": { "type": "enum", "members": { "REQUEST_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST_VALIDATION_FAILED" } }, "BUSINESS_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUSINESS_VALIDATION_FAILED" } } }, "traits": { "smithy.api#documentation": "The reason that a request failed validation. Valid values are REQUEST_VALIDATION_FAILED and BUSINESS_VALIDATION_FAILED.
Controls how much of the AWS involvement in an opportunity the partner can see. Valid values are Full and Limited.
A website URL.
", "smithy.api#pattern": "^(?s).{4,255}$", "smithy.api#sensitive": {} } } } }