\n AWS Partner Central API for Selling Reference Guide\n
\nThis Amazon Web Services (AWS) Partner Central API reference is\n designed to help AWS\n Partners integrate Customer Relationship Management (CRM)\n systems with AWS Partner Central. Partners can automate interactions with\n AWS Partner Central, which helps to ensure effective engagements in joint\n business activities.
\nThe API provides standard AWS API functionality. Access it by\n either using API Actions or by using an AWS SDK that's tailored to your\n programming language or platform. For more information, see Getting Started with\n AWS and Tools to Build on AWS.
\n\n Features offered by AWS Partner Central API\n
\n\n Opportunity management:\n Manages coselling opportunities through API actions such as\n CreateOpportunity, UpdateOpportunity,\n ListOpportunities, GetOpportunity, and\n AssignOpportunity.
\n AWS referral management:\n Manages referrals shared by AWS using actions such as\n ListEngagementInvitations,\n GetEngagementInvitation,\n StartEngagementByAcceptingInvitation, and\n RejectEngagementInvitation.
\n Entity association:\n Associates related entities such as AWS Products,\n Partner Solutions, and AWS\n Marketplace Private Offers with opportunities using the\n actions AssociateOpportunity, and\n DisassociateOpportunity.
\n View AWS opportunity\n details: Retrieves real-time summaries of AWS\n opportunities using the GetAWSOpportunitySummary\n action.
\n List solutions: Provides\n list APIs for listing partner offers using\n ListSolutions.
\n Event subscription:\n Subscribe to real-time opportunity updates through AWS EventBridge by\n using actions such as Opportunity Created,\n Opportunity Updated, Engagement\n Invitation Accepted, Engagement Invitation\n Rejected, and Engagement Invitation\n Created.
\n\n AWS Partner Central API for Selling Reference\n Guide\n
\nThis Amazon Web Services (AWS) Partner Central API reference is designed to help\n AWS Partners integrate\n Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can\n automate interactions with AWS Partner Central, which helps to ensure effective\n engagements in joint business activities.
\nThe 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\n or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.
\n\n Features offered by AWS Partner Central API\n
\n\n Opportunity management: Manages coselling\n opportunities through API actions such as CreateOpportunity,\n UpdateOpportunity, ListOpportunities,\n GetOpportunity, and AssignOpportunity.
\n AWS referral management: Manages referrals\n shared by AWS using actions such as ListEngagementInvitations,\n GetEngagementInvitation,\n StartEngagementByAcceptingInvitation, and\n RejectEngagementInvitation.
\n Entity association: Associates related\n entities such as AWS Products, Partner\n Solutions, and AWS Marketplace Private\n Offers with opportunities using the actions\n AssociateOpportunity, and\n DisassociateOpportunity.
\n View AWS opportunity details: Retrieves\n real-time summaries of AWS opportunities using the\n GetAWSOpportunitySummary action.
\n List solutions: Provides list APIs for\n listing partner offers using ListSolutions.
\n Event subscription: Subscribe to real-time\n opportunity updates through AWS EventBridge by using actions such as\n Opportunity Created, Opportunity\n Updated, Engagement Invitation Accepted,\n Engagement Invitation Rejected, and\n Engagement Invitation Created.
\n\n Use the AcceptEngagementInvitation action to accept an engagement invitation shared by AWS. \n Accepting the invitation indicates your willingness to participate in the engagement, \n granting you access to all engagement-related data.\n
\n The CatalogType parameter specifies the catalog associated with the engagement invitation. \n Accepted values are AWS and Sandbox, \n which determine the environment in which the engagement invitation is managed.\n
\n The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique \n identifier of the EngagementInvitation to be accepted. \n Providing the correct identifier ensures that the intended invitation is accepted.\n
This error occurs when you don't have permission to perform the\n requested action.\n
\nYou don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.\n
", + "smithy.api#documentation": "This error occurs when you don't have permission to perform the requested\n action.
\nYou don’t have access to this action or resource. Review IAM policies or contact your\n AWS administrator for assistance.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -413,13 +487,13 @@ "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.\n
Specifies the industry the end Customer belongs to that's associated with\n the Opportunity. It refers to the category or sector where the customer's\n 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.\n
Specifies the end Customer's industry associated with the\n Opportunity, when the selected value in the Industry field\n is Other.
Specifies the end Customer's company name associated with the Opportunity.\n
Specifies the end Customer's company name associated with the\n Opportunity.
\n 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.\n
Specifies the end customer's company website URL associated with the\n Opportunity. This value is crucial to map the customer within the\n Amazon Web Services CRM system. This field is required in all cases except when the\n opportunity is related to national security.
Specifies the Customer Amazon Web Services account ID associated with the Opportunity.\n
Specifies the Customer\n Amazon Web Services account ID associated with the Opportunity.
Specifies the end Customer's address details associated with the Opportunity.\n
Specifies the end Customer's address details associated with the\n Opportunity.
Indicates the Customer DUNS number, if available.\n
Indicates the Customer DUNS number, if available.
Specifies the Customer's account details associated with the Opportunity.\n
Specifies the Customer's account details associated with the\n Opportunity.
Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
" + "smithy.api#documentation": "Represents the alias of the partner account receiving the Engagement Invitation,\n 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#documentation": "Indicates the AWS account ID of the partner who received the Engagement Invitation.\n 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.
" + "smithy.api#documentation": "Contains the account details of the partner who received the Engagement Invitation,\n including the AWS account ID and company name.
" } }, "com.amazonaws.partnercentralselling#AccountSummary": { @@ -491,13 +565,13 @@ "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { - "smithy.api#documentation": "Specifies which industry the end Customer belongs to associated with the Opportunity.\n It refers to the category or sector that the customer's business operates in.\n
To submit a value outside the picklist, use\n Other.\n
Conditionally mandatory if Other is selected for Industry Vertical in LOVs.\n
Specifies which industry the end Customer belongs to associated with the\n Opportunity. It refers to the category or sector that the customer's\n business operates in.
To submit a value outside the picklist, use Other.
Conditionally mandatory if Other is selected for Industry Vertical in\n LOVs.
Specifies the end Customer's industry associated with the \n Opportunity, when the selected value in the Industry field is Other. This field is relevant\n when the customer's industry doesn't fall under the predefined picklist values and requires a custom\n description.\n
Specifies the end Customer's industry associated with the \n Opportunity, when the selected value in the Industry field is\n Other. This field is relevant when the customer's industry doesn't fall\n under the predefined picklist values and requires a custom description.
Specifies the end Customer's company name associated with the Opportunity.\n
Specifies the end Customer's company name associated with the\n Opportunity.
Specifies the end customer's company website URL associated with the Opportunity. This\n value is crucial to map the customer within the Amazon Web Services CRM system.\n
Specifies the end customer's company website URL associated with the\n Opportunity. This value is crucial to map the customer within the\n Amazon Web Services CRM system.
Specifies the end Customer's address details associated with the Opportunity.\n
Specifies the end Customer's address details associated with the\n Opportunity.
An object that contains an Account's subset of fields.\n
An object that contains an Account's subset of fields.
Specifies the end Customer's city associated with the Opportunity.\n
Specifies the end Customer's city associated with the\n Opportunity.
Specifies the end Customer's postal code associated with the Opportunity.\n
Specifies the end Customer's postal code associated with the\n Opportunity.
Specifies the end Customer's state or region associated with the Opportunity.\n
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\n
Specifies the end Customer's state or region associated with the\n Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas |\n California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated\n States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois |\n Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland\n | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska\n | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina |\n North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau |\n Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota |\n Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West\n Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP\n
Specifies the end Customer's country associated with the Opportunity.\n
Specifies the end Customer's country associated with the\n Opportunity.
Specifies the end Customer's street address associated with the Opportunity.\n
Specifies the end Customer's street address associated with the\n Opportunity.
Specifies the end Customer's address details associated with the Opportunity.\n
Specifies the end Customer's address details associated with the\n Opportunity.
Specifies the end Customer's city associated with the Opportunity.\n
Specifies the end Customer's city associated with the\n Opportunity.
Specifies the end Customer's postal code associated with the Opportunity.\n
Specifies the end Customer's postal code associated with the\n Opportunity.
Specifies the end Customer's state or region associated with the Opportunity.\n
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\n
Specifies the end Customer's state or region associated with the\n Opportunity.
Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas |\n California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated\n States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois |\n Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland\n | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska\n | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina |\n North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau |\n Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota |\n Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West\n Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP\n
Specifies the end Customer's country associated with the Opportunity.\n
Specifies the end Customer's country associated with the\n Opportunity.
An object that contains an Address object's subset of fields.\n
An object that contains an Address object's subset of fields.
\n Enables you to reassign an existing Opportunity to another user within your\n Partner Central account. The specified user receives the opportunity, and it appears on their\n Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.\n
\n This is useful for distributing opportunities to the appropriate team members\n 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.\n
", + "smithy.api#documentation": "Enables you to reassign an existing Opportunity to another user within\n your Partner Central account. The specified user receives the opportunity, and it\n appears on their Partner Central dashboard, allowing them to take necessary actions or\n proceed with the opportunity.
This is useful for distributing opportunities to the appropriate team members or\n departments within your organization, ensuring that each opportunity is handled by the\n right person. By default, the opportunity owner is the one who creates it. Currently,\n there's no API to enumerate the list of available users.
", "smithy.api#http": { "method": "POST", "uri": "/AssignOpportunity", @@ -683,14 +757,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is assigned in. Use AWS to assign real\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.
\n Requires the Opportunity's unique identifier when you want to\n assign it to another user. Provide the correct identifier so the intended opportunity is\n reassigned.\n
Requires the Opportunity's unique identifier when you want to assign it\n to another user. Provide the correct identifier so the intended opportunity is\n 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#documentation": "Specifies the user or team member responsible for managing the assigned opportunity.\n This field identifies the Assignee based on the partner's internal\n team structure. Ensure that the email address is associated with a registered user in\n your Partner Central account.
", "smithy.api#required": {} } } @@ -713,14 +787,14 @@ "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { - "smithy.api#documentation": "Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.
", + "smithy.api#documentation": "Provides the email address of the assignee. This email is used for communications and\n 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#documentation": "Specifies the first name of the assignee managing the opportunity. The system\n automatically retrieves this value from the user profile by referencing the associated\n email address.
", "smithy.api#length": { "max": 80 }, @@ -730,7 +804,7 @@ "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#documentation": "Specifies the last name of the assignee managing the opportunity. The system\n automatically retrieves this value from the user profile by referencing the associated\n email address.
", "smithy.api#length": { "max": 80 }, @@ -740,13 +814,13 @@ "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.
Specifies the business title of the assignee managing the opportunity. This helps\n clarify the individual's role and responsibilities within the organization. Use the\n value PartnerAccountManager to update details of the opportunity\n 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.
" + "smithy.api#documentation": "Represents the contact details of the individual assigned to manage the opportunity\n within the partner organization. This helps to ensure that there is a point of contact\n for the opportunity's progress.
" } }, "com.amazonaws.partnercentralselling#AssociateOpportunity": { @@ -782,7 +856,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to associate Opportunities on AWS Partner Central with other entities" }, - "smithy.api#documentation": "\n Enables you to create a formal association between an Opportunity and various\n related entities, enriching the context and details of the opportunity for better collaboration and\n decision making. You can associate an opportunity with the following entity types:\n
\n Partner Solution:\n A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.\n
\n\n Amazon Web Services Products:\n 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.\n
\n\n Amazon Web Services Marketplace private offer:\n 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.\n
\nTo obtain identifiers for these entities, use the following methods:
\nSolution: Use the ListSolutions operation.
\n AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.\n
\n\n 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.\n
Enables you to create a formal association between an Opportunity and\n various related entities, enriching the context and details of the opportunity for\n better collaboration and decision making. You can associate an opportunity with the\n following entity types:
Partner Solution: A software product or consulting practice created and\n delivered by Partners. Partner Solutions help customers address\n business challenges using Amazon Web Services services.
\nAmazon Web Services Products: Amazon Web Services offers many products and\n services that provide scalable, reliable, and cost-effective infrastructure\n solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products.
\nAmazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend\n custom pricing and terms to individual Amazon Web Services customers. Sellers can\n negotiate custom prices, payment schedules, and end user license terms through\n private offers, enabling Amazon Web Services customers to acquire software\n solutions tailored to their specific needs. For more information, see Private offers\n in Amazon Web Services Marketplace.
\nTo obtain identifiers for these entities, use the following methods:
\nSolution: Use the ListSolutions operation.
AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.
\nAmazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the\n ListEntities operation to retrieve a list of private offers.\n The request returns the details of available private offers. For more\n information, see ListEntities.
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity association is made in. Use AWS to\n associate opportunities in the Amazon Web Services catalog, and Sandbox for\n testing in secure, isolated environments.
Requires the Opportunity's unique identifier when you want to\n associate it with a related entity. Provide the correct identifier so the intended opportunity is\n updated with the association.\n
Requires the Opportunity's unique identifier when you want to associate\n it with a related entity. Provide the correct identifier so the intended opportunity is\n updated with the association.
Specifies the entity type that you're associating with the \n Opportunity. This helps to categorize and properly process the association.\n
Specifies the entity type that you're associating with the Opportunity.\n This helps to categorize and properly process the association.
Requires the related entity's unique identifier when you want to associate it with the \n Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the \n Amazon Web Services Marketplace API to obtain the ARN.\n
Requires the related entity's unique identifier when you want to associate it with the\n Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon\n Resource Name (ARN). Use the \n Amazon Web Services Marketplace API to obtain the ARN.
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.
" + "smithy.api#documentation": "Provides a list of customer contacts involved in the opportunity. These contacts may\n include decision makers, influencers, and other stakeholders within the customer's\n 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.
" + "smithy.api#documentation": "Represents the customer associated with the AWS opportunity. This field captures key\n details about the customer that are necessary for managing the opportunity.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityInsights": { @@ -1228,18 +1319,18 @@ "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.
" + "smithy.api#documentation": "Provides recommendations from AWS on the next best actions to take in order to move\n 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.
" + "smithy.api#documentation": "Represents a score assigned by AWS to indicate the level of engagement and potential\n success for the opportunity. This score helps partners prioritize their efforts.
" } } }, "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.
" + "smithy.api#documentation": "Contains insights provided by AWS for the opportunity, offering recommendations and\n analysis that can help the partner optimize their engagement and strategy.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityLifeCycle": { @@ -1248,25 +1339,25 @@ "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.
" + "smithy.api#documentation": "Indicates the expected date by which the opportunity is projected to close. This field\n 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.
Indicates the reason why an opportunity was marked as Closed Lost. This\n helps in understanding the context behind the lost opportunity and aids in refining\n 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.
Represents the current stage of the opportunity in its lifecycle, such as\n Qualification, Validation, or Closed Won.\n 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#documentation": "Specifies the immediate next steps required to progress the opportunity. These steps\n are based on AWS guidance and the current stage of the opportunity.
", "smithy.api#length": { "max": 255 } @@ -1275,7 +1366,7 @@ "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#documentation": "Provides a historical log of previous next steps that were taken to move the\n opportunity forward. This helps in tracking the decision-making process and identifying\n any delays or obstacles encountered.
", "smithy.api#length": { "max": 50 } @@ -1283,7 +1374,7 @@ } }, "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.
" + "smithy.api#documentation": "Tracks the lifecycle of the AWS opportunity, including stages such as qualification,\n validation, and closure. This field helps partners understand the current status and\n progression of the opportunity.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityProject": { @@ -1292,12 +1383,12 @@ "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’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.
" + "smithy.api#documentation": "Indicates the expected spending by the customer over the course of the project. This\n value helps partners and AWS estimate the financial impact of the opportunity. Use the\n AWS Pricing Calculator to create an\n estimate of the customer’s total spend. If only annual recurring revenue (ARR) is\n available, distribute it across 12 months to provide an average monthly value.
" } } }, "traits": { - "smithy.api#documentation": "Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.
" + "smithy.api#documentation": "Captures details about the project associated with the opportunity, including\n objectives, scope, and customer requirements.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityRelatedEntities": { @@ -1306,18 +1397,18 @@ "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.
" + "smithy.api#documentation": "Specifies the AWS products associated with the opportunity. This field helps track the\n 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.
" + "smithy.api#documentation": "Specifies the partner solutions related to the opportunity. These solutions represent\n the partner's offerings that are being positioned as part of the overall AWS\n 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.
" + "smithy.api#documentation": "Represents other entities related to the AWS opportunity, such as AWS products,\n partner solutions, and marketplace offers. These associations help build a complete\n picture of the solution being sold.
" } }, "com.amazonaws.partnercentralselling#AwsOpportunityStage": { @@ -1490,19 +1581,19 @@ "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#documentation": "Specifies the type of AWS involvement in the opportunity, such as coselling, deal\n support, or technical consultation. This helps categorize the nature of AWS\n 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.
Determines who can view AWS involvement in the opportunity. Typically, this field is\n set to Full for most cases, but it may be restricted based on special\n 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.
" + "smithy.api#documentation": "Indicates the level of AWS involvement in the opportunity. This field helps track AWS\n participation throughout the engagement, such as providing technical support, deal\n assistance, and sales support.
" } }, "com.amazonaws.partnercentralselling#AwsTeamMember": { @@ -1511,13 +1602,13 @@ "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { - "smithy.api#documentation": "\n Provides the Amazon Web Services team member's email address.\n
" + "smithy.api#documentation": "Provides the Amazon Web Services team member's email address.
" } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "\n Provides the Amazon Web Services team member's first name.\n
", + "smithy.api#documentation": "Provides the Amazon Web Services team member's first name.
", "smithy.api#length": { "max": 80 } @@ -1526,7 +1617,7 @@ "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "\n Provides the Amazon Web Services team member's last name.\n
", + "smithy.api#documentation": "Provides the Amazon Web Services team member's last name.
", "smithy.api#length": { "max": 80 } @@ -1535,12 +1626,12 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#AwsMemberBusinessTitle", "traits": { - "smithy.api#documentation": "\n Specifies the Amazon Web Services team member's business title and indicates their organizational role.\n
" + "smithy.api#documentation": "Specifies the Amazon Web Services team member's business title and indicates their\n organizational role.
" } } }, "traits": { - "smithy.api#documentation": "\n Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.\n
" + "smithy.api#documentation": "Represents an Amazon Web Services team member for the engagement. This structure\n includes details such as name, email, and business title.
" } }, "com.amazonaws.partnercentralselling#CatalogIdentifier": { @@ -1863,7 +1954,7 @@ } }, "traits": { - "smithy.api#documentation": "This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.\n
\nSuggested action: Fetch the latest state of the resource, verify the state, and retry the request.\n
", + "smithy.api#documentation": "This error occurs when the request can’t be processed due to a conflict with the\n target resource's current state, which could result from updating or deleting the\n resource.
\nSuggested action: Fetch the latest state of the resource, verify the state, and retry\n the request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1874,13 +1965,13 @@ "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { - "smithy.api#documentation": "The contact's email address associated with the Opportunity.\n
The contact's email address associated with the Opportunity.
The contact's first name associated with the Opportunity.\n
The contact's first name associated with the Opportunity.
The contact's last name associated with the Opportunity.\n
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.\n
The partner contact's title (job title or role) associated with the\n Opportunity. BusinessTitle supports either\n PartnerAccountManager or OpportunityOwner.
The contact's phone number associated with the Opportunity.\n
The contact's phone number associated with the Opportunity.
An object that contains a Customer Partner's contact details.\n
An object that contains a Customer Partner's contact details.
\n The CreateEngagement action allows you to create an Engagement, \n which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. \n This action automatically adds the caller's AWS account as an active member of the newly created Engagement.\n
\nThis action creates an invitation from a sender to a single receiver to join an engagement.\n
", + "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": "\n Specifies the catalog related to the engagement. \n Accepted values are AWS and Sandbox, \n which determine the environment in which the engagement is managed.\n
\n Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. \n This token helps prevent duplicate invitation creations.\n
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the Engagement associated with the invitation. \n This parameter ensures the invitation is created within the correct Engagement context.\n
\nThe Invitation object all information necessary to initiate an engagement invitation to a partner. \nIt contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can \nbe the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer \ninformation, and project details.
\n Unique identifier assigned to the newly created engagement invitation.\n
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) that uniquely identifies the engagement\n invitation.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#CreateEngagementRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "\n The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. \n Accepted values are AWS and Sandbox, \n which determine the environment in which the engagement is managed.\n
\n The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. \n The value must not exceed sixty-four alphanumeric characters.\n
\nSpecifies the title of the Engagement.\n
\nProvides a description of the Engagement.\n
\n The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, \n specifying detailed information about customer projects associated with the Engagement. \n Each context object contains a Type field indicating the context type, \n 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, \n facilitating effective collaboration between parties by providing relevant customer and project information.\n
\nUnique identifier assigned to the newly created engagement.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#EngagementArn", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Name (ARN) that identifies the engagement.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.partnercentralselling#CreateOpportunity": { "type": "operation", "input": { @@ -3449,7 +3751,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create new Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "\n Creates an Opportunity record in Partner Central. Use this operation to create\n a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to\n Pending Submission.\n
\n To submit an opportunity, follow these steps:\n
\nTo create the opportunity, use CreateOpportunity.
To associate a solution with the opportunity, use AssociateOpportunity.
To submit the opportunity, use StartEngagementFromOpportunityTask.
\n After submission, you can't edit the opportunity until the review is complete. But opportunities in the\n Pending Submission state must have complete details. You can update\n the opportunity while it's in the Pending Submission state.\n
\n There's a set of mandatory fields to create opportunities, but consider providing optional fields to\n enrich the opportunity record.\n
", + "smithy.api#documentation": "Creates an Opportunity record in Partner Central. Use this operation to\n create a potential business opportunity for submission to Amazon Web Services. Creating\n an opportunity sets Lifecycle.ReviewStatus to Pending\n Submission.
To submit an opportunity, follow these steps:
\nTo create the opportunity, use CreateOpportunity.
To associate a solution with the opportunity, use\n AssociateOpportunity.
To submit the opportunity, use\n StartEngagementFromOpportunityTask.
After submission, you can't edit the opportunity until the review is complete. But\n opportunities in the Pending Submission state must have complete details.\n You can update the opportunity while it's in the Pending Submission\n state.
There's a set of mandatory fields to create opportunities, but consider providing\n optional fields to enrich the opportunity record.
", "smithy.api#http": { "method": "POST", "uri": "/CreateOpportunity", @@ -3464,26 +3766,26 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is created in. Use AWS to create opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is created in. Use AWS to create\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).\n
\n\n Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity.\n
\nIdentifies the type of support the partner needs from Amazon Web Services.
\nValid values:
\nCosell—Architectural Validation: Confirmation from Amazon Web Services that the\n partner's proposed solution architecture is aligned with Amazon Web Services best\n practices and poses minimal architectural risks.
\nCosell—Business Presentation: Request Amazon Web Services seller's\n participation in a joint customer presentation.
\nCosell—Competitive Information: Access to Amazon Web Services competitive\n resources and support for the partner's proposed solution.
\nCosell—Pricing Assistance: Connect with an Amazon Web Services seller for\n support situations where a partner may be receiving an upfront discount on a\n service (for example: EDP deals).
\nCosell—Technical Consultation: Connect with an Amazon Web Services Solutions\n Architect to address the partner's questions about the proposed solution.
\nCosell—Total Cost of Ownership Evaluation: Assistance with quoting different\n cost savings of proposed solutions on Amazon Web Services versus on-premises or a\n traditional hosting environment.
\nCosell—Deal Support: Request Amazon Web Services seller's support to progress\n the opportunity (for example: joint customer call, strategic\n positioning).
\nCosell—Support for Public Tender/RFx: Opportunity related to the public sector\n where the partner needs Amazon Web Services RFx support.
\nDo Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need\n support from an Amazon Web Services sales representative, and the partner solely\n manages the opportunity. It's possible to request coselling support on these\n opportunities at any stage during their lifecycles. This is also known as a\n for-visibility-only (FVO) opportunity.
\nIndicates 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.
Indicates whether the Opportunity pertains to a national security\n project. This field must be set to true only when the customer's industry\n is Government. Additional privacy and security measures apply\n during the review and management process for opportunities marked as\n NationalSecurity.
\n Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential\n to track and reconcile because it's included in the outbound payload to the partner.\n
\n\n 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.\n
", + "smithy.api#documentation": "Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload to the\n partner.
\nThis field allows partners to link an opportunity to their CRM, which helps to ensure\n seamless integration and accurate synchronization between the Partner Central API and\n the partner's internal systems.
", "smithy.api#length": { "max": 64 } @@ -3492,19 +3794,19 @@ "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { - "smithy.api#documentation": "Specifies customer details associated with the Opportunity.\n
Specifies customer details associated with the Opportunity.
An object that contains project details for the\n Opportunity.\n
An object that contains project details for the Opportunity.
\n Specifies the opportunity type as a renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.\n
\n\n Expansion opportunity:\n 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.\n
\nSpecifies the opportunity type as a renewal, new, or expansion.
\nOpportunity types:
\nNew opportunity: Represents a new business opportunity with a potential\n customer that's not previously engaged with your solutions or services.
\nRenewal opportunity: Represents an opportunity to renew an existing contract\n or subscription with a current customer, ensuring continuity of service.
\nExpansion opportunity: Represents an opportunity to expand the scope of an\n existing contract or subscription, either by adding new services or increasing\n the volume of existing services for a current customer.
\nSpecifies details of a customer's procurement terms. This is required only for partners in eligible programs.
" + "smithy.api#documentation": "Specifies details of a customer's procurement terms. This is required only for\n partners in eligible programs.
" } }, "ClientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.\n
\n\n Default: None\n
\n\n 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.\"\n
Required to be unique, and should be unchanging, it can be randomly generated or a\n meaningful string.
\nDefault: None
\nBest practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique\n Identifier (UUID) as the ClientToken. You can use standard libraries from\n most programming languages to generate this. If you use the same client token, the API\n returns the following error: \"Conflicting client token submitted for a new request\n body.\"
An object that contains lifecycle details for the Opportunity.\n
An object that contains lifecycle details for the Opportunity.
\n Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner.\n For all opportunities created with Catalog: AWS, this field must only be Partner Referral.\n However, when using Catalog: Sandbox, you can set this field to AWS Referral\n to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.\n
Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog:\n AWS, this field must only be Partner Referral. However, when\n using Catalog: Sandbox, you can set this field to AWS Referral\n 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.
" + "smithy.api#documentation": "Represents the internal team handling the opportunity. Specify collaborating members\n of this opportunity who are within the partner's organization.
" } } }, @@ -3559,20 +3861,20 @@ "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "\n 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.\n
Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity\n actions, such as updates, associations, and submissions. It helps to ensure that each\n opportunity is accurately tracked and managed.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to\n track and reconcile because it's included in the outbound payload sent back to the partner.\n
" + "smithy.api#documentation": "Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "\n DateTime\n when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.\n
\n DateTime when the opportunity was last modified. When the\n Opportunity is created, its value is CreatedDate.
\n This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, \n within the context of an engagement. \n 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#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.partnercentralselling#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.partnercentralselling#ThrottlingException" + }, + { + "target": "com.amazonaws.partnercentralselling#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to creating resource snapshot jobs in AWS Partner Central" + }, + "smithy.api#documentation": "\n Use this action to create a job to generate a snapshot of the specified resource\n within an engagement. It initiates an asynchronous process to create a resource\n snapshot. The job creates a new snapshot only if the resource state has changed,\n adhering to the same access control and immutability rules as direct snapshot creation.\n
", + "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": "\n Specifies the catalog in which to create the snapshot job. Valid values are\n AWS and Sandbox.\n
\n Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. \n This token helps prevent duplicate snapshot job creations.\n
", + "smithy.api#idempotencyToken": {}, + "smithy.api#pattern": "^[!-~]{1,64}$", + "smithy.api#required": {} + } + }, + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n Specifies the identifier of the engagement associated with the resource to be\n snapshotted.\n
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", + "traits": { + "smithy.api#documentation": "\n The type of resource for which the snapshot job is being created. Must be one of the\n supported resource types Opportunity.\n
\n Specifies the identifier of the specific resource to be snapshotted. The format\n depends on the ResourceType.\n
\n Specifies the name of the template that defines the schema for the snapshot.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#CreateResourceSnapshotJobResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier for the created snapshot job.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the created snapshot job.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#CreateResourceSnapshotRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "\n Specifies the catalog where the snapshot is created. Valid values are\n AWS and Sandbox.\n
\n The unique identifier of the engagement associated with this snapshot. This field\n links the snapshot to a specific engagement context.\n
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", + "traits": { + "smithy.api#documentation": "\n Specifies the type of resource for which the snapshot is being created. This field\n determines the structure and content of the snapshot. Must be one of the supported\n resource types, such as: Opportunity.\n
\n The unique identifier of the specific resource to be snapshotted. The format and\n constraints of this identifier depend on the ResourceType specified. For example: For\n Opportunity type, it will be an opportunity ID.\n
\n The name of the template that defines the schema for the snapshot. This template\n determines which subset of the resource data will be included in the snapshot. Must\n correspond to an existing and valid template for the specified ResourceType.\n
\n Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. \n This token helps prevent duplicate snapshot creations.\n
", + "smithy.api#idempotencyToken": {}, + "smithy.api#pattern": "^[!-~]{1,64}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#CreateResourceSnapshotResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.partnercentralselling#ResourceArn", + "traits": { + "smithy.api#documentation": "\n Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot\n created.\n
" + } + }, + "Revision": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", + "traits": { + "smithy.api#documentation": "\n Specifies the revision number of the created snapshot. This field provides important\n information about the snapshot's place in the sequence of snapshots for the given\n resource.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#CurrencyCode": { + "type": "enum", + "members": { + "USD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USD" } }, "EUR": { @@ -4608,12 +5139,12 @@ "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.
Represents the contact details for individuals associated with the customer of the\n Opportunity. This field captures relevant contacts, including\n decision-makers, influencers, and technical stakeholders within the customer\n organization. These contacts are key to progressing the opportunity.
An object that contains the customer's Account and Contact.\n
An object that contains the customer's Account and\n Contact.
\n Information about the customer project associated with the Engagement.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The CustomerProjects structure in Engagements offers a flexible framework for managing\n customer-project relationships. It supports multiple customers per Engagement and\n multiple projects per customer, while also allowing for customers without projects and\n projects without specific customers.\n
\nAll Engagement members have full visibility of customers and their associated\n projects, enabling the capture of relevant context even when project details are not\n fully defined. This structure also facilitates targeted invitations, allowing partners\n to focus on specific customers and their business problems when sending Engagement\n invitations.
" + } + }, "com.amazonaws.partnercentralselling#CustomerSummary": { "type": "structure", "members": { @@ -4633,7 +5181,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that contains a Customer object's subset of fields.\n
An object that contains a Customer object's subset of fields.
\n Use this action to deletes a previously created resource snapshot job. The job must be\n in a stopped state before it can be deleted.\n
", + "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": "\n Specifies the catalog from which to delete the snapshot job. Valid values are\n AWS and Sandbox. \n
\n The unique identifier of the resource snapshot job to be deleted.\n
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Identifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.partnercentralselling#DeliveryModel": { "type": "enum", "members": { @@ -4728,7 +5334,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to disassociate Opportunities on AWS Partner Central from other entities" }, - "smithy.api#documentation": "\n 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.\n This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage\n associations as business needs change.\n
\n Use this operation to update the associations of an Opportunity due to changes in the related entities,\n or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track\n and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the\n one to be removed, especially if it's the last remaining entity that's required.\n
Allows you to remove an existing association between an Opportunity and\n related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to\n AssociateOpportunity, and it provides flexibility to manage\n associations as business needs change.
Use this operation to update the associations of an Opportunity due to\n changes in the related entities, or if an association was made in error. Ensuring\n accurate associations helps maintain clarity and accuracy to track and manage business\n opportunities. When you replace an entity, first attach the new entity and then\n disassociate the one to be removed, especially if it's the last remaining entity that's\n required.
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog,\n and Sandbox for testing in secure, isolated environments.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity disassociation is made in. Use AWS to\n disassociate opportunities in the Amazon Web Services catalog, and Sandbox\n for testing in secure, isolated environments.
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier\n helps to ensure that the correct opportunity is updated.\n
\nValidation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because\n incorrect identifiers result in an error and no changes are made.\n
", + "smithy.api#documentation": "The opportunity's unique identifier for when you want to disassociate it from related\n entities. This identifier helps to ensure that the correct opportunity is\n updated.
\nValidation: Ensure that the provided identifier corresponds to an existing opportunity\n in the Amazon Web Services system because incorrect identifiers result in an error and no\n changes are made.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -4757,14 +5363,14 @@ "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\n the system correctly process the disassociation request to ensure that the right connections are removed.\n
\nExamples 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.\n
\nValidation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.\n
", + "smithy.api#documentation": "The type of the entity that you're disassociating from the opportunity. When you\n specify the entity type, it helps the system correctly process the disassociation\n request to ensure that the right connections are removed.
\nExamples of entity types include Partner Solution, Amazon Web Services product, and\n Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity\n types.
\nValidation: Provide a valid entity type to help ensure successful disassociation. An\n 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\n type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed\n through Amazon Web Services Marketplace.\n
\nFor Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs.\n For guidance on retrieving these ARNs, see \n Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.\n
\nValidation: Ensure the identifier or ARN is valid and corresponds to an existing entity.\n An incorrect or invalid identifier results in an error.\n
", + "smithy.api#documentation": "The related entity's identifier that you want to disassociate from the opportunity.\n Depending on the type of entity, this could be a simple identifier or an Amazon Resource\n Name (ARN) for entities managed through Amazon Web Services Marketplace.
\nFor Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the\n necessary ARNs. For guidance on retrieving these ARNs, see \n Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.
\nValidation: Ensure the identifier or ARN is valid and corresponds to an existing\n entity. An incorrect or invalid identifier results in an error.
", "smithy.api#length": { "min": 1, "max": 255 @@ -4794,22 +5400,73 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.partnercentralselling#EngagementByAcceptingInvitationTask": { + "com.amazonaws.partnercentralselling#Engagement": { "type": "resource", "identifiers": { + "Identifier": { + "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier" + }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" - }, - "TaskId": { - "target": "com.amazonaws.partnercentralselling#TaskIdentifier" } }, "create": { - "target": "com.amazonaws.partnercentralselling#StartEngagementByAcceptingInvitationTask" + "target": "com.amazonaws.partnercentralselling#CreateEngagement" + }, + "read": { + "target": "com.amazonaws.partnercentralselling#GetEngagement" + }, + "list": { + "target": "com.amazonaws.partnercentralselling#ListEngagements" }, + "operations": [ + { + "target": "com.amazonaws.partnercentralselling#ListEngagementMembers" + } + ], "traits": { "aws.api#arn": { - "template": "catalog/{Catalog}/engagement-by-accepting-invitation-task/{TaskId}", + "template": "catalog/{Catalog}/engagement/{Identifier}", + "noAccount": true + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "relativeDocumentation": "/working-with-engagements.html" + }, + "smithy.api#documentation": "Represents an engagement in AWS Partner Central" + } + }, + "com.amazonaws.partnercentralselling#EngagementArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:.*" + } + }, + "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:.*|eng-[0-9a-z]{14})$" + } + }, + "com.amazonaws.partnercentralselling#EngagementByAcceptingInvitationTask": { + "type": "resource", + "identifiers": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" + }, + "TaskId": { + "target": "com.amazonaws.partnercentralselling#TaskIdentifier" + } + }, + "create": { + "target": "com.amazonaws.partnercentralselling#StartEngagementByAcceptingInvitationTask" + }, + "list": { + "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasks" + }, + "traits": { + "aws.api#arn": { + "template": "catalog/{Catalog}/engagement-by-accepting-invitation-task/{TaskId}", "noAccount": true }, "aws.iam#disableConditionKeyInference": {}, @@ -4820,40 +5477,97 @@ "smithy.api#documentation": "Represents a task that starts an Engagement by accepting an Engagement Invitation in AWS Partner Central" } }, + "com.amazonaws.partnercentralselling#EngagementContextDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.partnercentralselling#EngagementContextType", + "traits": { + "smithy.api#documentation": "\n Specifies the type of Engagement context. Valid values are \"CustomerProject\" or\n \"Document\", indicating whether the context relates to a customer project or a document\n respectively. \n
", + "smithy.api#required": {} + } + }, + "Payload": { + "target": "com.amazonaws.partnercentralselling#EngagementContextPayload", + "traits": { + "smithy.api#documentation": "\n Contains the specific details of the Engagement context. The structure of this payload\n varies depending on the Type field. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides detailed context information for an Engagement. This structure allows for\n specifying the type of context and its associated payload. \n
" + } + }, + "com.amazonaws.partnercentralselling#EngagementContextPayload": { + "type": "union", + "members": { + "CustomerProject": { + "target": "com.amazonaws.partnercentralselling#CustomerProjectsContext", + "traits": { + "smithy.api#documentation": "\n Contains detailed information about a customer project when the context type is\n \"CustomerProject\". This field is present only when the Type in EngagementContextDetails\n is set to \"CustomerProject\".\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Represents the payload of an Engagement context. The structure of this payload varies\n based on the context type specified in the EngagementContextDetails.\n
" + } + }, + "com.amazonaws.partnercentralselling#EngagementContextType": { + "type": "enum", + "members": { + "CUSTOMER_PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomerProject" + } + } + } + }, + "com.amazonaws.partnercentralselling#EngagementContexts": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#EngagementContextDetails" + }, + "traits": { + "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’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.
", + "smithy.api#documentation": "Specifies the industry to which the customer’s company belongs. This field helps\n categorize the opportunity based on the customer’s business sector.
", "smithy.api#required": {} } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { - "smithy.api#documentation": "Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.
", + "smithy.api#documentation": "Represents the name of the customer’s company associated with the Engagement\n 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’s company. This field helps partners verify the legitimacy and size of the customer organization.
", + "smithy.api#documentation": "Provides the website URL of the customer’s company. This field helps partners verify\n 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’s company operates. This field is useful for understanding regional requirements or compliance needs.
", + "smithy.api#documentation": "Indicates the country in which the customer’s company operates. This field is useful\n 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.
" + "smithy.api#documentation": "Contains details about the customer associated with the Engagement Invitation,\n including company information and industry.
" } }, "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem": { @@ -4866,6 +5580,53 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.partnercentralselling#EngagementCustomerProjectDetails": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.partnercentralselling#EngagementCustomerProjectTitle", + "traits": { + "smithy.api#documentation": "\n The title of the project.\n
", + "smithy.api#required": {} + } + }, + "BusinessProblem": { + "target": "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem", + "traits": { + "smithy.api#documentation": "\n A description of the business problem the project aims to solve.\n
", + "smithy.api#required": {} + } + }, + "TargetCompletionDate": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The target completion date for the customer's project.\n
", + "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": "\n Provides comprehensive details about a customer project associated with an Engagement.\n This may include information such as project goals, timelines, and specific customer\n requirements.\n
" + } + }, + "com.amazonaws.partnercentralselling#EngagementCustomerProjectTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.partnercentralselling#EngagementDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + } + } + }, "com.amazonaws.partnercentralselling#EngagementFromOpportunityTask": { "type": "resource", "identifiers": { @@ -4879,6 +5640,9 @@ "create": { "target": "com.amazonaws.partnercentralselling#StartEngagementFromOpportunityTask" }, + "list": { + "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasks" + }, "traits": { "aws.api#arn": { "template": "catalog/{Catalog}/engagement-from-opportunity-task/{TaskId}", @@ -4892,6 +5656,24 @@ "smithy.api#documentation": "Represents a task that starts an Engagement from an Opportunity in AWS Partner Central" } }, + "com.amazonaws.partnercentralselling#EngagementIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^eng-[0-9a-z]{14}$" + } + }, + "com.amazonaws.partnercentralselling#EngagementIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.partnercentralselling#EngagementInvitation": { "type": "resource", "identifiers": { @@ -4902,6 +5684,9 @@ "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" } }, + "create": { + "target": "com.amazonaws.partnercentralselling#CreateEngagementInvitation" + }, "read": { "target": "com.amazonaws.partnercentralselling#GetEngagementInvitation" }, @@ -4909,6 +5694,9 @@ "target": "com.amazonaws.partnercentralselling#ListEngagementInvitations" }, "operations": [ + { + "target": "com.amazonaws.partnercentralselling#AcceptEngagementInvitation" + }, { "target": "com.amazonaws.partnercentralselling#RejectEngagementInvitation" } @@ -4926,6 +5714,12 @@ "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#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": { @@ -4945,6 +5739,18 @@ "smithy.api#pattern": "^engi-[0-9,a-z]{13}$" } }, + "com.amazonaws.partnercentralselling#EngagementInvitationIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType": { "type": "enum", "members": { @@ -4968,56 +5774,62 @@ "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.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique\n identifier that allows partners to reference the invitation in their system and manage\n 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.
Describes the type of payload associated with the Engagement Invitation, such as\n Opportunity or MarketplaceOffer. This helps partners\n 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#documentation": "Represents the unique identifier of the Engagement Invitation. This identifier is used\n 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": "\n The identifier of the Engagement associated with this invitation. This links the\n invitation to its parent Engagement. \n
" + } + }, "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.
" + "smithy.api#documentation": "Provides a short title or description of the Engagement Invitation. This title helps\n partners quickly identify and differentiate between multiple engagement\n 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.
Represents the current status of the Engagement Invitation, such as\n Pending, Accepted, or Rejected. The status\n 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.
" + "smithy.api#documentation": "Indicates the date when the Engagement Invitation was sent to the partner. This\n provides context for when the opportunity was shared and helps in tracking the timeline\n 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.
" + "smithy.api#documentation": "Indicates the date and time when the Engagement Invitation will expire. After this\n date, the invitation can no longer be accepted, and the opportunity will be unavailable\n to the partner.
" } }, "SenderAwsAccountId": { - "target": "com.amazonaws.partnercentralselling#AwsAccountIdOrLabel", + "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.
" + "smithy.api#documentation": "Specifies the AWS account ID of the sender who initiated the Engagement Invitation.\n This allows the partner to identify the AWS entity or representative responsible for\n 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#documentation": "Indicates the name of the company or AWS division that sent the Engagement Invitation.\n This information is useful for partners to know which part of AWS is requesting\n engagement.
", "smithy.api#length": { "max": 120 } @@ -5026,19 +5838,25 @@ "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.
" + "smithy.api#documentation": "Specifies the partner company or individual that received the Engagement Invitation.\n This field is important for tracking who the invitation was sent to within the partner\n 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.
Specifies the catalog in which the Engagement Invitation resides. This can be either\n the AWS or Sandbox catalog, indicating whether the opportunity\n 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.
" + "smithy.api#documentation": "Provides a summarized view of the Engagement Invitation, including details like the\n identifier, status, and sender. This summary helps partners track and manage AWS\n originated opportunities.
" } }, "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType": { @@ -5047,118 +5865,325 @@ "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType" } }, - "com.amazonaws.partnercentralselling#EngagementScore": { - "type": "enum", + "com.amazonaws.partnercentralselling#EngagementMember": { + "type": "structure", "members": { - "HIGH": { - "target": "smithy.api#Unit", + "CompanyName": { + "target": "com.amazonaws.partnercentralselling#MemberCompanyName", "traits": { - "smithy.api#enumValue": "High" + "smithy.api#documentation": "\n The official name of the member's company or organization.\n
" } }, - "MEDIUM": { - "target": "smithy.api#Unit", + "WebsiteUrl": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "Medium" + "smithy.api#documentation": "\n The URL of the member company's website. This offers a way to find more information\n about the member organization and serves as an additional identifier.\n
" } }, - "LOW": { - "target": "smithy.api#Unit", + "AccountId": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#enumValue": "Low" + "smithy.api#documentation": "\n This is the unique identifier for the AWS account associated with the member\n organization. It's used for AWS-related operations and identity verification. \n
" } } + }, + "traits": { + "smithy.api#documentation": "Engagement members are the participants in an Engagement, which is likely a\n collaborative project or business opportunity within the AWS partner network. Members\n can be different partner organizations or AWS accounts that are working together on a\n specific engagement.
\nEach member is represented by their AWS Account ID, Company Name, and associated\n details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or\n WITHDRAWN), indicating their current state of participation. Only existing members of an\n Engagement can view the list of other members. This implies a level of privacy and\n access control within the Engagement structure.
" } }, - "com.amazonaws.partnercentralselling#EngagementTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - } + "com.amazonaws.partnercentralselling#EngagementMemberSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#EngagementMemberSummary" } }, - "com.amazonaws.partnercentralselling#ExpectedCustomerSpend": { + "com.amazonaws.partnercentralselling#EngagementMemberSummary": { "type": "structure", "members": { - "Amount": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.
", - "smithy.api#required": {} - } - }, - "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.
", - "smithy.api#pattern": "^USD$", - "smithy.api#required": {} - } - }, - "Frequency": { - "target": "com.amazonaws.partnercentralselling#PaymentFrequency", + "CompanyName": { + "target": "com.amazonaws.partnercentralselling#MemberCompanyName", "traits": { - "smithy.api#documentation": "Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.
\n The official name of the member's company or organization.\n
" } }, - "TargetCompany": { + "WebsiteUrl": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.
", - "smithy.api#length": { - "min": 1, - "max": 80 - }, - "smithy.api#required": {} + "smithy.api#documentation": "\n The URL of the member company's website. This offers a way to find more information\n about the member organization and serves as an additional identifier.\n
" } } }, "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.
" + "smithy.api#documentation": "\n The EngagementMemberSummary provides a snapshot of essential information about\n participants in an AWS Partner Central Engagement. This compact data structure\n encapsulates key details of each member, facilitating efficient collaboration and\n management within the Engagement.\n
" } }, - "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList": { + "com.amazonaws.partnercentralselling#EngagementMembers": { "type": "list", "member": { - "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpend" + "target": "com.amazonaws.partnercentralselling#EngagementMember" }, "traits": { "smithy.api#length": { - "min": 1 + "max": 10 } } }, - "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#EngagementPageSize": { + "type": "integer", + "traits": { + "smithy.api#default": 20, + "smithy.api#range": { + "min": 1, + "max": 100 + } } }, - "com.amazonaws.partnercentralselling#FilterLifeCycleStage": { - "type": "list", - "member": { - "target": "com.amazonaws.partnercentralselling#Stage" + "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummary": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "\n Indicates the environment in which the resource and engagement exist.\n
", + "smithy.api#required": {} + } + }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n A unique identifier for the engagement associated with the resource.\n
" + } + }, + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", + "traits": { + "smithy.api#documentation": "\n Categorizes the type of resource associated with the engagement.\n
" + } + }, + "ResourceId": { + "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "\n A unique identifier for the specific resource. Varies depending on the resource\n type.\n
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", + "traits": { + "smithy.api#documentation": "\n The AWS account ID of the entity that created the association.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n This provide a streamlined view of the relationships between engagements and\n resources. These summaries offer a crucial link between collaborative engagements and\n the specific resources involved, such as opportunities.These summaries are particularly\n valuable for partners navigating complex engagements with multiple resources. They\n enable quick insights into resource distribution across engagements, support efficient\n resource management, and help maintain a clear overview of collaborative activities.\n
" } }, - "com.amazonaws.partnercentralselling#FilterStatus": { + "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.partnercentralselling#SolutionStatus" + "target": "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummary" } }, - "com.amazonaws.partnercentralselling#GetAwsOpportunitySummary": { - "type": "operation", - "input": { - "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryRequest" + "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" + } + } + } + }, + "com.amazonaws.partnercentralselling#EngagementSort": { + "type": "structure", + "members": { + "SortOrder": { + "target": "com.amazonaws.partnercentralselling#SortOrder", + "traits": { + "smithy.api#documentation": "\n The order in which to sort the results.\n
", + "smithy.api#required": {} + } + }, + "SortBy": { + "target": "com.amazonaws.partnercentralselling#EngagementSortName", + "traits": { + "smithy.api#documentation": "\n The field by which to sort the results.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Specifies the sorting parameters for listing Engagements.\n
" + } + }, + "com.amazonaws.partnercentralselling#EngagementSortName": { + "type": "enum", + "members": { + "CreatedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedDate" + } + } + } + }, + "com.amazonaws.partnercentralselling#EngagementSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.partnercentralselling#EngagementArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the created engagement.\n
" + } + }, + "Id": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier for the engagement.\n
" + } + }, + "Title": { + "target": "com.amazonaws.partnercentralselling#EngagementTitle", + "traits": { + "smithy.api#documentation": "\n The title of the engagement.\n
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.partnercentralselling#DateTime", + "traits": { + "smithy.api#documentation": "\n The date and time when the engagement was created.\n
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", + "traits": { + "smithy.api#documentation": "\n The AWS account ID of the engagement creator.\n
" + } + }, + "MemberCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "\n The number of members in the engagement.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An object that contains an Engagement's subset of fields.\n
Represents the estimated monthly revenue that the partner expects to earn from the\n opportunity. This helps in forecasting financial returns.
", + "smithy.api#required": {} + } + }, + "CurrencyCode": { + "target": "com.amazonaws.partnercentralselling#CurrencyCode", + "traits": { + "smithy.api#documentation": "Indicates the currency in which the revenue estimate is provided. This helps in\n understanding the financial impact across different markets.
", + "smithy.api#pattern": "^USD$", + "smithy.api#required": {} + } + }, + "Frequency": { + "target": "com.amazonaws.partnercentralselling#PaymentFrequency", + "traits": { + "smithy.api#documentation": "Indicates how frequently the customer is expected to spend the projected amount. This\n can include values such as Monthly, Quarterly, or\n Annually. The default value is Monthly, representing\n recurring monthly spend.
Specifies the name of the partner company that is expected to generate revenue from\n the opportunity. This field helps track the partner’s involvement in the\n opportunity.
", + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#required": {} + } + }, + "EstimationUrl": { + "target": "com.amazonaws.partnercentralselling#WebsiteUrl", + "traits": { + "smithy.api#documentation": "\n A URL providing additional information or context about the spend estimation.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides an estimate of the revenue that the partner is expected to generate from the\n opportunity. This information helps partners assess the financial value of the\n project.
" + } + }, + "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpend" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "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#FilterStatus": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#SolutionStatus" + } + }, + "com.amazonaws.partnercentralselling#GetAwsOpportunitySummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryRequest" }, "output": { "target": "com.amazonaws.partnercentralselling#GetAwsOpportunitySummaryResponse" @@ -5187,7 +6212,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieve AWS Opportunity Summaries for Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "\n Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity\n sourced from AWS, such as lifecycle information, customer details, and involvement type.\n It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.\n
", + "smithy.api#documentation": "Retrieves a summary of an AWS Opportunity. This summary includes high-level details\n about the opportunity sourced from AWS, such as lifecycle information, customer details,\n and involvement type. It is useful for tracking updates on the AWS opportunity\n corresponding to an opportunity in the partner's account.
", "smithy.api#http": { "method": "POST", "uri": "/GetAwsOpportunitySummary", @@ -5202,14 +6227,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS\n for production opportunities or Sandbox for testing purposes. The catalog determines\n which environment the opportunity data is pulled from.\n
Specifies the catalog in which the AWS Opportunity is located. Accepted values include\n AWS for production opportunities or Sandbox for testing\n purposes. The catalog determines which environment the opportunity data is pulled\n from.
\n The unique identifier for the related partner opportunity. Use this field to correlate an AWS\n opportunity with its corresponding partner opportunity.\n
", + "smithy.api#documentation": "The unique identifier for the related partner opportunity. Use this field to correlate\n an AWS opportunity with its corresponding partner opportunity.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -5225,74 +6250,74 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS\n or Sandbox) where the opportunity is being managed.\n
Specifies the catalog in which the AWS Opportunity exists. This is the environment\n (e.g., AWS or Sandbox) where the opportunity is being\n managed.
\n Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS\n Opportunity to their corresponding opportunity in their CRM system.\n
" + "smithy.api#documentation": "Provides the unique identifier of the related partner opportunity, allowing partners\n to link the AWS Opportunity to their corresponding opportunity in their CRM\n system.
" } }, "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { - "smithy.api#documentation": "\n Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between\n opportunities that were sourced by AWS and those referred by the partner.\n
" + "smithy.api#documentation": "Specifies whether the AWS Opportunity originated from AWS or the partner. This helps\n distinguish between opportunities that were sourced by AWS and those referred by the\n partner.
" } }, "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "\n Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support.\n This field helps partners understand the role AWS plays in advancing the opportunity.\n
" + "smithy.api#documentation": "Specifies the type of involvement AWS has in the opportunity, such as direct cosell or\n advisory support. This field helps partners understand the role AWS plays in advancing\n the opportunity.
" } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { - "smithy.api#documentation": "\n Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases,\n while Limited visibility is reserved for special programs or sensitive opportunities.\n
Defines the visibility level for the AWS Opportunity. Use Full visibility\n for most cases, while Limited visibility is reserved for special programs\n or sensitive opportunities.
\n Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date.\n This field is crucial for partners to monitor the progression of the opportunity.\n
" + "smithy.api#documentation": "Contains lifecycle information for the AWS Opportunity, including review status,\n stage, and target close date. This field is crucial for partners to monitor the\n progression of the opportunity.
" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "\n Details the AWS opportunity team, including members involved. This information\n helps partners know who from AWS is engaged and what their role is.\n
" + "smithy.api#documentation": "Details the AWS opportunity team, including members involved. This information helps\n partners know who from AWS is engaged and what their role is.
" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityInsights", "traits": { - "smithy.api#documentation": "\n Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests\n for the partner.\n
" + "smithy.api#documentation": "Provides insights into the AWS Opportunity, including engagement score and recommended\n actions that AWS suggests for the partner.
" } }, "InvolvementTypeChangeReason": { "target": "com.amazonaws.partnercentralselling#InvolvementTypeChangeReason", "traits": { - "smithy.api#documentation": "\n Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to\n track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.\n
Provides a reason for any changes in the involvement type of AWS in the opportunity.\n This field is used to track why the level of AWS engagement has changed from For\n Visibility Only to Co-sell offering transparency into the\n partnership dynamics.
\n Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS\n Opportunity. These identifiers provide additional context and help partners understand which AWS services\n are involved.\n
" + "smithy.api#documentation": "Lists related entity identifiers, such as AWS products or partner solutions,\n associated with the AWS Opportunity. These identifiers provide additional context and\n help partners understand which AWS services are involved.
" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityCustomer", "traits": { - "smithy.api#documentation": "\n Provides details about the customer associated with the AWS Opportunity, including account information,\n industry, and other customer data. These details help partners understand the business context of the\n opportunity.\n
" + "smithy.api#documentation": "Provides details about the customer associated with the AWS Opportunity, including\n account information, industry, and other customer data. These details help partners\n understand the business context of the opportunity.
" } }, "Project": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityProject", "traits": { - "smithy.api#documentation": "\n Provides details about the project associated with the AWS Opportunity, including the customer’s business\n problem, expected outcomes, and project scope. This information is crucial for understanding the broader\n context of the opportunity.\n
" + "smithy.api#documentation": "Provides details about the project associated with the AWS Opportunity, including the\n customer’s business problem, expected outcomes, and project scope. This information is\n crucial for understanding the broader context of the opportunity.
" } } }, @@ -5300,6 +6325,44 @@ "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#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": "\n Use this action to retrieve the engagement record for a given\n EngagementIdentifier.\n
Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.
Retrieves the details of an engagement invitation shared by AWS with a partner. The\n information includes aspects such as customer, project details, and lifecycle\n information. To connect an engagement invitation with an opportunity, match the\n invitation’s Payload.Project.Title with opportunity\n 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 catalog associated with the request. The field accepts values from the\n predefined set: AWS for live operations or Sandbox for testing\n environments.
Specifies the unique identifier for the retrieved engagement\n invitation.
", + "smithy.api#documentation": "Specifies the unique identifier for the retrieved engagement invitation.
", "smithy.api#required": {} } } @@ -5369,13 +6432,13 @@ "Arn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the engagement\n invitation.
" + "smithy.api#documentation": "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.
" + "smithy.api#documentation": "The type of payload contained in the engagement invitation, indicating what data or\n context the payload covers.
" } }, "Id": { @@ -5385,10 +6448,16 @@ "smithy.api#required": {} } }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the engagement associated with this invitation.This ID links the\n invitation to its corresponding engagement.\n
" + } + }, "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.
" + "smithy.api#documentation": "The title of the engagement invitation, summarizing the purpose or objectives of the\n opportunity shared by AWS.
" } }, "Status": { @@ -5406,13 +6475,13 @@ "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.
" + "smithy.api#documentation": "Indicates the date on which the engagement invitation will expire if not accepted by\n the partner.
" } }, "SenderAwsAccountId": { - "target": "com.amazonaws.partnercentralselling#AwsAccountIdOrLabel", + "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.
" + "smithy.api#documentation": "Specifies the AWS Account ID of the sender, which identifies the AWS team responsible\n for sharing the engagement invitation.
" } }, "SenderCompanyName": { @@ -5427,88 +6496,184 @@ "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.
" + "smithy.api#documentation": "Information about the partner organization or team that received the engagement\n 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.
Indicates the catalog from which the engagement invitation details are retrieved. This\n field helps in identifying the appropriate catalog (e.g., AWS or\n Sandbox) used in the request.
If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
" + "smithy.api#documentation": "If the engagement invitation was rejected, this field specifies the reason provided by\n 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.
" + "smithy.api#documentation": "Details of the engagement invitation payload, including specific data relevant to the\n invitation's contents, such as customer information and opportunity insights.
" } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.partnercentralselling#GetOpportunity": { - "type": "operation", - "input": { - "target": "com.amazonaws.partnercentralselling#GetOpportunityRequest" - }, - "output": { - "target": "com.amazonaws.partnercentralselling#GetOpportunityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.partnercentralselling#AccessDeniedException" - }, - { - "target": "com.amazonaws.partnercentralselling#InternalServerException" }, - { - "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" + "InvitationMessage": { + "target": "com.amazonaws.partnercentralselling#InvitationMessage", + "traits": { + "smithy.api#documentation": "\n The message sent to the invited partner when the invitation was created.\n
" + } }, - { - "target": "com.amazonaws.partnercentralselling#ThrottlingException" + "EngagementDescription": { + "target": "com.amazonaws.partnercentralselling#EngagementDescription", + "traits": { + "smithy.api#documentation": "\n The description of the engagement associated with this invitation.\n
" + } }, - { - "target": "com.amazonaws.partnercentralselling#ValidationException" + "ExistingMembers": { + "target": "com.amazonaws.partnercentralselling#EngagementMemberSummaries", + "traits": { + "smithy.api#documentation": "\n A list of active members currently part of the Engagement. This array contains a\n maximum of 10 members, each represented by an object with the following\n properties.\n
\n\n CompanyName: The name of the member's company. \n
\n\n WebsiteUrl: The website URL of the member's company. \n
\n\n Fetches the Opportunity record from Partner Central by a given Identifier.\n
\n Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.\n
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog,\n and Sandbox to retrieve opportunities in a secure, isolated testing environment.\n
\n Specifies the catalog related to the engagement request. Valid values are\n AWS and Sandbox.\n
\n Specifies the identifier of the Engagement record to retrieve.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#GetEngagementResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique resource identifier of the engagement retrieved.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#EngagementArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the engagement retrieved.\n
" + } + }, + "Title": { + "target": "com.amazonaws.partnercentralselling#EngagementTitle", + "traits": { + "smithy.api#documentation": "\n The title of the engagement. It provides a brief, descriptive name for the engagement\n that is meaningful and easily recognizable.\n
" + } + }, + "Description": { + "target": "com.amazonaws.partnercentralselling#EngagementDescription", + "traits": { + "smithy.api#documentation": "\n A more detailed description of the engagement. This provides additional context or\n information about the engagement's purpose or scope. \n
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.partnercentralselling#DateTime", + "traits": { + "smithy.api#documentation": "\n The date and time when the Engagement was created, presented in ISO 8601 format (UTC).\n For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the\n Engagement.\n
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", + "traits": { + "smithy.api#documentation": "\n The AWS account ID of the user who originally created the engagement. This field helps\n in tracking the origin of the engagement.\n
" + } + }, + "MemberCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "\n Specifies the current count of members participating in the Engagement. This count\n includes all active members regardless of their roles or permissions within the\n Engagement.\n
" + } + }, + "Contexts": { + "target": "com.amazonaws.partnercentralselling#EngagementContexts", + "traits": { + "smithy.api#documentation": "\n A list of context objects associated with the engagement. Each context provides\n additional information related to the Engagement, such as customer projects or\n documents.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#GetOpportunity": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#GetOpportunityRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#GetOpportunityResponse" + }, + "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 details of Opportunities on AWS Partner Central" + }, + "smithy.api#documentation": "Fetches the Opportunity record from Partner Central by a given\n Identifier.
Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is fetched from. Use AWS to retrieve\n opportunities in the Amazon Web Services catalog, and Sandbox to retrieve\n opportunities in a secure, isolated testing environment.
Read-only, system generated Opportunity unique identifier.\n
Read-only, system generated Opportunity unique identifier.
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity\n information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog,\n and Sandbox to retrieve opportunities in a secure and isolated testing environment.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity information is retrieved from. Use AWS to\n retrieve opportunities in the Amazon Web Services catalog, and Sandbox to\n retrieve opportunities in a secure and isolated testing environment.
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).\n
\n\n Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.\n
\n\n Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.\n
\nIdentifies the type of support the partner needs from Amazon Web Services.
\nValid values:
\nCosell—Architectural Validation: Confirmation from Amazon Web Services that the\n partner's proposed solution architecture is aligned with Amazon Web Services best\n practices and poses minimal architectural risks.
\nCosell—Business Presentation: Request Amazon Web Services seller's\n participation in a joint customer presentation.
\nCosell—Competitive Information: Access to Amazon Web Services competitive\n resources and support for the partner's proposed solution.
\nCosell—Pricing Assistance: Connect with an Amazon Web Services seller for\n support situations where a partner may be receiving an upfront discount on a\n service (for example: EDP deals).
\nCosell—Technical Consultation: Connect with an Amazon Web Services Solutions\n Architect to address the partner's questions about the proposed solution.
\nCosell—Total Cost of Ownership Evaluation: Assistance with quoting different\n cost savings of proposed solutions on Amazon Web Services versus on-premises or a\n traditional hosting environment.
\nCosell—Deal Support: Request Amazon Web Services seller's support to progress\n the opportunity (for example: joint customer call, strategic\n positioning).
\nCosell—Support for Public Tender/RFx: Opportunity related to the public sector\n where the partner needs Amazon Web Services RFx support.
\nDo Not Need Support from Amazon Web Services Sales Rep: Indicates that a\n partner doesn't need support from an Amazon Web Services sales representative,\n and the partner solely manages the opportunity. It's possible to request\n coselling support on these opportunities at any stage during their lifecycle.\n Also known as, for-visibility-only (FVO) opportunity.
\nIndicates 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.
Indicates whether the Opportunity pertains to a national security\n project. This field must be set to true only when the customer's industry\n is Government. Additional privacy and security measures apply\n during the review and management process for opportunities marked as\n NationalSecurity.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential\n to track and reconcile because it's included in the outbound payload sent back to the partner.\n
", + "smithy.api#documentation": "Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.
", "smithy.api#length": { "max": 64 } @@ -5551,71 +6716,77 @@ "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { - "smithy.api#documentation": "Specifies details of the customer associated with the Opportunity.\n
Specifies details of the customer associated with the Opportunity.
An object that contains project details summary for the Opportunity.\n
An object that contains project details summary for the\n Opportunity.
\n Specifies the opportunity type as renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, which helps to ensure service continuity.\n
\n\n Expansion opportunity:\n 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.\n
\nSpecifies the opportunity type as renewal, new, or expansion.
\nOpportunity types:
\nNew opportunity: Represents a new business opportunity with a potential\n customer that's not previously engaged with your solutions or services.
\nRenewal opportunity: Represents an opportunity to renew an existing contract\n or subscription with a current customer, which helps to ensure service\n continuity.
\nExpansion opportunity: Represents an opportunity to expand the scope of a\n customer's contract or subscription, either by adding new services or increasing\n the volume of existing services.
\nAn object that contains marketing details for the Opportunity.\n
An object that contains marketing details for the Opportunity.
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
" + "smithy.api#documentation": "Specifies details of a customer's procurement terms. Required only for partners in\n eligible programs.
" } }, "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "Read-only, system generated Opportunity unique identifier.\n
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": "\n DateTime\n when the opportunity was last modified.\n
\n DateTime when the opportunity was last modified.
\n DateTime when the Opportunity was last created.\n
\n DateTime when the Opportunity was last created.
\n Provides information about the associations of other entities with the opportunity. These entities include identifiers for\n AWSProducts, Partner Solutions, and AWSMarketplaceOffers.\n
Provides information about the associations of other entities with the opportunity.\n These entities include identifiers for AWSProducts, Partner\n Solutions, and AWSMarketplaceOffers.
An object that contains lifecycle details for the Opportunity.\n
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.
" + "smithy.api#documentation": "Represents the internal team handling the opportunity. Specify the members involved in\n collaborating on this opportunity within the partner's organization.
" } } }, @@ -5623,112 +6794,481 @@ "smithy.api#output": {} } }, - "com.amazonaws.partnercentralselling#Industry": { - "type": "enum", + "com.amazonaws.partnercentralselling#GetResourceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#GetResourceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#GetResourceSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "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 details in AWS Partner Central" + }, + "smithy.api#documentation": "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#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": "\n Use this action to retrieves information about a specific resource snapshot\n job.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetResourceSnapshotJob", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.partnercentralselling#GetResourceSnapshotJobRequest": { + "type": "structure", "members": { - "AEROSPACE_SATELLITE": { - "target": "smithy.api#Unit", + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#enumValue": "Aerospace" + "smithy.api#documentation": "\n Specifies the catalog related to the request. Valid values are:\n
\nAWS: Retrieves the snapshot job from the production AWS environment.
\nSandbox: Retrieves the snapshot job from a sandbox environment used for\n testing or development purposes.
\n\n The unique identifier of the resource snapshot job to be retrieved. This identifier is\n crucial for pinpointing the specific job you want to query.\n
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Identifier" } - }, - "AUTOMOTIVE": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#GetResourceSnapshotJobResponse": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#enumValue": "Automotive" + "smithy.api#documentation": "\n The catalog in which the snapshot job was created. This will match the catalog\n specified in the request.\n
", + "smithy.api#required": {} } }, - "COMPUTERS_ELECTRONICS": { - "target": "smithy.api#Unit", + "Id": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#enumValue": "Computers and Electronics" + "smithy.api#documentation": "\n The unique identifier of the snapshot job. This matches the\n ResourceSnapshotJobIdentifier provided in the request. \n
\n he Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier\n can be used for resource-specific operations across AWS services. \n
" } }, - "EDUCATION": { - "target": "smithy.api#Unit", + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#enumValue": "Education" + "smithy.api#documentation": "\n The identifier of the engagement associated with this snapshot job. This links the job\n to a specific engagement context. \n
" } }, - "ENERGY_OIL_GAS": { - "target": "smithy.api#Unit", + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#enumValue": "Energy - Oil and Gas" + "smithy.api#documentation": "\n The type of resource being snapshotted. This would have Opportunity as a value as it\n is dependent on the supported resource type. \n
\n The identifier of the specific resource being snapshotted. The format may vary\n depending on the ResourceType.\n
\n The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a\n globally unique identifier for the resource across AWS.\n
" } }, - "GAMING": { - "target": "smithy.api#Unit", + "ResourceSnapshotTemplateName": { + "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#enumValue": "Gaming" + "smithy.api#documentation": "\n The name of the template used for creating the snapshot. This is the same as the\n template name. It defines the structure and content of the snapshot.\n
" } }, - "GOVERNMENT": { - "target": "smithy.api#Unit", + "CreatedAt": { + "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#enumValue": "Government" + "smithy.api#documentation": "\n The date and time when the snapshot job was created, in ISO 8601 format (UTC).\n Example: \"2023-05-01T20:37:46Z\"\n
" } }, - "HEALTHCARE": { - "target": "smithy.api#Unit", + "Status": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { - "smithy.api#enumValue": "Healthcare" + "smithy.api#documentation": "\n The current status of the snapshot job. Valid values:\n
\nSTOPPED: The job is not currently running.
\nRUNNING: The job is actively executing.
\n\n The date and time of the last successful execution of the job, in ISO 8601 format\n (UTC). Example: \"2023-05-01T20:37:46Z\"\n
" } }, - "LIFE_SCIENCES": { - "target": "smithy.api#Unit", + "LastFailure": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "Life Sciences" + "smithy.api#documentation": "\n If the job has encountered any failures, this field contains the error message from\n the most recent failure. This can be useful for troubleshooting issues with the job.\n
" } - }, - "MANUFACTURING": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#GetResourceSnapshotRequest": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#enumValue": "Manufacturing" + "smithy.api#documentation": "Specifies the catalog related to the request. Valid values are:
\nAWS: Retrieves the snapshot from the production AWS environment.
\nSandbox: Retrieves the snapshot from a sandbox environment used for testing or\n development purposes.
\nThe unique identifier of the engagement associated with the snapshot. This field links\n the snapshot to a specific engagement context.
", + "smithy.api#required": {} } }, - "MEDIA_ENTERTAINMENT": { - "target": "smithy.api#Unit", + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#enumValue": "Media and Entertainment" + "smithy.api#documentation": "Specifies the type of resource that was snapshotted. This field determines the\n structure and content of the snapshot payload. Valid value\n includes:Opportunity: For opportunity-related data.
The unique identifier of the specific resource that was snapshotted. The format and\n constraints of this identifier depend on the ResourceType specified. For\n Opportunity type, it will be an opportunity ID\n
he name of the template that defines the schema for the snapshot. This template\n determines which subset of the resource data is included in the snapshot and must\n correspond to an existing and valid template for the specified\n ResourceType.
Specifies which revision of the snapshot to retrieve. If omitted returns the latest\n revision.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#GetResourceSnapshotResponse": { + "type": "structure", + "members": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "The catalog in which the snapshot was created. Matches the Catalog specified in the\n request.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#ResourceArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be\n used for resource-specific operations across AWS services.\n
" + } + }, + "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\n 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.,\n \"2023-06-01T14:30:00Z\"). This allows for precise tracking of when the snapshot was\n taken.
" + } + }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the engagement associated with this snapshot. Matches the\n EngagementIdentifier specified in the request.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", + "traits": { + "smithy.api#documentation": "\n The type of the resource that was snapshotted. Matches the ResourceType specified in\n the request.\n
\n The identifier of the specific resource that was snapshotted. Matches the\n ResourceIdentifier specified in the request.\n
\n The name of the view used for this snapshot. This is the same as the template\n name.\n
" + } + }, + "Revision": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", + "traits": { + "smithy.api#documentation": "\n The revision number of this snapshot. This is a positive integer that is sequential\n and unique within the context of a resource view.\n
" + } + }, + "Payload": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotPayload" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#GetSellingSystemSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#GetSellingSystemSettingsRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#GetSellingSystemSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "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 system settings settings in AWS Partner Central" + }, + "smithy.api#documentation": "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\n AWS for production and Sandbox for testing\n environments.
Specifies the catalog in which the settings are defined. Acceptable values include\n AWS for production and Sandbox for testing\n environments.
Specifies the ARN of the IAM Role used for resource snapshot job executions.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "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" @@ -5804,11 +7344,47 @@ } }, "traits": { - "smithy.api#documentation": "This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.\n
\nSuggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.\n
", + "smithy.api#documentation": "This error occurs when the specified resource can’t be found or doesn't exist.\n Resource ID and type might be incorrect.
\nSuggested action: This is usually a transient error. Retry after the provided retry\n 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": "\n A message accompanying the invitation.\n
", + "smithy.api#required": {} + } + }, + "Receiver": { + "target": "com.amazonaws.partnercentralselling#Receiver", + "traits": { + "smithy.api#required": {} + } + }, + "Payload": { + "target": "com.amazonaws.partnercentralselling#Payload", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Invitation structure represents an invitation exchanged between partners and AWS.\n It includes a message, receiver information, and a payload providing context for the\n invitation.\n
" + } + }, + "com.amazonaws.partnercentralselling#InvitationMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.partnercentralselling#InvitationStatus": { "type": "enum", "members": { @@ -5838,203 +7414,1269 @@ } } }, + "com.amazonaws.partnercentralselling#InvitationStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#InvitationStatus" + }, + "traits": { + "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" + "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" + } + } + } + }, + "com.amazonaws.partnercentralselling#JobTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 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\n 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\n 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\n filter is useful for tracking changes or updates to opportunities over time.
" + } + }, + "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\n Amazon Web Services stages from the current stage in the partner CRM. This field\n provides a translated value of the stage, and offers insight into the\n 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\n opportunity before submission. Opportunities that were closed/lost before submission\n aren't suitable for submission.
The descriptions of each sales stage are:
\nProspect: Amazon Web Services identifies the opportunity. It can be active\n (Comes directly from the end customer through a lead) or latent (Your account\n team believes it exists based on research, account plans, sales plays).
\nQualified: Your account team engaged with the customer to discuss viability\n and requirements. The customer agreed that the opportunity is real, of interest,\n and may solve business/technical needs.
\nTechnical Validation: All parties understand the implementation plan.
\nBusiness Validation: Pricing was proposed, and all parties agree to the steps\n to close.
\nCommitted: The customer signed the contract, but Amazon Web Services hasn't\n started billing.
\nLaunched: The workload is complete, and Amazon Web Services has started\n billing.
\nClosed Lost: The opportunity is lost, and there are no steps to move\n forward.
\nSpecifies the reason code when an opportunity is marked as Closed\n Lost. When you select an appropriate reason code, you communicate the\n context for closing the Opportunity, and aid in accurate reports and\n analysis of opportunity outcomes. The possible values are:
Customer Deficiency: The customer lacked necessary resources or\n capabilities.
\nDelay/Cancellation of Project: The project was delayed or canceled.
\nLegal/Tax/Regulatory: Legal, tax, or regulatory issues prevented\n progress.
\nLost to Competitor—Google: The opportunity was lost to Google.
\nLost to Competitor—Microsoft: The opportunity was lost to Microsoft.
\nLost to Competitor—SoftLayer: The opportunity was lost to SoftLayer.
\nLost to Competitor—VMWare: The opportunity was lost to VMWare.
\nLost to Competitor—Other: The opportunity was lost to a competitor not listed\n above.
\nNo Opportunity: There was no opportunity to pursue.
\nOn Premises Deployment: The customer chose an on-premises solution.
\nPartner Gap: The partner lacked necessary resources or capabilities.
\nPrice: The price was not competitive or acceptable to the customer.
\nSecurity/Compliance: Security or compliance issues prevented progress.
\nTechnical Limitations: Technical limitations prevented progress.
\nCustomer Experience: Issues related to the customer's experience impacted the\n decision.
\nOther: Any reason not covered by the other values.
\nPeople/Relationship/Governance: Issues related to people, relationships, or\n governance.
\nProduct/Technology: Issues related to the product or technology.
\nFinancial/Commercial: Financial or commercial issues impacted the\n decision.
\nSpecifies the upcoming actions or tasks for the Opportunity. Use this\n field to communicate with Amazon Web Services about the next actions required for the\n Opportunity.
Specifies the date when Amazon Web Services expects to start significant billing, when\n 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.
\nEnsure the Target Close Date isn't in the past.
Indicates the review status of an opportunity referred by a partner. This field is\n read-only and only applicable for partner referrals. The possible values are:
\nPending Submission: Not submitted for validation (editable).
\nSubmitted: Submitted for validation, and Amazon Web Services hasn't reviewed it\n (read-only).
\nIn Review: Amazon Web Services is validating (read-only).
\nAction Required: Issues that Amazon Web Services highlights need to be\n addressed. Partners should use the UpdateOpportunity API action to\n update the opportunity and helps to ensure that all required changes are made.\n Only the following fields are editable when the\n Lifecycle.ReviewStatus is Action Required:
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedMonthlyAWSRevenue.Amount
\nProject.ExpectedMonthlyAWSRevenue.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\nAfter updates, the opportunity re-enters the validation phase. This process\n repeats until all issues are resolved, and the opportunity's\n Lifecycle.ReviewStatus is set to Approved or\n Rejected.
Approved: Validated and converted into the Amazon Web Services seller's\n pipeline (editable).
\nRejected: Disqualified (read-only).
\nIndicates why an opportunity was sent back for further details. Partners must take\n corrective action based on the ReviewComments.
Indicates the reason a decision was made during the opportunity review process. This\n field combines the reasons for both disqualified and action required statuses, and\n provide clarity for why an opportunity was disqualified or requires further\n action.
" + } + }, + "NextStepsHistory": { + "target": "com.amazonaws.partnercentralselling#NextStepsHistories", + "traits": { + "smithy.api#documentation": "Captures a chronological record of the next steps or actions planned or taken for the\n current opportunity, along with the timestamp.
", + "smithy.api#length": { + "max": 50 + } + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains the Opportunity lifecycle's details.
\n The projected launch date of the opportunity shared through a snapshot.\n
" + } + }, + "ReviewStatus": { + "target": "com.amazonaws.partnercentralselling#ReviewStatus", + "traits": { + "smithy.api#documentation": "\n Defines the approval status of the opportunity shared through a snapshot.\n
" + } + }, + "Stage": { + "target": "com.amazonaws.partnercentralselling#Stage", + "traits": { + "smithy.api#documentation": "\n Defines the current stage of the opportunity shared through a snapshot.\n
" + } + }, + "NextSteps": { + "target": "com.amazonaws.partnercentralselling#PiiString", + "traits": { + "smithy.api#documentation": "\n Describes the next steps for the opportunity shared through a snapshot.\n
", + "smithy.api#length": { + "max": 255 + } + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides the lifecycle view of an opportunity resource shared through a\n snapshot.\n
" + } + }, + "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\n Amazon Web Services stages from the current stage in the partner CRM. This field\n provides a translated value of the stage, and offers insight into the\n 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\n opportunity before submission. Opportunities that were closed/lost before submission\n aren't suitable for submission.
The descriptions of each sales stage are:
\nProspect: Amazon Web Services identifies the opportunity. It can be active\n (Comes directly from the end customer through a lead) or latent (Your account\n team believes it exists based on research, account plans, sales plays).
\nQualified: Your account team engaged with the customer to discuss viability\n and understand requirements. The customer agreed that the opportunity is real,\n of interest, and may solve business/technical needs.
\nTechnical Validation: All parties understand the implementation plan.
\nBusiness Validation: Pricing was proposed, and all parties agree to the steps\n to close.
\nCommitted: The customer signed the contract, but Amazon Web Services hasn't\n started billing.
\nLaunched: The workload is complete, and Amazon Web Services has started\n billing.
\nClosed Lost: The opportunity is lost, and there are no steps to move\n forward.
\nSpecifies the reason code when an opportunity is marked as Closed\n Lost. When you select an appropriate reason code, you communicate the\n context for closing the Opportunity, and aid in accurate reports and\n analysis of opportunity outcomes.
Specifies the upcoming actions or tasks for the Opportunity. This field\n is utilized to communicate to Amazon Web Services the next actions required for the\n Opportunity.
Specifies the date when Amazon Web Services expects to start significant billing, when\n 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.
\nEnsure the Target Close Date isn't in the past.
Indicates the review status of a partner referred opportunity. This field is read-only\n and only applicable for partner referrals. Valid values:
\nPending Submission: Not submitted for validation (editable).
\nSubmitted: Submitted for validation and not yet Amazon Web Services reviewed\n (read-only).
\nIn Review: Undergoing Amazon Web Services validation (read-only).
\nAction Required: Address any issues Amazon Web Services highlights. Use the\n UpdateOpportunity API action to update the opportunity, and\n ensure you make all required changes. Only these fields are editable when the\n Lifecycle.ReviewStatus is Action Required:
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedCustomerSpend.Amount
\nProject.ExpectedCustomerSpend.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\nAfter updates, the opportunity re-enters the validation phase. This process\n repeats until all issues are resolved, and the opportunity's\n Lifecycle.ReviewStatus is set to Approved or\n Rejected.
Approved: Validated and converted into the Amazon Web Services seller's\n pipeline (editable).
\nRejected: Disqualified (read-only).
\nIndicates why an opportunity was sent back for further details. Partners must take\n corrective action based on the ReviewComments.
Indicates the reason a specific decision was taken during the opportunity review\n process. This field combines the reasons for both disqualified and action required\n statuses, and provides clarity for why an opportunity was disqualified or required\n further action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a LifeCycle object's subset of fields.
\n Unique identifier of the task.\n
" + } + }, + "TaskArn": { + "target": "com.amazonaws.partnercentralselling#TaskArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) that uniquely identifies the task.\n
" + } + }, + "StartTime": { + "target": "com.amazonaws.partnercentralselling#DateTime", + "traits": { + "smithy.api#documentation": "\n Task start timestamp.\n
" + } + }, + "TaskStatus": { + "target": "com.amazonaws.partnercentralselling#TaskStatus", + "traits": { + "smithy.api#documentation": "\n Status of the task.\n
" + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Detailed message describing the failure and possible recovery steps.\n
" + } + }, + "ReasonCode": { + "target": "com.amazonaws.partnercentralselling#ReasonCode", + "traits": { + "smithy.api#documentation": "\n A code pointing to the specific reason for the failure.\n
" + } + }, + "OpportunityId": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", + "traits": { + "smithy.api#documentation": "\n Unique identifier of opportunity that was created.\n
" + } + }, + "ResourceSnapshotJobId": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n Unique identifier of the resource snapshot job that was created.\n
" + } + }, + "EngagementInvitationId": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the engagement invitation that was accepted.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Specifies a subset of fields associated with tasks related to accepting an engagement\n invitation.\n
" + } + }, + "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#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": "\n Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask\n tasks that were initiated by the caller's account. \n
", + "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": "\n Use this parameter to control the number of items returned in each request, which can\n be useful for performance tuning and managing large result sets.\n
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Use this parameter for pagination when the result set spans multiple pages. This value\n is obtained from the NextToken field in the response of a previous call to this API.\n
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "Sort": { + "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", + "traits": { + "smithy.api#documentation": "\n Specifies the sorting criteria for the returned results. This allows you to order the\n tasks based on specific attributes.\n
" + } + }, + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "\n Specifies the catalog related to the request. Valid values are:\n
\nAWS: Retrieves the request from the production AWS environment.
\nSandbox: Retrieves the request from a sandbox environment used for testing or\n development purposes.
\n\n Filters the tasks based on their current status. This allows you to focus on tasks in\n specific states.\n
" + } + }, + "OpportunityIdentifier": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", + "traits": { + "smithy.api#documentation": "\n Filters tasks by the identifiers of the opportunities they created or are associated\n with.\n
" + } + }, + "EngagementInvitationIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifiers", + "traits": { + "smithy.api#documentation": "\n Filters tasks by the identifiers of the engagement invitations they are\n processing.\n
" + } + }, + "TaskIdentifier": { + "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", + "traits": { + "smithy.api#documentation": "\n Filters tasks by their unique identifiers. Use this when you want to retrieve\n information about specific tasks. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasksResponse": { + "type": "structure", + "members": { + "TaskSummaries": { + "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTaskSummaries", + "traits": { + "smithy.api#documentation": "\n An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a\n task that matches the specified filters. The array may be empty if no tasks match the\n criteria.\n
\n A token used for pagination to retrieve the next page of results.If there are more\n results available, this field will contain a token that can be used in a subsequent API\n call to retrieve the next page. If there are no more results, this field will be null or\n an empty string.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummary" + } + }, + "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummary": { + "type": "structure", + "members": { + "TaskId": { + "target": "com.amazonaws.partnercentralselling#TaskIdentifier", + "traits": { + "smithy.api#documentation": "\n A unique identifier for a specific task.\n
" + } + }, + "TaskArn": { + "target": "com.amazonaws.partnercentralselling#TaskArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can\n be used for referencing the task in other AWS services or APIs.\n
" + } + }, + "StartTime": { + "target": "com.amazonaws.partnercentralselling#DateTime", + "traits": { + "smithy.api#documentation": "\n The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time\n format.\n
" + } + }, + "TaskStatus": { + "target": "com.amazonaws.partnercentralselling#TaskStatus", + "traits": { + "smithy.api#documentation": "\n The current status of the task.\n
" + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n A detailed message providing additional information about the task, especially useful\n in case of failures. This field may contain error details or other relevant information\n about the task's execution\n
" + } + }, + "ReasonCode": { + "target": "com.amazonaws.partnercentralselling#ReasonCode", + "traits": { + "smithy.api#documentation": "\n A code indicating the specific reason for a task failure. This field is populated when\n the task status is FAILED and provides a categorized reason for the failure.\n
" + } + }, + "OpportunityId": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the original Opportunity from which the Engagement is being\n created. This field helps track the source of the Engagement creation task. \n
" + } + }, + "ResourceSnapshotJobId": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the resource snapshot job associated with this task, if a snapshot\n was created as part of the Engagement creation process.\n
" + } + }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the engagement created as a result of the task. This field is\n populated when the task is completed successfully. \n
" + } + }, + "EngagementInvitationId": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the engagement identifier created as a result of the task. This field is\n populated when the task is completed successfully.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides a summary of a task related to creating an engagement from an opportunity.\n This structure contains key information about the task's status, associated identifiers,\n and any failure details.\n
" + } + }, + "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#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": "\n Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were\n initiated by the caller's account.\n
\n Specifies the maximum number of results to return in a single page of the response.Use\n this parameter to control the number of items returned in each request, which can be\n useful for performance tuning and managing large result sets. \n
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The token for requesting the next page of results. This value is obtained from the\n NextToken field in the response of a previous call to this API. Use this parameter for\n pagination when the result set spans multiple pages.\n
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "Sort": { + "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", + "traits": { + "smithy.api#documentation": "\n Specifies the sorting criteria for the returned results. This allows you to order the\n tasks based on specific attributes. \n
" + } + }, + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", + "traits": { + "smithy.api#documentation": "\n Specifies the catalog related to the request. Valid values are:\n
\nAWS: Retrieves the request from the production AWS environment.
\nSandbox: Retrieves the request from a sandbox environment used for testing or\n development purposes.
\n\n Filters the tasks based on their current status. This allows you to focus on tasks in\n specific states.\n
" + } + }, + "TaskIdentifier": { + "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", + "traits": { + "smithy.api#documentation": "\n Filters tasks by their unique identifiers. Use this when you want to retrieve\n information about specific tasks. \n
" + } + }, + "OpportunityIdentifier": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", + "traits": { + "smithy.api#documentation": "\n The identifier of the original opportunity associated with this task.\n
" + } + }, + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", + "traits": { + "smithy.api#documentation": "\n Filters tasks by the identifiers of the engagements they created or are associated\n with.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasksResponse": { + "type": "structure", + "members": { + "TaskSummaries": { + "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummaries", + "traits": { + "smithy.api#documentation": "\n TaskSummaries An array of TaskSummary objects containing details about each\n task.\n
" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n A token used for pagination to retrieve the next page of results. If there are more\n results available, this field will contain a token that can be used in a subsequent API\n call to retrieve the next page. If there are no more results, this field will be null or\n an empty string.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#ListEngagementInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#ListEngagementInvitationsResponse" + }, + "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 Engagement Invitations on AWS Partner Central" + }, + "smithy.api#documentation": "Retrieves a list of engagement invitations sent to the partner. This allows partners\n to view all pending or past engagement invitations, helping them track opportunities\n 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\n AWS for production invitations or Sandbox for testing\n environments.
Specifies the maximum number of engagement invitations to return in the response. If\n 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\n previous request was truncated. Pass this token to continue listing invitations from\n 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\n sorted by fields such as InvitationDate or Status to help\n partners view results in their preferred order.
Defines the type of payload associated with the engagement invitations to be listed.\n The attributes in this payload help decide on acceptance or rejection of the\n invitation.
" + } + }, + "ParticipantType": { + "target": "com.amazonaws.partnercentralselling#ParticipantType", + "traits": { + "smithy.api#documentation": "Specifies the type of participant for which to list engagement invitations. Identifies\n the role of the participant.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.partnercentralselling#InvitationStatusList", + "traits": { + "smithy.api#documentation": "\n Status values to filter the invitations.\n
" + } + }, + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", + "traits": { + "smithy.api#documentation": "\n Retrieves a list of engagement invitation summaries based on specified filters. The\n ListEngagementInvitations operation allows you to view all invitations that you have\n sent or received. You must specify the ParticipantType to filter invitations where you\n are either the SENDER or the RECEIVER. Invitations will automatically expire if not\n accepted within 15 days.\n
" + } + }, + "SenderAwsAccountId": { + "target": "com.amazonaws.partnercentralselling#AwsAccountIdOrAliasList", + "traits": { + "smithy.api#documentation": "\n List of sender AWS account IDs to filter the invitations.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementInvitationsResponse": { + "type": "structure", + "members": { + "EngagementInvitationSummaries": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationSummaries", + "traits": { + "smithy.api#documentation": "An array containing summaries of engagement invitations. Each summary includes\n information such as the invitation title, invitation date, and the current status of the\n invitation.
" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A pagination token returned when there are more results available than can be returned\n in a single call. Use this token to retrieve additional pages of engagement invitation\n summaries.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#ListEngagementMembersRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#ListEngagementMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "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 engagement members in AWS Partner Central" + }, + "smithy.api#documentation": "\n Retrieves the details of member partners in an engagement. This operation can only be\n invoked by members of the engagement. The ListEngagementMembers operation allows you to\n fetch information about the members of a specific engagement. This action is restricted\n to members of the engagement being queried.\n
\n The catalog related to the request. \n
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.partnercentralselling#EngagementArnOrIdentifier", + "traits": { + "smithy.api#documentation": "\n Identifier of the engagement record to retrieve members from.\n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.partnercentralselling#MemberPageSize", + "traits": { + "smithy.api#default": 5, + "smithy.api#documentation": "\n The maximum number of results to return in a single call.\n
" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The token for the next set of results.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementMembersResponse": { + "type": "structure", + "members": { + "EngagementMemberList": { + "target": "com.amazonaws.partnercentralselling#EngagementMembers", + "traits": { + "smithy.api#documentation": "\nProvides a list of engagement members.\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n A pagination token used to retrieve the next set of results. If there are more results\n available than can be returned in a single response, this token will be present. Use\n this token in a subsequent request to retrieve the next page of results. If there are no\n more results, this value will be null.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementResourceAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#ListEngagementResourceAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#ListEngagementResourceAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "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 engagement resource associations in AWS Partner Central" + }, + "smithy.api#documentation": "\n Lists the associations between resources and engagements where the caller is a member\n and has at least one snapshot in the engagement. \n
", + "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": "\n Specifies the catalog in which to search for engagement-resource associations.\n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.partnercentralselling#PageSize", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "\n Limits the number of results returned in a single call. Use this to control the number\n of results returned, especially useful for pagination.\n
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n A token used for pagination of results. Include this token in subsequent requests to\n retrieve the next set of results.\n
" + } + }, + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n Filters the results to include only associations related to the specified engagement.\n Use this when you want to find all resources associated with a specific engagement.\n
" + } + }, + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", + "traits": { + "smithy.api#documentation": "\n Filters the results to include only associations with resources of the specified type.\n
" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "\n Filters the results to include only associations with the specified resource. Varies\n depending on the resource type. Use this when you want to find all engagements\n associated with a specific resource.\n
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", + "traits": { + "smithy.api#documentation": "\n Filters the results to include only associations with resources owned by the specified\n AWS account. Use this when you want to find associations related to resources owned by a\n particular account.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagementResourceAssociationsResponse": { + "type": "structure", + "members": { + "EngagementResourceAssociationSummaries": { + "target": "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummaryList", + "traits": { + "smithy.api#documentation": "\n A list of engagement-resource association summaries.\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n A token to retrieve the next set of results. Use this token in a subsequent request to\n retrieve additional results if the response was truncated.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListEngagements": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#ListEngagementsRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#ListEngagementsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "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 in AWS Partner Central" + }, + "smithy.api#documentation": "\n This action allows users to retrieve a list of engagement records from Partner\n Central. This action can be used to manage and track various engagements across\n different stages of the partner selling process.\n
", + "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": "\n Specifies the catalog related to the request.\n
", + "smithy.api#required": {} } }, - "CHANGE_IN_DEAL_INFORMATION": { - "target": "smithy.api#Unit", + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { - "smithy.api#enumValue": "Change in Deal Information" + "smithy.api#documentation": "\n A list of AWS account IDs. When specified, the response includes engagements created\n by these accounts. This filter is useful for finding engagements created by specific\n team members.\n
" } }, - "CUSTOMER_REQUESTED": { - "target": "smithy.api#Unit", + "ExcludeCreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { - "smithy.api#enumValue": "Customer Requested" + "smithy.api#documentation": "\n An array of strings representing AWS Account IDs. Use this to exclude engagements\n created by specific users.\n
" } }, - "TECHNICAL_COMPLEXITY": { - "target": "smithy.api#Unit", + "Sort": { + "target": "com.amazonaws.partnercentralselling#EngagementSort", "traits": { - "smithy.api#enumValue": "Technical Complexity" + "smithy.api#documentation": "\n An object that specifies the sort order of the results.\n
" } }, - "RISK_MITIGATION": { - "target": "smithy.api#Unit", + "MaxResults": { + "target": "com.amazonaws.partnercentralselling#EngagementPageSize", "traits": { - "smithy.api#enumValue": "Risk Mitigation" + "smithy.api#default": 20, + "smithy.api#documentation": "\n The maximum number of results to return in a single call.\n
" } - } - } - }, - "com.amazonaws.partnercentralselling#JobTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 80 }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.partnercentralselling#LastModifiedDate": { - "type": "structure", - "members": { - "AfterLastModifiedDate": { - "target": "com.amazonaws.partnercentralselling#DateTime", + "NextToken": { + "target": "smithy.api#String", "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.
" + "smithy.api#documentation": "\n The token for the next set of results. This value is returned from a previous\n call.\n
" } }, - "BeforeLastModifiedDate": { - "target": "com.amazonaws.partnercentralselling#DateTime", + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "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.
" + "smithy.api#documentation": "\n An array of strings representing engagement identifiers to retrieve.\n
" } } }, "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.
" + "smithy.api#input": {} } }, - "com.amazonaws.partnercentralselling#LifeCycle": { + "com.amazonaws.partnercentralselling#ListEngagementsResponse": { "type": "structure", "members": { - "Stage": { - "target": "com.amazonaws.partnercentralselling#Stage", + "EngagementSummaryList": { + "target": "com.amazonaws.partnercentralselling#EngagementSummaryList", "traits": { - "smithy.api#documentation": "\n 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.\n
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.
\n The descriptions of each sales stage are:\n
\n\n 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).\n
\n\n 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.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\n\n An array of engagement summary objects.\n
", + "smithy.api#required": {} } }, - "ClosedLostReason": { - "target": "com.amazonaws.partnercentralselling#ClosedLostReason", + "NextToken": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n Specifies the reason code when an opportunity is marked as Closed Lost. When you select an\n appropriate reason code, you communicate the context for closing the Opportunity,\n and aid in accurate reports and analysis of opportunity outcomes. The possible values are:\n
Customer Deficiency: The customer lacked necessary resources or capabilities.
\nDelay/Cancellation of Project: The project was delayed or canceled.
\nLegal/Tax/Regulatory: Legal, tax, or regulatory issues prevented progress.
\nLost to Competitor—Google: The opportunity was lost to Google.
\nLost to Competitor—Microsoft: The opportunity was lost to Microsoft.
\nLost to Competitor—SoftLayer: The opportunity was lost to SoftLayer.
\nLost to Competitor—VMWare: The opportunity was lost to VMWare.
\nLost to Competitor—Other: The opportunity was lost to a competitor not listed above.
\nNo Opportunity: There was no opportunity to pursue.
\nOn Premises Deployment: The customer chose an on-premises solution.
\nPartner Gap: The partner lacked necessary resources or capabilities.
\nPrice: The price was not competitive or acceptable to the customer.
\nSecurity/Compliance: Security or compliance issues prevented progress.
\nTechnical Limitations: Technical limitations prevented progress.
\nCustomer Experience: Issues related to the customer's experience impacted the decision.
\nOther: Any reason not covered by the other values.
\nPeople/Relationship/Governance: Issues related to people, relationships, or governance.
\nProduct/Technology: Issues related to the product or technology.
\nFinancial/Commercial: Financial or commercial issues impacted the decision.
\n\n The token to retrieve the next set of results. This field will be null if there are no\n more results.\n
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.partnercentralselling#ListOpportunities": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#ListOpportunitiesRequest" + }, + "output": { + "target": "com.amazonaws.partnercentralselling#ListOpportunitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, - "NextSteps": { - "target": "com.amazonaws.partnercentralselling#PiiString", - "traits": { - "smithy.api#documentation": "Specifies the upcoming actions or tasks for the Opportunity. Use this field\n to communicate with Amazon Web Services about the next actions required for the Opportunity.\n
This request accepts a list of filters that retrieve opportunity subsets as well as\n sort options. This feature is available to partners from Partner Central using the\n ListOpportunities API action.
To synchronize your system with Amazon Web Services, only list the opportunities that\n were newly created or updated. We recommend you rely on events emitted by the service\n into your Amazon Web Services account’s Amazon EventBridge default event bus, you can\n also use the ListOpportunities action.
We recommend the following approach:
\nFind the latest LastModifiedDate that you stored, and only use\n the values that came from Amazon Web Services. Don’t use values generated by your\n system.
When you send a ListOpportunities request, submit the date in ISO\n 8601 format in the AfterLastModifiedDate filter.
Amazon Web Services only returns opportunities created or updated on or after\n that date and time. Use NextToken to iterate over all pages.
\n 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.\n
\n\n Ensure the Target Close Date isn't in the past.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunities are listed in. Use AWS for listing real\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.
\n Indicates the review status of an opportunity referred by a partner. This field is read-only\n and only applicable for partner referrals. The possible values are:\n
\n\n Pending Submission: Not submitted for validation (editable).\n
\n\n Submitted: Submitted for validation, and Amazon Web Services hasn't reviewed it (read-only).\n
\n\n In Review: Amazon Web Services is validating (read-only).\n
\n\n Action Required: Issues that Amazon Web Services highlights need to be addressed.\n Partners should use the UpdateOpportunity API action to update the opportunity and helps to ensure that all required changes are made.\n Only the following fields are editable when the Lifecycle.ReviewStatus is Action Required:\n
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedMonthlyAWSRevenue.Amount
\nProject.ExpectedMonthlyAWSRevenue.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\n\n 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.\n
\n Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).\n
\n\n Rejected: Disqualified (read-only).\n
\nSpecifies the maximum number of results to return in a single call. This limits the\n number of opportunities returned in the response to avoid providing too many results at\n once.
\nDefault: 20
" } }, - "ReviewComments": { + "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.
" } }, - "ReviewStatusReason": { - "target": "smithy.api#String", + "Sort": { + "target": "com.amazonaws.partnercentralselling#OpportunitySort", "traits": { - "smithy.api#documentation": "\n Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.\n
" + "smithy.api#documentation": "An object that specifies how the response is sorted. The default\n Sort.SortBy value is LastModifiedDate.
Captures a chronological record of the next steps or actions planned or taken for the current opportunity,\n along with the timestamp.\n
", - "smithy.api#length": { - "max": 50 - } - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains the Opportunity lifecycle's details.\n
\n 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.\n
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.
\n The descriptions of each sales stage are:\n
\n\n 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).\n
\n\n 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.\n
\n\n Technical Validation: All parties understand the implementation plan.\n
\n\n Business Validation: Pricing was proposed, and all parties agree to the steps to close.\n
\n\n Committed: The customer signed the contract, but Amazon Web Services hasn't started billing.\n
\n\n Launched: The workload is complete, and Amazon Web Services has started billing.\n
\n\n Closed Lost: The opportunity is lost, and there are no steps to move forward.\n
\nFilters the opportunities based on their last modified date. This filter helps\n retrieve opportunities that were updated after the specified date, allowing partners to\n track recent changes or updates.
" } }, - "ClosedLostReason": { - "target": "com.amazonaws.partnercentralselling#ClosedLostReason", + "Identifier": { + "target": "com.amazonaws.partnercentralselling#FilterIdentifier", "traits": { - "smithy.api#documentation": "Specifies the reason code when an opportunity is marked as Closed Lost. When you select an\n appropriate reason code, you communicate the context for closing the Opportunity,\n and aid in accurate reports and analysis of opportunity outcomes.\n
Filters the opportunities based on the opportunity identifier. This allows partners to\n retrieve specific opportunities by providing their unique identifiers, ensuring precise\n results.
", + "smithy.api#length": { + "max": 20 + } } }, - "NextSteps": { - "target": "com.amazonaws.partnercentralselling#PiiString", + "LifeCycleStage": { + "target": "com.amazonaws.partnercentralselling#FilterLifeCycleStage", "traits": { - "smithy.api#documentation": "Specifies the upcoming actions or tasks for the Opportunity. This field\n is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.\n
Filters the opportunities based on their lifecycle stage. This filter allows partners\n to retrieve opportunities at various stages in the sales cycle, such as\n Qualified, Technical Validation, Business\n Validation, or Closed Won.
\n 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.\n
\n\n Ensure the Target Close Date isn't in the past.\n
Filters the opportunities based on their current lifecycle approval status. Use this\n filter to retrieve opportunities with statuses such as Pending Submission,\n In Review, Action Required, or\n Approved.
\n Indicates the review status of a partner referred opportunity. This field is read-only\n and only applicable for partner referrals. Valid values:\n
\n\n Pending Submission: Not submitted for validation (editable).\n
\n\n Submitted: Submitted for validation and not yet Amazon Web Services reviewed (read-only).\n
\n\n In Review: Undergoing Amazon Web Services validation (read-only).\n
\n\n Action Required: Address any issues Amazon Web Services highlights.\n Use the UpdateOpportunity API action to update the opportunity, and ensure you make all required changes.\n Only these fields are editable when the Lifecycle.ReviewStatus is Action Required:\n
Customer.Account.Address.City
\nCustomer.Account.Address.CountryCode
\nCustomer.Account.Address.PostalCode
\nCustomer.Account.Address.StateOrRegion
\nCustomer.Account.Address.StreetAddress
\nCustomer.Account.WebsiteUrl
\nLifeCycle.TargetCloseDate
\nProject.ExpectedCustomerSpend.Amount
\nProject.ExpectedCustomerSpend.CurrencyCode
\nProject.CustomerBusinessProblem
\nPartnerOpportunityIdentifier
\n\n 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.\n
\n Approved: Validated and converted into the Amazon Web Services seller's pipeline (editable).\n
\n\n Rejected: Disqualified (read-only).\n
\nFilters the opportunities based on the customer's company name. This allows partners\n to search for opportunities associated with a specific customer by matching the provided\n company name string.
", + "smithy.api#length": { + "max": 10 + } } - }, - "ReviewComments": { - "target": "smithy.api#String", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#ListOpportunitiesResponse": { + "type": "structure", + "members": { + "OpportunitySummaries": { + "target": "com.amazonaws.partnercentralselling#OpportunitySummaries", "traits": { - "smithy.api#documentation": "Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.
An array that contains minimal details for opportunities that match the request\n criteria. This summary view provides a quick overview of relevant opportunities.
", + "smithy.api#required": {} } }, - "ReviewStatusReason": { + "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n 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.\n
" + "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.
" } } }, "traits": { - "smithy.api#documentation": "An object that contains a LifeCycle object's subset of fields.\n
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#documentation": "\n Lists resource snapshot jobs owned by the customer. This operation supports various\n filtering scenarios, including listing all jobs owned by the caller, jobs for a specific\n engagement, jobs with a specific status, or any combination of these filters.\n
", "smithy.api#http": { "method": "POST", - "uri": "/ListEngagementInvitations", + "uri": "/ListResourceSnapshotJobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", - "items": "EngagementInvitationSummaries" + "items": "ResourceSnapshotJobSummaries" }, "smithy.api#readonly": {} } }, - "com.amazonaws.partnercentralselling#ListEngagementInvitationsRequest": { + "com.amazonaws.partnercentralselling#ListResourceSnapshotJobsRequest": { "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.
\n Specifies the catalog related to the request.\n
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { - "smithy.api#documentation": "Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
" + "smithy.api#default": 100, + "smithy.api#documentation": "\n The maximum number of results to return in a single call. If omitted, defaults to\n 50.\n
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } } }, "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.
" + "smithy.api#documentation": "\n The token for the next set of results.\n
" } }, - "Sort": { - "target": "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSort", + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "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.
\n The identifier of the engagement to filter the response.\n
" } }, - "PayloadType": { - "target": "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType", + "Status": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "\n The status of the jobs to filter the response.\n
" } }, - "ParticipantType": { - "target": "com.amazonaws.partnercentralselling#ParticipantType", + "Sort": { + "target": "com.amazonaws.partnercentralselling#SortObject", "traits": { - "smithy.api#documentation": "Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
", - "smithy.api#required": {} + "smithy.api#documentation": "\n Configures the sorting of the response. If omitted, results are sorted by CreatedDate\n in descending order.\n
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.
" + "smithy.api#documentation": "\n An array of resource snapshot job summary objects.\n
", + "smithy.api#required": {} } }, "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.
" + "smithy.api#documentation": "\n The token to retrieve the next set of results. If there are no additional results,\n this value is null. \n
" } } }, @@ -6130,21 +8777,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.partnercentralselling#ListOpportunities": { + "com.amazonaws.partnercentralselling#ListResourceSnapshots": { "type": "operation", "input": { - "target": "com.amazonaws.partnercentralselling#ListOpportunitiesRequest" + "target": "com.amazonaws.partnercentralselling#ListResourceSnapshotsRequest" }, "output": { - "target": "com.amazonaws.partnercentralselling#ListOpportunitiesResponse" + "target": "com.amazonaws.partnercentralselling#ListResourceSnapshotsResponse" }, "errors": [ { "target": "com.amazonaws.partnercentralselling#AccessDeniedException" }, - { - "target": "com.amazonaws.partnercentralselling#InternalServerException" - }, { "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" }, @@ -6160,104 +8804,79 @@ "partnercentral:Catalog" ], "aws.iam#iamAction": { - "documentation": "Grants permission to list Opportunities on AWS Partner Central" - }, - "smithy.api#documentation": "This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from\n Partner Central\n using the ListOpportunities API action.\n
To synchronize your system with Amazon Web Services, only list the opportunities that were\n newly created or updated.\n We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default\n event bus, you can also use the ListOpportunities action.\n
We recommend the following approach:
\nFind the latest LastModifiedDate that you stored, and only use the values that came\n from Amazon Web Services. Don’t use values generated by your system.\n
When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.\n
Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.\n
\n Retrieves a list of resource view snapshots based on specified criteria. \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListResourceSnapshots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "ResourceSnapshotSummaries" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.partnercentralselling#ListOpportunitiesRequest": { + "com.amazonaws.partnercentralselling#ListResourceSnapshotsRequest": { "type": "structure", "members": { "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunities are listed in.\n Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox\n for testing in secure, isolated environments.\n
\n Specifies the catalog related to the request.\n
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { - "smithy.api#documentation": "\n 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.\n
\n\n Default: 20\n
" + "smithy.api#default": 100, + "smithy.api#documentation": "\n The maximum number of results to return in a single call.\n
", + "smithy.api#range": { + "min": 1, + "max": 1000 + } } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n 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.\n
" - } - }, - "Sort": { - "target": "com.amazonaws.partnercentralselling#OpportunitySort", - "traits": { - "smithy.api#documentation": "\n An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.\n
\n The token for the next set of results.\n
" } }, - "LastModifiedDate": { - "target": "com.amazonaws.partnercentralselling#LastModifiedDate", + "EngagementIdentifier": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "\n The unique identifier of the engagement associated with the snapshots.\n
", + "smithy.api#required": {} } }, - "Identifier": { - "target": "com.amazonaws.partnercentralselling#FilterIdentifier", + "ResourceType": { + "target": "com.amazonaws.partnercentralselling#ResourceType", "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 - } + "smithy.api#documentation": "\n Filters the response to include only snapshots of the specified resource type.\n
" } }, - "LifeCycleStage": { - "target": "com.amazonaws.partnercentralselling#FilterLifeCycleStage", + "ResourceIdentifier": { + "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "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.
\n Filters the response to include only snapshots of the specified resource.\n
" } }, - "LifeCycleReviewStatus": { - "target": "com.amazonaws.partnercentralselling#FilterLifeCycleReviewStatus", + "ResourceSnapshotTemplateIdentifier": { + "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "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.
\n Filters the response to include only snapshots created using the specified\n template.\n
" } }, - "CustomerCompanyName": { - "target": "com.amazonaws.partnercentralselling#StringList", + "CreatedBy": { + "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "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 - } + "smithy.api#documentation": "\n Filters the response to include only snapshots of resources created by the specified AWS\n account.\n
" } } }, @@ -6265,20 +8884,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.partnercentralselling#ListOpportunitiesResponse": { + "com.amazonaws.partnercentralselling#ListResourceSnapshotsResponse": { "type": "structure", "members": { - "OpportunitySummaries": { - "target": "com.amazonaws.partnercentralselling#OpportunitySummaries", + "ResourceSnapshotSummaries": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotSummaryList", "traits": { - "smithy.api#documentation": "\n An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.\n
", + "smithy.api#documentation": "\n An array of resource snapshot summary objects.\n
", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n 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.\n
" + "smithy.api#documentation": "\n The token to retrieve the next set of results. If there are no additional results,\n this value is null. \n
" } } }, @@ -6315,7 +8934,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Solutions on AWS Partner Central" }, - "smithy.api#documentation": "\n 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.\n
", + "smithy.api#documentation": "Retrieves a list of Partner Solutions that the partner registered on Partner Central.\n This API is used to generate a list of solutions that an end user selects from for\n association with an opportunity.
", "smithy.api#http": { "method": "POST", "uri": "/ListSolutions", @@ -6336,32 +8955,32 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the solutions are listed in.\n Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions\n in a secure and isolated testing environment.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the solutions are listed in. Use AWS to list solutions in\n the Amazon Web Services catalog, and Sandbox to list solutions in a secure\n and isolated testing environment.
The maximum number of results returned by a single call. This value must be provided in the next call to\n retrieve the next set of results.\n
\nDefault: 20
" + "smithy.api#documentation": "The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results.
\nDefault: 20
" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n 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.\n
" + "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.
" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#SolutionSort", "traits": { - "smithy.api#documentation": "Object that configures sorting done on the response. Default Sort.SortBy is Identifier.\n
Object that configures sorting done on the response. Default Sort.SortBy\n is Identifier.
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
", + "smithy.api#documentation": "Filters solutions based on their status. This filter helps partners manage their\n solution portfolios effectively.
", "smithy.api#length": { "max": 10 } @@ -6370,7 +8989,7 @@ "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#documentation": "Filters the solutions based on their unique identifier. Use this filter to retrieve\n specific solutions by providing the solution's identifier for accurate results.
", "smithy.api#length": { "max": 20 } @@ -6379,7 +8998,7 @@ "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 the solutions based on the category to which they belong. This allows partners\n to search for solutions within specific categories, such as Software,\n Consulting, or Managed Services.
\n 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.\n
" + "smithy.api#documentation": "A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.
" } } }, @@ -6411,42 +9030,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.partnercentralselling#ListTasksSortBase": { + "type": "structure", + "members": { + "SortOrder": { + "target": "com.amazonaws.partnercentralselling#SortOrder", + "traits": { + "smithy.api#documentation": "\n Determines the order in which the sorted results are presented.\n
", + "smithy.api#required": {} + } + }, + "SortBy": { + "target": "com.amazonaws.partnercentralselling#ListTasksSortName", + "traits": { + "smithy.api#documentation": "\n Specifies the field by which the task list should be sorted.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Defines the sorting parameters for listing tasks. This structure allows for specifying\n the field to sort by and the order of sorting.\n
" + } + }, + "com.amazonaws.partnercentralselling#ListTasksSortName": { + "type": "enum", + "members": { + "START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartTime" + } + } + } + }, "com.amazonaws.partnercentralselling#Marketing": { "type": "structure", "members": { "CampaignName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the Opportunity marketing campaign code. The Amazon Web Services\n campaign code is a reference to specific marketing initiatives, promotions, or\n activities. This field captures the identifier used to track and\n categorize the Opportunity within marketing campaigns. If you don't have a campaign\n code, contact your Amazon Web Services point of contact to obtain one.\n
Specifies the Opportunity marketing campaign code. The Amazon Web Services\n campaign code is a reference to specific marketing initiatives, promotions, or\n activities. This field captures the identifier used to track and categorize the\n Opportunity within marketing campaigns. If you don't have a campaign\n code, contact your Amazon Web Services point of contact to obtain one.
\n 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.\n
Indicates if the Opportunity was sourced from an Amazon Web Services\n marketing activity. Use the value Marketing Activity. Use None\n if it's not associated with an Amazon Web Services marketing activity. This field helps\n Amazon Web Services track the return on marketing investments and enables better\n distribution of marketing budgets among partners.
\n 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.\n
\n 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\n
Specifies the marketing activity use case or purpose that led to the\n Opportunity's creation or contact. This field captures the context or\n marketing activity's execution's intention and the direct correlation to the generated\n opportunity or contact. Must be empty when Marketing.AWSFundingUsed =\n No.
Valid values: AI/ML | Analytics | Application Integration | Blockchain |\n Business Applications | Cloud Financial Management | Compute | Containers | Customer\n Engagement | Databases | Developer Tools | End User Computing | Front End Web &\n Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration\n & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics\n | Satellite | Security | Serverless | Storage | VR & AR\n
Specifies the Opportunity's channel that the marketing activity is associated with or\n was contacted through. This field provides information about the specific marketing\n channel that contributed to the generation of the lead or contact.\n
Specifies the Opportunity's channel that the marketing activity is\n associated with or was contacted through. This field provides information about the\n specific marketing channel that contributed to the generation of the lead or\n contact.
Indicates if the Opportunity is a marketing development fund (MDF) funded\n activity.\n
Indicates if the Opportunity is a marketing development fund (MDF) funded\n activity.
An object that contains marketing details for the Opportunity.\n
An object that contains marketing details for the Opportunity.
Read-only; shows the last 50 values and change dates for the NextSteps field.
Read-only; shows the last 50 values and change dates for the NextSteps\n field.
Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).
Defines the order in which the Engagement Invitations are sorted. The values can be\n ASC (ascending) or DESC (descending).
Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
Specifies the field by which the Engagement Invitations are sorted. Common values\n 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.
" + "smithy.api#documentation": "Defines sorting options for retrieving Engagement Invitations. Sorting can be done\n based on various criteria like the invitation date or status.
" } }, "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSortName": { @@ -6629,39 +9309,51 @@ "smithy.api#pattern": "^O[0-9]{1,19}$" } }, + "com.amazonaws.partnercentralselling#OpportunityIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier" + }, + "traits": { + "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.
" + "smithy.api#documentation": "Represents the contact details of the AWS representatives involved in sending the\n 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#documentation": "Outlines the responsibilities or expectations of the receiver in the context of the\n 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’s profile and requirements.
", + "smithy.api#documentation": "Contains information about the customer related to the opportunity in the Engagement\n Invitation. This data helps partners understand the customer’s profile and\n 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’s needs and the scope of work expected to be performed.
", + "smithy.api#documentation": "Describes the project details associated with the opportunity, including the\n customer’s needs and the scope of work expected to be performed.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.
" + "smithy.api#documentation": "Represents the data payload of an Engagement Invitation for a specific opportunity.\n This contains detailed information that partners use to evaluate the engagement.
" } }, "com.amazonaws.partnercentralselling#OpportunityOrigin": { @@ -6687,7 +9379,7 @@ "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { - "smithy.api#documentation": "Sort order.
\nDefault:\n Descending\n
Sort order.
\nDefault: Descending\n
Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.
Specifies the catalog associated with the opportunity, either AWS or\n Sandbox. This indicates the environment in which the opportunity is\n managed.
Read-only, system-generated Opportunity unique identifier.\n
Read-only, system-generated Opportunity unique identifier.
\n The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier\n can be used for IAM policies and cross-service references. \n
" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the Opportunity's unique identifier in the partner's CRM system. This value is\n essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link\n an opportunity to\n their CRM.\n
Specifies the Opportunity's unique identifier in the partner's CRM\n system. This value is essential to track and reconcile because it's included in the\n outbound payload sent back to the partner. It allows partners to link an opportunity to\n their CRM.
\n Specifies opportunity type as a renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New Opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal Opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.\n
\n\n Expansion Opportunity:\n 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.\n
\nSpecifies opportunity type as a renewal, new, or expansion.
\nOpportunity types:
\nNew Opportunity: Represents a new business opportunity with a potential\n customer that's not previously engaged with your solutions or services.
\nRenewal Opportunity: Represents an opportunity to renew an existing contract\n or subscription with a current customer, ensuring continuity of service.
\nExpansion Opportunity: Represents an opportunity to expand the scope of an\n existing contract or subscription, either by adding new services or increasing\n the volume of existing services for a current customer.
\n\n DateTime\n when the Opportunity was last modified.\n
\n DateTime when the Opportunity was last modified.
\n DateTime\n when the Opportunity was last created.\n
\n DateTime when the Opportunity was last created.
An object that contains the Opportunity's lifecycle details.\n
An object that contains the Opportunity's lifecycle details.
An object that contains the Opportunity's customer details.\n
An object that contains the Opportunity's customer details.
An object that contains the Opportunity's project details summary.\n
An object that contains the Opportunity's project details summary.
An object that contains an Opportunity's subset of fields.
\n Specifies the opportunity type.\n
" + } + }, + "Lifecycle": { + "target": "com.amazonaws.partnercentralselling#LifeCycleForView", + "traits": { + "smithy.api#documentation": "\n Contains information about the opportunity's lifecycle, including its current stage,\n status, and important dates such as creation and last modification times.\n
" + } + }, + "OpportunityTeam": { + "target": "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList", + "traits": { + "smithy.api#documentation": "\n Represents the internal team handling the opportunity. Specify the members involved in\n collaborating on an opportunity within the partner's organization. \n
" + } + }, + "PrimaryNeedsFromAws": { + "target": "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws", + "traits": { + "smithy.api#documentation": "\n Identifies the type of support the partner needs from AWS.\n
" + } + }, + "Customer": { + "target": "com.amazonaws.partnercentralselling#Customer" + }, + "Project": { + "target": "com.amazonaws.partnercentralselling#ProjectView", + "traits": { + "smithy.api#documentation": "\n Contains summary information about the project associated with the opportunity,\n including project name, description, timeline, and other relevant details.\n
" } + }, + "RelatedEntityIdentifiers": { + "target": "com.amazonaws.partnercentralselling#RelatedEntityIdentifiers" } }, "traits": { - "smithy.api#documentation": "An object that contains an Opportunity's subset of fields.\n
\n Provides a comprehensive view of an opportunity summary, including lifecycle\n information, team details, opportunity type, primary needs from AWS, and associated\n project information.\n
" } }, "com.amazonaws.partnercentralselling#OpportunityType": { @@ -6830,6 +9572,12 @@ "com.amazonaws.partnercentralselling#ParticipantType": { "type": "enum", "members": { + "SENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENDER" + } + }, "RECEIVER": { "target": "smithy.api#Unit", "traits": { @@ -6855,12 +9603,12 @@ "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.
" + "smithy.api#documentation": "Specifies the details of the opportunity invitation within the Engagement Invitation\n payload. This data helps partners understand the context, scope, and expected\n involvement for the opportunity from AWS.
" } } }, "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.
" + "smithy.api#documentation": "Contains the data payload associated with the Engagement Invitation. This payload\n includes essential details related to the AWS opportunity and is used by partners to\n evaluate whether to accept or reject the engagement.
" } }, "com.amazonaws.partnercentralselling#PaymentFrequency": { @@ -6961,20 +9709,20 @@ "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#documentation": "Represents the details of the next step recorded, such as follow-up actions or\n decisions made. This field helps in tracking progress and ensuring alignment with\n 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#documentation": "Indicates the date and time when a particular next step was recorded or planned. This\n 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.
" + "smithy.api#documentation": "Tracks the history of next steps associated with the opportunity. This field captures\n the actions planned for the future and their timeline.
" } }, "com.amazonaws.partnercentralselling#Project": { @@ -6983,19 +9731,19 @@ "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { - "smithy.api#documentation": "\n Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.\n
\n Options' descriptions from the Delivery Model field are:\n
SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.
\nBYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.
\nManaged Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).
\nProfessional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).
\nResell: Amazon Web Services accounts and billing management for your customers.
\nOther: Delivery model not described above.
\nSpecifies the deployment or consumption model for your solution or service in the\n 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\n in your Amazon Web Services environment.
\nBYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in\n the end customer's Amazon Web Services environment.
\nManaged Services: The end customer's Amazon Web Services business management\n (For example: Consulting, design, implementation, billing support, cost\n optimization, technical support).
\nProfessional Services: Offerings to help enterprise end customers achieve\n specific business outcomes for enterprise cloud adoption (For example: Advisory\n or transformation planning).
\nResell: Amazon Web Services accounts and billing management for your\n customers.
\nOther: Delivery model not described above.
\nRepresents 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.
" + "smithy.api#documentation": "Represents the estimated amount that the customer is expected to spend on AWS services\n related to the opportunity. This helps in evaluating the potential financial value of\n the opportunity for AWS.
" } }, "Title": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "Specifies the Opportunity's title or name.\n
Specifies the Opportunity's title or name.
\n 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.\n
\n 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\n
Specifies the Amazon Partner Network (APN) program that influenced the\n Opportunity. APN programs refer to specific partner programs or\n initiatives that can impact the Opportunity.
Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to\n Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload\n Migration | Migration Acceleration Program | P3 | Partner Launch Initiative |\n Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS |\n Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS\n NDPP\n
Describes the problem the end customer has, and how the partner is helping.\n Utilize this field to provide a concise narrative that outlines the customer's business challenge or\n issue.\n Elaborate on how the partner's solution or offerings align to resolve the customer's business problem.\n Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue.\n Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise\n language and precise descriptions to convey the context and significance of the Opportunity.\n The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic\n fit of the partner's solution.\n
Describes the problem the end customer has, and how the partner is helping. Utilize\n this field to provide a concise narrative that outlines the customer's business\n challenge or issue. Elaborate on how the partner's solution or offerings align to\n resolve the customer's business problem. Include relevant information about the\n partner's value proposition, unique selling points, and expertise to tackle the issue.\n Offer insights on how the proposed solution meets the customer's needs and provides\n value. Use concise language and precise descriptions to convey the context and\n significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic\n fit of the partner's solution.
\n 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.\n
\n\n 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\n
Specifies the proposed solution focus or type of workload for the Opportunity. This\n field captures the primary use case or objective of the proposed solution, and provides\n context and clarity to the addressed workload.
\nValid values: AI Machine Learning and Analytics | Archiving | Big Data: Data\n Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications:\n Mainframe Modernization | Business Applications & Contact Center | Business\n Applications & SAP Production | Centralized Operations Management | Cloud\n Management Tools | Cloud Management Tools & DevOps with Continuous Integration\n & Continuous Delivery (CICD) | Configuration, Compliance & Auditing |\n Connected Services | Containers & Serverless | Content Delivery & Edge\n Services | Database | Edge Computing/End User Computing | Energy | Enterprise\n Governance & Controls | Enterprise Resource Planning | Financial Services |\n Healthcare and Life Sciences | High Performance Computing | Hybrid Application\n Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations |\n Media & High performance computing (HPC) | Migration/Database Migration |\n Monitoring, logging and performance | Monitoring & Observability | Networking |\n Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC |\n VMWare | Web development & DevOps\n
Specifies the current opportunity's parent opportunity identifier.\n
" + "smithy.api#documentation": "Specifies the current opportunity's parent opportunity identifier.
" } }, "SalesActivities": { "target": "com.amazonaws.partnercentralselling#SalesActivities", "traits": { - "smithy.api#documentation": "\n Specifies the Opportunity's sales activities conducted with the end customer.\n These activities help drive Amazon Web Services assignment priority.\n
\n Valid values:\n
\n\n Initialized discussions with customer: Initial conversations with the customer to understand their needs and introduce your solution.\n
\n\n Customer has shown interest in solution: After initial discussions, the customer is interested in your solution.\n
\n\n Conducted POC/demo: You conducted a proof of concept (POC) or demonstration of the solution for the customer.\n
\n\n In evaluation/planning stage: The customer is evaluating the solution and planning potential implementation.\n
\n\n Agreed on solution to Business Problem: Both parties agree on how the solution addresses the customer's business problem.\n
\n\n Completed Action Plan: A detailed action plan is complete and outlines the steps for implementation.\n
\n\n Finalized Deployment Need: Both parties agree with and finalized the deployment needs.\n
\n\n SOW Signed: Both parties signed a statement of work (SOW), and formalize the agreement and detail the project scope and deliverables.\n
\nSpecifies the Opportunity's sales activities conducted with the end\n customer. These activities help drive Amazon Web Services assignment priority.
Valid values:
\nInitialized discussions with customer: Initial conversations with the customer\n to understand their needs and introduce your solution.
\nCustomer has shown interest in solution: After initial discussions, the\n customer is interested in your solution.
\nConducted POC/demo: You conducted a proof of concept (POC) or demonstration of\n the solution for the customer.
\nIn evaluation/planning stage: The customer is evaluating the solution and\n planning potential implementation.
\nAgreed on solution to Business Problem: Both parties agree on how the solution\n addresses the customer's business problem.
\nCompleted Action Plan: A detailed action plan is complete and outlines the\n steps for implementation.
\nFinalized Deployment Need: Both parties agree with and finalized the\n deployment needs.
\nSOW Signed: Both parties signed a statement of work (SOW), and formalize the\n agreement and detail the project scope and deliverables.
\nName of the Opportunity's competitor (if any). Use Other to submit a value not in\n the picklist.\n
Name of the Opportunity's competitor (if any). Use Other to\n submit a value not in the picklist.
Only allowed when CompetitorNames has Other selected.\n
Only allowed when CompetitorNames has Other selected.
Specifies the offered solution for the customer's business problem when the \n RelatedEntityIdentifiers.Solutions field value is Other.\n
Specifies the offered solution for the customer's business problem when the \n RelatedEntityIdentifiers.Solutions field value is Other.
Captures additional comments or information for the Opportunity that weren't captured in other fields.\n
Captures additional comments or information for the Opportunity that\n weren't captured in other fields.
An object that contains the Opportunity's project details.
Describes the business problem that the project aims to solve. This information is\n crucial for understanding the project’s 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\n understand the focus of the project.
", "smithy.api#length": { "min": 1, "max": 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\n 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\n 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,\n 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\n 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\n in your Amazon Web Services environment.
\nBYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in\n the end customer's Amazon Web Services environment.
\nManaged Services: The end customer's Amazon Web Services business management\n (For example: Consulting, design, implementation, billing support, cost\n optimization, technical support).
\nProfessional Services: Offerings to help enterprise end customers achieve\n specific business outcomes for enterprise cloud adoption (For example: Advisory\n or transformation planning).
\nResell: Amazon Web Services accounts and billing management for your\n customers.
\nOther: Delivery model not described above.
\nProvides a summary of the expected customer spend for the project, offering a\n high-level view of the potential financial impact.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a Project object's subset of fields.
\n Describes the deployment or consumption model for the partner solution or offering.\n This field indicates how the project's solution will be delivered or implemented for the\n customer.\n
" + } + }, + "ExpectedCustomerSpend": { + "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", + "traits": { + "smithy.api#documentation": "\n Provides information about the anticipated customer spend related to this project.\n This may include details such as amount, frequency, and currency of expected\n expenditure.\n
" + } + }, + "CustomerUseCase": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Specifies the proposed solution focus or type of workload for the project.\n
" + } + }, + "SalesActivities": { + "target": "com.amazonaws.partnercentralselling#SalesActivities", + "traits": { + "smithy.api#documentation": "\n Lists the pre-sales activities that have occurred with the end-customer related to the\n opportunity. This field is conditionally mandatory when the project is qualified for\n Co-Sell and helps drive assignment priority on the AWS side. It provides insight into\n the engagement level with the customer. \n
" + } + }, + "OtherSolutionDescription": { + "target": "com.amazonaws.partnercentralselling#PiiString", + "traits": { + "smithy.api#documentation": "\n Offers a description of other solutions if the standard solutions do not adequately\n cover the project's scope.\n
", + "smithy.api#length": { + "max": 255 } } } }, "traits": { - "smithy.api#documentation": "An object that contains the\n Opportunity's project details.\n
\n Provides the project view of an opportunity resource shared through a snapshot.\n
" + } + }, + "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#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.partnercentralselling#ThrottlingException" + }, + { + "target": "com.amazonaws.partnercentralselling#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to put system settings 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#ProjectDetails": { + "com.amazonaws.partnercentralselling#PutSellingSystemSettingsRequest": { "type": "structure", "members": { - "BusinessProblem": { - "target": "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem", - "traits": { - "smithy.api#documentation": "Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s 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#length": { - "min": 1, - "max": 255 - }, - "smithy.api#required": {} - } - }, - "TargetCompletionDate": { - "target": "com.amazonaws.partnercentralselling#Date", + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.
", + "smithy.api#documentation": "Specifies the catalog in which the settings will be updated. Acceptable values include\n AWS for production and Sandbox for testing\n environments.
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": {} + "smithy.api#documentation": "Specifies the ARN of the IAM Role used for resource snapshot job executions.
" } } }, "traits": { - "smithy.api#documentation": "Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.
" + "smithy.api#input": {} } }, - "com.amazonaws.partnercentralselling#ProjectSummary": { + "com.amazonaws.partnercentralselling#PutSellingSystemSettingsResponse": { "type": "structure", "members": { - "DeliveryModels": { - "target": "com.amazonaws.partnercentralselling#DeliveryModels", + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "\n Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.\n
\n Options' descriptions from the Delivery Model field are:\n
SaaS or PaaS: Your Amazon Web Services based solution deployed as SaaS or PaaS in your Amazon Web Services environment.
\nBYOL or AMI: Your Amazon Web Services based solution deployed as BYOL or AMI in the end customer's Amazon Web Services environment.
\nManaged Services: The end customer's Amazon Web Services business management (For example: Consulting, design, implementation, billing support, cost optimization, technical support).
\nProfessional Services: Offerings to help enterprise end customers achieve specific business outcomes for enterprise cloud adoption (For example: Advisory or transformation planning).
\nResell: Amazon Web Services accounts and billing management for your customers.
\nOther: Delivery model not described above.
\nSpecifies the catalog in which the settings are defined. Acceptable values include\n AWS for production and Sandbox for testing\n environments.
Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.
" + "smithy.api#documentation": "Specifies the ARN of the IAM Role used for resource snapshot job executions.
" } } }, "traits": { - "smithy.api#documentation": "An object that contains a Project object's subset of fields.\n
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.
" + "smithy.api#documentation": "Specifies the AWS account of the partner who received the Engagement Invitation. This\n 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.
" + "smithy.api#documentation": "Represents the entity that received the Engagement Invitation, including account and\n company details. This field is essential for tracking the partner who is being invited\n to collaborate.
" } }, "com.amazonaws.partnercentralselling#ReceiverResponsibility": { @@ -7316,7 +10230,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to reject Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "This action rejects an EngagementInvitation that AWS\n shared. Rejecting an invitation indicates that the partner doesn't want to\n pursue the opportunity, and all related data will become inaccessible\n thereafter.
This action rejects an EngagementInvitation that AWS shared. Rejecting an\n invitation indicates that the partner doesn't want to pursue the opportunity, and all\n related data will become inaccessible thereafter.
This is the catalog that's associated with the engagement\n invitation. Acceptable values are AWS or\n Sandbox, and these values determine the environment in which\n the opportunity is managed.
This is the catalog that's associated with the engagement invitation. Acceptable\n values are AWS or Sandbox, and these values determine the\n environment in which the opportunity is managed.
This is the unique identifier of the rejected\n EngagementInvitation. Providing the correct identifier\n helps to ensure that the intended invitation is rejected.
This is the unique identifier of the rejected EngagementInvitation.\n Providing the correct identifier helps to ensure that the intended invitation is\n rejected.
This describes the reason for rejecting the engagement invitation,\n which helps AWS track usage patterns. Acceptable values include the\n following:
\n\n Customer problem unclear: The\n customer's problem isn't understood.
\n\n Next steps unclear: The next steps\n required to proceed aren't understood.
\n\n Unable to support: The partner is unable to provide support due to resource or capability constraints.
\n\n Duplicate of partner referral: The\n opportunity is a duplicate of an existing referral.
\n\n Other: Any reason not covered by\n other values.
\nThis describes the reason for rejecting the engagement invitation, which helps AWS\n track usage patterns. Acceptable values include the following:
\n\n Customer problem unclear: The customer's problem isn't\n understood.
\n\n Next steps unclear: The next steps required to proceed\n aren't understood.
\n\n Unable to support: The partner is unable to provide\n support due to resource or capability constraints.
\n\n Duplicate of partner referral: The opportunity is a\n duplicate of an existing referral.
\n\n Other: Any reason not covered by other values.
\n\n 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\"].\n
\n Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.\n
" + "smithy.api#documentation": "Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this\n format: \"offers\":\n [\"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\n the associated Marketplace seller account.
" } }, "Solutions": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { - "smithy.api#documentation": "\n 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.\n
\n 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.\n
\n 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.\n
" + "smithy.api#documentation": "Enables partner solutions or offerings' association with an opportunity. To associate\n a solution, provide the solution's unique identifier, which you can obtain with the\n ListSolutions operation.
If the specific solution identifier is not available, you can use the value\n Other and provide details about the solution in the\n otherSolutionOffered field. But when the opportunity reaches the\n Committed stage or beyond, the Other value cannot be used,\n and a valid solution identifier must be provided.
By associating the relevant solutions with the opportunity, you can communicate the\n offerings that are being considered or implemented to address the customer's business\n problem.
" } }, "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifiers", "traits": { - "smithy.api#documentation": "\n Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate\n the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's\n needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].\n
\n Use the file with the list of Amazon Web Services products hosted on GitHub:\n \n Amazon Web Services products.\n
" + "smithy.api#documentation": "Enables the association of specific Amazon Web Services products with the\n Opportunity. Partners can indicate the relevant Amazon Web Services\n products for the Opportunity's solution and align with the customer's\n needs. Returns multiple values separated by commas. For example, \"AWSProducts\" :\n [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].
Use the file with the list of Amazon Web Services products hosted on GitHub: \n Amazon Web Services products.
" } } }, "traits": { - "smithy.api#documentation": "\n This field provides the associations' information for other entities with the opportunity. These entities include identifiers for\n AWSProducts, Partner Solutions, and AWSMarketplaceOffers.\n
This field provides the associations' information for other entities with the\n opportunity. These entities include identifiers for AWSProducts,\n Partner Solutions, and AWSMarketplaceOffers.
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.\n
\nSuggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + }, + "traits": { + "smithy.api#documentation": "This error occurs when the specified resource can't be found. The resource might not\n exist, or isn't visible with the current credentials.
\nSuggested action: Verify that the resource ID is correct and the resource is in the\n 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": "page.html#my-resource" + }, + "smithy.api#documentation": "Represents snapshot of a resource in AWS Partner Central" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotArn": { + "type": "string", + "traits": { + "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#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "relativeDocumentation": "page.html#my-resource", + "name": "resource-snapshot-job" + }, + "smithy.api#documentation": "Represents a job of snapshot resource in AWS Partner Central" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:.*" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^job-[0-9a-z]{13}$" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotJobRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^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#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(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" + } + } + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotJobSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier for the resource snapshot job within the AWS Partner Central\n system. This ID is used for direct references to the job within the service.\n
" + } + }, + "Arn": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the resource snapshot job.\n
" + } + }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The unique identifier for the engagement within the AWS Partner Central\n system. This ID is used for direct references to the engagement within the service.\n
" + } + }, + "Status": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", + "traits": { + "smithy.api#documentation": "\n Represents the current status of the resource snapshot job.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n An object that contains a Resource Snapshot Job's subset of fields.\n
\n An object that contains an opportunity's subset of fields. \n
\n Represents the payload of a resource snapshot. This structure is designed to\n accommodate different types of resource snapshots, currently supporting opportunity\n summaries.\n
" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotRevision": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be\n used for cross-service references and in IAM policies.\n
" + } + }, + "Revision": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", + "traits": { + "smithy.api#documentation": "\n The revision number of the snapshot. This integer value is incremented each time the\n snapshot is updated, allowing for version tracking of the resource snapshot.\n
" + } + }, + "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\n 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 principal (user or role) who created the snapshot. This\n helps in tracking the origin of the snapshot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides a concise summary of a resource snapshot, including its unique identifier and\n version information. This structure is used to quickly reference and identify specific\n versions of resource snapshots. \n
" + } + }, + "com.amazonaws.partnercentralselling#ResourceSnapshotSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotSummary" + } + }, + "com.amazonaws.partnercentralselling#ResourceTemplateName": { + "type": "string", + "traits": { + "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" + } + } } }, "com.amazonaws.partnercentralselling#RevenueModel": { @@ -7560,43 +10732,68 @@ } } }, + "com.amazonaws.partnercentralselling#SellingSystemSettings": { + "type": "resource", + "identifiers": { + "Catalog": { + "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" + } + }, + "read": { + "target": "com.amazonaws.partnercentralselling#GetSellingSystemSettings" + }, + "update": { + "target": "com.amazonaws.partnercentralselling#PutSellingSystemSettings" + }, + "traits": { + "aws.api#arn": { + "template": "catalog/{Catalog}/selling-system-settings" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "relativeDocumentation": "page.html#my-resource", + "name": "selling-system-settings" + }, + "smithy.api#documentation": "Represents a partner selling system settings in AWS Partner Central" + } + }, "com.amazonaws.partnercentralselling#SenderContact": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.partnercentralselling#SenderContactEmail", "traits": { - "smithy.api#documentation": "The sender-provided contact's email address associated with the EngagementInvitation.\n
The sender-provided contact's email address associated with the\n EngagementInvitation.
The sender-provided contact's last name associated with the EngagementInvitation.\n
The sender-provided contact's last name associated with the\n EngagementInvitation.
The sender-provided contact's first name associated with the EngagementInvitation.\n
The sender-provided contact's first name associated with the\n EngagementInvitation.
The sender-provided contact's title (job title or role) associated with the EngagementInvitation.\n
The sender-provided contact's title (job title or role) associated with the\n EngagementInvitation.
The sender-provided contact's phone number associated with the EngagementInvitation.\n
The sender-provided contact's phone number associated with the\n EngagementInvitation.
An object that contains the details of the sender-provided contact person for the EngagementInvitation.\n
An object that contains the details of the sender-provided contact person for the\n EngagementInvitation.
This error occurs when the request would cause a service quota to be exceeded.\n Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.\n
\nSuggested action: Review the\n Quotas for the resource, and either reduce usage or request a quota increase.\n
", + "smithy.api#documentation": "This error occurs when the request would cause a service quota to be exceeded. Service\n quotas represent the maximum allowed use of a specific resource, and this error\n indicates that the request would surpass that limit.
\nSuggested action: Review the Quotas for the\n resource, and either reduce usage or request a quota increase.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -7640,7 +10837,7 @@ "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.\n
Specifies the customer's intended payment type agreement or procurement method to\n acquire the solution or service outlined in the Opportunity.
Specifies the Opportunity's customer engagement start date for the contract's effectiveness.\n
Specifies the Opportunity's customer engagement start date for the\n contract's effectiveness.
Specifies the expiration date for the contract between the customer and\n Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between\n both parties.\n
" + "smithy.api#documentation": "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\n period between both parties.
" } } }, "traits": { - "smithy.api#documentation": "Specifies a customer's procurement terms details. Required only for partners in eligible programs.
" + "smithy.api#documentation": "Specifies a customer's procurement terms details. Required only for partners in\n eligible programs.
" } }, "com.amazonaws.partnercentralselling#Solution": { @@ -7690,13 +10887,19 @@ "smithy.api#documentation": "Represents a Solution that is listed on AWS Partner Central" } }, + "com.amazonaws.partnercentralselling#SolutionArn": { + "type": "string", + "traits": { + "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.
Specifies the catalog in which the solution is hosted, either AWS or\n Sandbox. This helps partners differentiate between live solutions and\n those in testing environments.
\n The SolutionBase structure provides essential information about a solution.\n
" + } + }, "Name": { "target": "smithy.api#String", "traits": { @@ -7717,14 +10926,14 @@ "Status": { "target": "com.amazonaws.partnercentralselling#SolutionStatus", "traits": { - "smithy.api#documentation": "\n Specifies the solution's current status, which indicates its state in the system.\n Valid values: Active | Inactive | Draft.\n The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.\n
Specifies the solution's current status, which indicates its state in the system.\n Valid values: Active | Inactive | Draft. The\n status helps partners and Amazon Web Services track the solution's lifecycle and\n availability. Filter for Active solutions for association to an\n opportunity.
\n Specifies the solution category, which helps to categorize and organize the solutions partners offer.\n Valid values: Software Product | Consulting Service |\n Hardware Product | Communications Product |\n Professional Service | Managed Service |\n Value-Added Resale Amazon Web Services Service | Distribution Service |\n Training Service | Merger and Acquisition Advising Service.\n
Specifies the solution category, which helps to categorize and organize the solutions\n partners offer. Valid values: Software Product | Consulting\n Service | Hardware Product | Communications Product\n | Professional Service | Managed Service | Value-Added\n Resale Amazon Web Services Service | Distribution Service |\n Training Service | Merger and Acquisition Advising\n Service.
Specifies minimal information for the solution offered to solve the customer's business problem.
" + "smithy.api#documentation": "Specifies minimal information for the solution offered to solve the customer's\n business problem.
" } }, "com.amazonaws.partnercentralselling#SolutionIdentifier": { @@ -7764,20 +10973,20 @@ "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { - "smithy.api#documentation": "\n Specifies the sorting order, either Ascending or Descending. The default is Descending.\n
Specifies the sorting order, either Ascending or Descending.\n The default is Descending.
\n Specifies the attribute to sort by, such as Name, CreatedDate, or Status.\n
Specifies the attribute to sort by, such as Name,\n CreatedDate, or Status.
\n Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.\n
" + "smithy.api#documentation": "Configures the solutions' response sorting that enables partners to order solutions\n based on specified attributes.
" } }, "com.amazonaws.partnercentralselling#SolutionSortName": { @@ -7838,6 +11047,37 @@ } } }, + "com.amazonaws.partnercentralselling#SortBy": { + "type": "enum", + "members": { + "CREATED_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedDate" + } + } + } + }, + "com.amazonaws.partnercentralselling#SortObject": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.partnercentralselling#SortBy", + "traits": { + "smithy.api#documentation": "\n Specifies the field by which to sort the resource snapshot jobs.\n
" + } + }, + "SortOrder": { + "target": "com.amazonaws.partnercentralselling#SortOrder", + "traits": { + "smithy.api#documentation": "\n Determines the order in which the sorted results are presented.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Defines the sorting parameters for listing resource snapshot jobs. This structure\n allows you to specify the field to sort by and the order of sorting. \n
" + } + }, "com.amazonaws.partnercentralselling#SortOrder": { "type": "enum", "members": { @@ -7948,7 +11188,7 @@ ], "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’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.
This action starts the engagement by accepting an EngagementInvitation.\n The task is asynchronous and involves the following steps: accepting the invitation,\n creating an opportunity in the partner’s account from the AWS opportunity, and copying\n details for tracking. When completed, an Opportunity Created event is\n generated, indicating that the opportunity has been successfully created in the\n partner's account.
Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.
Specifies the catalog related to the task. Use AWS for production\n 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#documentation": "A unique, case-sensitive identifier provided by the client that helps to ensure the\n idempotency of the request. This can be a random or meaningful string but must be unique\n for each request.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -7980,7 +11220,7 @@ "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.
Specifies the unique identifier of the EngagementInvitation to be\n accepted. Providing the correct identifier helps ensure that the correct engagement is\n processed.
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task, used for tracking and managing the task\n 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.
" + "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows RFC 3339\n section 5.6.
" } }, "TaskStatus": { @@ -8019,7 +11259,7 @@ "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.
" + "smithy.api#documentation": "If the task fails, this field contains a detailed message describing the failure and\n possible recovery steps.
" } }, "ReasonCode": { @@ -8031,13 +11271,19 @@ "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.
" + "smithy.api#documentation": "Returns the original opportunity identifier passed in the request. This is the unique\n identifier for the opportunity.
" + } + }, + "ResourceSnapshotJobId": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the resource snapshot job created as part of this task.\n
" } }, "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.
" + "smithy.api#documentation": "Returns the identifier of the engagement invitation that was accepted and used to\n create the opportunity.
" } } }, @@ -8091,7 +11337,7 @@ ], "documentation": "Grants permission to initiate tasks that start Engagements from Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.
This action initiates the engagement process from an existing opportunity by accepting\n the engagement invitation and creating a corresponding opportunity in the partner’s\n system. Similar to StartEngagementByAcceptingInvitationTask, this action is\n asynchronous and performs multiple steps before completion.
Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.
Specifies the catalog in which the engagement is tracked. Acceptable values include\n AWS for production and Sandbox for testing\n 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#documentation": "A unique token provided by the client to help ensure the idempotency of the request.\n It helps prevent the same task from being performed multiple times.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -8123,7 +11369,7 @@ "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#documentation": "The unique identifier of the opportunity from which the engagement task is to be\n initiated. This helps ensure that the task is applied to the correct opportunity.
", "smithy.api#required": {} } }, @@ -8144,31 +11390,31 @@ "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier", "traits": { - "smithy.api#documentation": "The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
The unique identifier of the task, used to track the task’s progress. This value\n 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.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task, used for tracking and managing the task\n 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.
" + "smithy.api#documentation": "The timestamp indicating when the task was initiated. The format follows RFC 3339\n 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.
Indicates the current status of the task. Valid values include\n IN_PROGRESS, COMPLETE, and FAILED.
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
" + "smithy.api#documentation": "If the task fails, this field contains a detailed message describing the failure and\n possible recovery steps.
" } }, "ReasonCode": { @@ -8180,7 +11426,25 @@ "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’s system.
" + "smithy.api#documentation": "Returns the original opportunity identifier passed in the request, which is the unique\n identifier for the opportunity created in the partner’s system.
" + } + }, + "ResourceSnapshotJobId": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the resource snapshot job created to add the opportunity resource\n snapshot to the Engagement. Only populated if TaskStatus is COMPLETE.\n
" + } + }, + "EngagementId": { + "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the newly created engagement. Only populated if TaskStatus is\n COMPLETE.\n
" + } + }, + "EngagementInvitationId": { + "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the new engagement invitation. Only populated if TaskStatus is\n COMPLETE.\n
" } } }, @@ -8188,24 +11452,234 @@ "smithy.api#output": {} } }, + "com.amazonaws.partnercentralselling#StartResourceSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#StartResourceSnapshotJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.partnercentralselling#ThrottlingException" + }, + { + "target": "com.amazonaws.partnercentralselling#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to starting resource snapshot jobs in AWS Partner Central" + }, + "smithy.api#documentation": "\n Starts a resource snapshot job that has been previously created.\n
", + "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": "\n Specifies the catalog related to the request.\n
", + "smithy.api#required": {} + } + }, + "ResourceSnapshotJobIdentifier": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the resource snapshot job to start.\n
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Identifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.partnercentralselling#StopResourceSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#StopResourceSnapshotJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.partnercentralselling#AccessDeniedException" + }, + { + "target": "com.amazonaws.partnercentralselling#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.partnercentralselling#ThrottlingException" + }, + { + "target": "com.amazonaws.partnercentralselling#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to stopping resource snapshot jobs in AWS Partner Central" + }, + "smithy.api#documentation": "\n Stops a resource snapshot job. The job must be started prior to being stopped.\n
", + "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": "\n Specifies the catalog related to the request. \n
", + "smithy.api#required": {} + } + }, + "ResourceSnapshotJobIdentifier": { + "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the job to stop.\n
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Identifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.partnercentralselling#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, + "com.amazonaws.partnercentralselling#SubmitOpportunity": { + "type": "operation", + "input": { + "target": "com.amazonaws.partnercentralselling#SubmitOpportunityRequest" + }, + "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 submit Opportunities on AWS Partner Central" + }, + "smithy.api#documentation": "\n Use this action to submit an opportunity that was previously created by partner for\n AWS review. After you perform this action, the opportunity becomes non-editable until it\n is reviewed by AWS and has LifeCycle.ReviewStatus as either\n Approved or Action Required. \n
\n Specifies the catalog related to the request. \n
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", + "traits": { + "smithy.api#documentation": "\n The identifier of the opportunity previously created by partner and needs to be\n submitted.\n
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Identifier" + } + }, + "InvolvementType": { + "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", + "traits": { + "smithy.api#documentation": "\n Specifies the level of AWS sellers' involvement on the opportunity. \n
", + "smithy.api#required": {} + } + }, + "Visibility": { + "target": "com.amazonaws.partnercentralselling#Visibility", + "traits": { + "smithy.api#documentation": "\n Determines whether to restrict visibility of the opportunity from AWS sales. Default\n value is Full. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.partnercentralselling#TaskArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:.*" } }, + "com.amazonaws.partnercentralselling#TaskArnOrIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:.*|task-[0-9a-z]{13})$" + } + }, "com.amazonaws.partnercentralselling#TaskIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "task-[0-9a-z]{13}$" } }, + "com.amazonaws.partnercentralselling#TaskIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#TaskArnOrIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.partnercentralselling#TaskStatus": { "type": "enum", "members": { @@ -8229,6 +11703,18 @@ } } }, + "com.amazonaws.partnercentralselling#TaskStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.partnercentralselling#TaskStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, "com.amazonaws.partnercentralselling#ThrottlingException": { "type": "structure", "members": { @@ -8237,7 +11723,7 @@ } }, "traits": { - "smithy.api#documentation": "This error occurs when there are too many requests sent. Review the provided quotas and adapt your\n usage to avoid throttling.\n
\nThis error occurs when there are too many requests sent. Review the provided\n Quotas and retry after the provided delay.\n
", + "smithy.api#documentation": "This error occurs when there are too many requests sent. Review the provided quotas\n and adapt your usage to avoid throttling.
\nThis 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 } @@ -8277,7 +11763,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "\n Updates the Opportunity record identified by a given Identifier.\n This operation allows you to modify the details of an existing opportunity to reflect the latest information\n and progress. Use this action to keep the opportunity record up-to-date and accurate.\n
\n 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.\n
Updates the Opportunity record identified by a given\n Identifier. This operation allows you to modify the details of an\n existing opportunity to reflect the latest information and progress. Use this action to\n keep the opportunity record up-to-date and accurate.
When you perform updates, include the entire payload with each request. If any field\n is omitted, the API assumes that the field is set to null. The best\n practice is to always perform a GetOpportunity to retrieve the latest\n values, then send the complete payload with the updated values to be changed.
\n Specifies the catalog associated with the request. This field takes a string value from a predefined list:\n AWS or Sandbox. The catalog determines which environment the opportunity is updated in.\n Use AWS to update real opportunities in the production\n environment, and Sandbox for testing in secure, isolated environments.\n When you use the Sandbox catalog, it allows you to simulate and validate your interactions\n with Amazon Web Services services without affecting live data or operations.\n
Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is updated in. Use AWS to update real\n opportunities in the production environment, and Sandbox for testing in\n secure, isolated environments. When you use the Sandbox catalog, it allows\n you to simulate and validate your interactions with Amazon Web Services services without\n affecting live data or operations.
\n Identifies the type of support the partner needs from Amazon Web Services.\n
\n\n Valid values:\n
\n\n Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.\n
\n\n Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.\n
\n\n Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.\n
\n\n Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).\n
\n\n Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.\n
\n\n Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.\n
\n\n Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).\n
\n\n Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.\n
\n\n Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.\n
\nIdentifies the type of support the partner needs from Amazon Web Services.
\nValid values:
\nCosell—Architectural Validation: Confirmation from Amazon Web Services that the\n partner's proposed solution architecture is aligned with Amazon Web Services best\n practices and poses minimal architectural risks.
\nCosell—Business Presentation: Request Amazon Web Services seller's\n participation in a joint customer presentation.
\nCosell—Competitive Information: Access to Amazon Web Services competitive\n resources and support for the partner's proposed solution.
\nCosell—Pricing Assistance: Connect with an AWS seller for support situations\n where a partner may be receiving an upfront discount on a service (for example:\n EDP deals).
\nCosell—Technical Consultation: Connection with an Amazon Web Services Solutions\n Architect to address the partner's questions about the proposed solution.
\nCosell—Total Cost of Ownership Evaluation: Assistance with quoting different\n cost savings of proposed solutions on Amazon Web Services versus on-premises or a\n traditional hosting environment.
\nCosell—Deal Support: Request Amazon Web Services seller's support to progress\n the opportunity (for example: joint customer call, strategic\n positioning).
\nCosell—Support for Public Tender/RFx: Opportunity related to the public sector\n where the partner needs RFx support from Amazon Web Services.
\nDo Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need\n support from an Amazon Web Services Sales representative. The opportunity is\n managed solely by the partner. It's possible to request coselling support on\n these opportunities at any stage during their lifecycle. Also known as,\n for-visibility-only (FVO) opportunity.
\nSpecifies 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 if the opportunity is associated with national security concerns. This flag\n is only applicable when the industry is Government. For\n national-security-related opportunities, validation and compliance rules may apply,\n impacting the opportunity's visibility and processing.
Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential\n to track and reconcile because it's included in the outbound payload sent back to the partner.\n
", + "smithy.api#documentation": "Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.
", "smithy.api#length": { "max": 64 } @@ -8319,51 +11805,51 @@ "Customer": { "target": "com.amazonaws.partnercentralselling#Customer", "traits": { - "smithy.api#documentation": "Specifies details of the customer associated with the Opportunity.\n
Specifies details of the customer associated with the Opportunity.
An object that contains project details summary for the Opportunity.\n
An object that contains project details summary for the\n Opportunity.
\n Specifies the opportunity type as a renewal, new, or expansion.\n
\n\n Opportunity types:\n
\n\n New opportunity:\n Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.\n
\n\n Renewal opportunity:\n Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.\n
\n\n Expansion opportunity:\n 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.\n
\nSpecifies the opportunity type as a renewal, new, or expansion.
\nOpportunity types:
\nNew opportunity: Represents a new business opportunity with a potential\n customer that's not previously engaged with your solutions or services.
\nRenewal opportunity: Represents an opportunity to renew an existing contract\n or subscription with a current customer, ensuring continuity of service.
\nExpansion opportunity: Represents an opportunity to expand the scope of an\n existing contract or subscription, either by adding new services or increasing\n the volume of existing services for a current customer.
\nAn object that contains marketing details for the Opportunity.\n
An object that contains marketing details for the Opportunity.
Specifies details of a customer's procurement terms. Required only for partners in eligible programs.
" + "smithy.api#documentation": "Specifies details of a customer's procurement terms. Required only for partners in\n eligible programs.
" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "\n DateTime when the opportunity was last modified.\n
\n DateTime when the opportunity was last modified.
Read-only, system generated Opportunity unique identifier.\n
Read-only, system generated Opportunity unique identifier.
An object that contains lifecycle details for the Opportunity.\n
An object that contains lifecycle details for the Opportunity.
Read-only, system generated Opportunity unique identifier.\n
Read-only, system generated Opportunity unique identifier.
\n DateTime\n when the opportunity was last modified.\n
\n DateTime when the opportunity was last modified.
\n The primary reason for this validation exception to occur.\n
\n\n REQUEST_VALIDATION_FAILED: The request format is not valid.
\nFix: Verify your request payload includes all required fields, uses correct data types and string formats.\n
\n\n BUSINESS_VALIDATION_FAILED: The requested change doesn't pass the business validation rules.
\nFix: Check that your change aligns with the business rules defined by AWS Partner Central.\n
\nThe primary reason for this validation exception to occur.
\n\n REQUEST_VALIDATION_FAILED: The request format is not\n valid.
\nFix: Verify your request payload includes all required fields, uses correct\n data types and string formats.
\n\n BUSINESS_VALIDATION_FAILED: The requested change doesn't\n pass the business validation rules.
\nFix: Check that your change aligns with the business rules defined by AWS\n Partner Central.
\nA list of issues that were discovered in the submitted request or the resource state.\n
" + "smithy.api#documentation": "A list of issues that were discovered in the submitted request or the resource\n state.
" } } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service or business validation rules.\n
\nSuggested action: Review the error message, including the failed fields and reasons, to correct the request payload.\n
", + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the service or business\n validation rules.
\nSuggested action: Review the error message, including the failed fields and reasons,\n to correct the request payload.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8453,7 +11939,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Indicates an invalid value for a field.\n
\n\n REQUIRED_FIELD_MISSING: The request is missing a required field.
\nFix: Verify your request payload includes all required fields.\n
\n\n INVALID_ENUM_VALUE: The enum field value isn't an accepted values.
\nFix: Check the documentation for the list of valid enum values, and update your request with a valid value.\n
\n\n INVALID_STRING_FORMAT: The string format is invalid.
\nFix: Confirm that the string is in the expected format (For example: email address, date).\n
\n\n INVALID_VALUE: The value isn't valid.
\nFix: Confirm that the value meets the expected criteria and is within the allowable range or set.\n
\n\n TOO_MANY_VALUES: There are too many values in a field that expects fewer entries.
\nFix: Reduce the number of values to match the expected limit.\n
\n\n ACTION_NOT_PERMITTED: The action isn't permitted due to current state or permissions.
\nFix: Verify that the action is appropriate for the current state, and that you have the necessary permissions to perform it.\n
\n\n DUPLICATE_KEY_VALUE: The value in a field duplicates a value that must be unique.
\nFix: Verify that the value is unique and doesn't duplicate an existing value in the system.\n
\nIndicates an invalid value for a field.
\n\n REQUIRED_FIELD_MISSING: The request is missing a required\n field.
\nFix: Verify your request payload includes all required fields.
\n\n INVALID_ENUM_VALUE: The enum field value isn't an\n accepted values.
\nFix: Check the documentation for the list of valid enum values, and update\n your request with a valid value.
\n\n INVALID_STRING_FORMAT: The string format is\n invalid.
\nFix: Confirm that the string is in the expected format (For example: email\n address, date).
\n\n INVALID_VALUE: The value isn't valid.
\nFix: Confirm that the value meets the expected criteria and is within the\n allowable range or set.
\n\n TOO_MANY_VALUES: There are too many values in a field\n that expects fewer entries.
\nFix: Reduce the number of values to match the expected limit.
\n\n ACTION_NOT_PERMITTED: The action isn't permitted due to\n current state or permissions.
\nFix: Verify that the action is appropriate for the current state, and that you\n have the necessary permissions to perform it.
\n\n DUPLICATE_KEY_VALUE: The value in a field duplicates a\n value that must be unique.
\nFix: Verify that the value is unique and doesn't duplicate an existing value\n in the system.
\nSearches for relevant content in a Q Business application based on a query. This operation takes a \n search query text, the Q Business application identifier, and optional filters \n (such as user ID, user groups, content source, and maximum results) as input. It returns a list of \n relevant content items, where each item includes the content text, the unique document identifier, \n the document title, the document URI, any relevant document attributes, and score attributes \n indicating the confidence level of the relevance.
", + "smithy.api#documentation": "Searches for relevant content in a Q Business application based on a query. This operation takes a \n search query text, the Q Business application identifier, and optional filters \n (such as content source and maximum results) as input. It returns a list of \n relevant content items, where each item includes the content text, the unique document identifier, \n the document title, the document URI, any relevant document attributes, and score attributes \n indicating the confidence level of the relevance.
", "smithy.api#http": { "uri": "/applications/{applicationId}/relevant-content", "method": "POST" @@ -12062,20 +12062,6 @@ "smithy.api#required": {} } }, - "userId": { - "target": "com.amazonaws.qbusiness#UserId", - "traits": { - "smithy.api#documentation": "The ID of the user performing the search. Used for access control.
", - "smithy.api#httpQuery": "userId" - } - }, - "userGroups": { - "target": "com.amazonaws.qbusiness#UserGroups", - "traits": { - "smithy.api#documentation": "The groups the user belongs to. Used for access control.
", - "smithy.api#httpQuery": "userGroups" - } - }, "queryText": { "target": "com.amazonaws.qbusiness#QueryText", "traits": {