From 53dddb9af12b9c1101e028659561118a6d216e11 Mon Sep 17 00:00:00 2001 From: aws-sdk-python-automation Date: Thu, 5 Dec 2024 01:17:21 +0000 Subject: [PATCH] Update to latest models --- ...pi-change-partnercentralselling-99058.json | 5 + .../api-change-qbusiness-70270.json | 5 + .../2022-07-26/paginators-1.json | 42 + .../2022-07-26/service-2.json | 2535 +++++++++++++++-- .../data/qbusiness/2023-11-27/service-2.json | 14 +- 5 files changed, 2338 insertions(+), 263 deletions(-) create mode 100644 .changes/next-release/api-change-partnercentralselling-99058.json create mode 100644 .changes/next-release/api-change-qbusiness-70270.json diff --git a/.changes/next-release/api-change-partnercentralselling-99058.json b/.changes/next-release/api-change-partnercentralselling-99058.json new file mode 100644 index 0000000000..09543513b5 --- /dev/null +++ b/.changes/next-release/api-change-partnercentralselling-99058.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``partnercentral-selling``", + "description": "Introducing the preview of new partner central selling APIs designed to transform how AWS partners collaborate and co-sell with multiple partners. This enables multiple partners to seamlessly engage and jointly pursue customer opportunities, fostering a new era of collaborative selling." +} diff --git a/.changes/next-release/api-change-qbusiness-70270.json b/.changes/next-release/api-change-qbusiness-70270.json new file mode 100644 index 0000000000..e99eb2b06a --- /dev/null +++ b/.changes/next-release/api-change-qbusiness-70270.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``qbusiness``", + "description": "This release removes the deprecated UserId and UserGroups fields from SearchRelevantContent api's request parameters." +} diff --git a/botocore/data/partnercentral-selling/2022-07-26/paginators-1.json b/botocore/data/partnercentral-selling/2022-07-26/paginators-1.json index bfdd3b6a64..db4f336b7d 100644 --- a/botocore/data/partnercentral-selling/2022-07-26/paginators-1.json +++ b/botocore/data/partnercentral-selling/2022-07-26/paginators-1.json @@ -17,6 +17,48 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SolutionSummaries" + }, + "ListEngagementByAcceptingInvitationTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "TaskSummaries" + }, + "ListEngagementFromOpportunityTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "TaskSummaries" + }, + "ListEngagementMembers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EngagementMemberList" + }, + "ListEngagementResourceAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EngagementResourceAssociationSummaries" + }, + "ListEngagements": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EngagementSummaryList" + }, + "ListResourceSnapshotJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResourceSnapshotJobSummaries" + }, + "ListResourceSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResourceSnapshotSummaries" } } } diff --git a/botocore/data/partnercentral-selling/2022-07-26/service-2.json b/botocore/data/partnercentral-selling/2022-07-26/service-2.json index e7a980d02f..5f6f7dfe23 100644 --- a/botocore/data/partnercentral-selling/2022-07-26/service-2.json +++ b/botocore/data/partnercentral-selling/2022-07-26/service-2.json @@ -15,6 +15,22 @@ "auth":["aws.auth#sigv4"] }, "operations":{ + "AcceptEngagementInvitation":{ + "name":"AcceptEngagementInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptEngagementInvitationRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, "AssignOpportunity":{ "name":"AssignOpportunity", "http":{ @@ -29,7 +45,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.

This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

" + "documentation":"

Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.

This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

" }, "AssociateOpportunity":{ "name":"AssociateOpportunity", @@ -45,7 +61,45 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:

To obtain identifiers for these entities, use the following methods:

" + "documentation":"

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:

To obtain identifiers for these entities, use the following methods:

" + }, + "CreateEngagement":{ + "name":"CreateEngagement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEngagementRequest"}, + "output":{"shape":"CreateEngagementResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true + }, + "CreateEngagementInvitation":{ + "name":"CreateEngagementInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEngagementInvitationRequest"}, + "output":{"shape":"CreateEngagementInvitationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true }, "CreateOpportunity":{ "name":"CreateOpportunity", @@ -63,7 +117,61 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission.

To submit an opportunity, follow these steps:

  1. To create the opportunity, use CreateOpportunity.

  2. To associate a solution with the opportunity, use AssociateOpportunity.

  3. To submit the opportunity, use StartEngagementFromOpportunityTask.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

", + "documentation":"

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission.

To submit an opportunity, follow these steps:

  1. To create the opportunity, use CreateOpportunity.

  2. To associate a solution with the opportunity, use AssociateOpportunity.

  3. To submit the opportunity, use StartEngagementFromOpportunityTask.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

", + "idempotent":true + }, + "CreateResourceSnapshot":{ + "name":"CreateResourceSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceSnapshotRequest"}, + "output":{"shape":"CreateResourceSnapshotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true + }, + "CreateResourceSnapshotJob":{ + "name":"CreateResourceSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceSnapshotJobRequest"}, + "output":{"shape":"CreateResourceSnapshotJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true + }, + "DeleteResourceSnapshotJob":{ + "name":"DeleteResourceSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceSnapshotJobRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", "idempotent":true }, "DisassociateOpportunity":{ @@ -80,7 +188,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

" + "documentation":"

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

" }, "GetAwsOpportunitySummary":{ "name":"GetAwsOpportunitySummary", @@ -97,7 +205,23 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

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

" + "documentation":"

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

" + }, + "GetEngagement":{ + "name":"GetEngagement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEngagementRequest"}, + "output":{"shape":"GetEngagementResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" }, "GetEngagementInvitation":{ "name":"GetEngagementInvitation", @@ -131,7 +255,87 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

" + "documentation":"

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

" + }, + "GetResourceSnapshot":{ + "name":"GetResourceSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceSnapshotRequest"}, + "output":{"shape":"GetResourceSnapshotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Use this action to retrieve a specific snapshot record.

" + }, + "GetResourceSnapshotJob":{ + "name":"GetResourceSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceSnapshotJobRequest"}, + "output":{"shape":"GetResourceSnapshotJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, + "GetSellingSystemSettings":{ + "name":"GetSellingSystemSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSellingSystemSettingsRequest"}, + "output":{"shape":"GetSellingSystemSettingsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, + "ListEngagementByAcceptingInvitationTasks":{ + "name":"ListEngagementByAcceptingInvitationTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEngagementByAcceptingInvitationTasksRequest"}, + "output":{"shape":"ListEngagementByAcceptingInvitationTasksResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, + "ListEngagementFromOpportunityTasks":{ + "name":"ListEngagementFromOpportunityTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEngagementFromOpportunityTasksRequest"}, + "output":{"shape":"ListEngagementFromOpportunityTasksResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" }, "ListEngagementInvitations":{ "name":"ListEngagementInvitations", @@ -150,6 +354,54 @@ ], "documentation":"

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.

" }, + "ListEngagementMembers":{ + "name":"ListEngagementMembers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEngagementMembersRequest"}, + "output":{"shape":"ListEngagementMembersResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, + "ListEngagementResourceAssociations":{ + "name":"ListEngagementResourceAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEngagementResourceAssociationsRequest"}, + "output":{"shape":"ListEngagementResourceAssociationsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, + "ListEngagements":{ + "name":"ListEngagements", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEngagementsRequest"}, + "output":{"shape":"ListEngagementsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, "ListOpportunities":{ "name":"ListOpportunities", "http":{ @@ -165,7 +417,38 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the ListOpportunities action.

We recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

" + "documentation":"

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the ListOpportunities action.

We recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

" + }, + "ListResourceSnapshotJobs":{ + "name":"ListResourceSnapshotJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceSnapshotJobsRequest"}, + "output":{"shape":"ListResourceSnapshotJobsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ], + "documentation":"

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

" + }, + "ListResourceSnapshots":{ + "name":"ListResourceSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceSnapshotsRequest"}, + "output":{"shape":"ListResourceSnapshotsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list of resource view snapshots based on specified criteria.

" }, "ListSolutions":{ "name":"ListSolutions", @@ -181,7 +464,24 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

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.

" + "documentation":"

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.

" + }, + "PutSellingSystemSettings":{ + "name":"PutSellingSystemSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSellingSystemSettingsRequest"}, + "output":{"shape":"PutSellingSystemSettingsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true }, "RejectEngagementInvitation":{ "name":"RejectEngagementInvitation", @@ -237,6 +537,54 @@ ], "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.

" }, + "StartResourceSnapshotJob":{ + "name":"StartResourceSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartResourceSnapshotJobRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Starts a resource snapshot job that has been previously created.

", + "idempotent":true + }, + "StopResourceSnapshotJob":{ + "name":"StopResourceSnapshotJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopResourceSnapshotJobRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

", + "idempotent":true + }, + "SubmitOpportunity":{ + "name":"SubmitOpportunity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubmitOpportunityRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

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

" + }, "UpdateOpportunity":{ "name":"UpdateOpportunity", "http":{ @@ -253,52 +601,69 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

" + "documentation":"

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

" } }, "shapes":{ - "AccessDeniedException":{ + "AcceptEngagementInvitationRequest":{ "type":"structure", + "required":[ + "Catalog", + "Identifier" + ], "members":{ - "Message":{"shape":"String"} - }, - "documentation":"

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

", - "exception":true - }, + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.

" + }, + "Identifier":{ + "shape":"EngagementInvitationArnOrIdentifier", + "documentation":"

The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.

" + } + } + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

", + "exception":true + }, "Account":{ "type":"structure", "required":["CompanyName"], "members":{ "Address":{ "shape":"Address", - "documentation":"

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

" + "documentation":"

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

" }, "AwsAccountId":{ "shape":"AwsAccount", - "documentation":"

Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

" + "documentation":"

Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

" }, "CompanyName":{ "shape":"AccountCompanyNameString", - "documentation":"

Specifies the end Customer's company name associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's company name associated with the Opportunity.

" }, "Duns":{ "shape":"DunsNumber", - "documentation":"

Indicates the Customer DUNS number, if available.

" + "documentation":"

Indicates the Customer DUNS number, if available.

" }, "Industry":{ "shape":"Industry", - "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.

" + "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.

" }, "OtherIndustry":{ "shape":"AccountOtherIndustryString", - "documentation":"

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

" + "documentation":"

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

" }, "WebsiteUrl":{ "shape":"WebsiteUrl", - "documentation":"

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.

" + "documentation":"

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.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AccountCompanyNameString":{ "type":"string", @@ -332,26 +697,26 @@ "members":{ "Address":{ "shape":"AddressSummary", - "documentation":"

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

" + "documentation":"

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

" }, "CompanyName":{ "shape":"AccountSummaryCompanyNameString", - "documentation":"

Specifies the end Customer's company name associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's company name associated with the Opportunity.

" }, "Industry":{ "shape":"Industry", - "documentation":"

Specifies which industry the end Customer belongs to associated with the Opportunity. It refers to the category or sector that the customer's business operates in.

To submit a value outside the picklist, use Other.

Conditionally mandatory if Other is selected for Industry Vertical in LOVs.

" + "documentation":"

Specifies which industry the end Customer belongs to associated with the Opportunity. It refers to the category or sector that the customer's business operates in.

To submit a value outside the picklist, use Other.

Conditionally mandatory if Other is selected for Industry Vertical in LOVs.

" }, "OtherIndustry":{ "shape":"AccountSummaryOtherIndustryString", - "documentation":"

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.

" + "documentation":"

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.

" }, "WebsiteUrl":{ "shape":"WebsiteUrl", - "documentation":"

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.

" + "documentation":"

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.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AccountSummaryCompanyNameString":{ "type":"string", @@ -369,26 +734,26 @@ "members":{ "City":{ "shape":"AddressCityString", - "documentation":"

Specifies the end Customer's city associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's city associated with the Opportunity.

" }, "CountryCode":{ "shape":"CountryCode", - "documentation":"

Specifies the end Customer's country associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's country associated with the Opportunity.

" }, "PostalCode":{ "shape":"AddressPostalCodeString", - "documentation":"

Specifies the end Customer's postal code associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's postal code associated with the Opportunity.

" }, "StateOrRegion":{ "shape":"AddressPart", - "documentation":"

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" + "documentation":"

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" }, "StreetAddress":{ "shape":"AddressStreetAddressString", - "documentation":"

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

" + "documentation":"

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

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AddressCityString":{ "type":"string", @@ -417,22 +782,22 @@ "members":{ "City":{ "shape":"AddressSummaryCityString", - "documentation":"

Specifies the end Customer's city associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's city associated with the Opportunity.

" }, "CountryCode":{ "shape":"CountryCode", - "documentation":"

Specifies the end Customer's country associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's country associated with the Opportunity.

" }, "PostalCode":{ "shape":"AddressSummaryPostalCodeString", - "documentation":"

Specifies the end Customer's postal code associated with the Opportunity.

" + "documentation":"

Specifies the end Customer's postal code associated with the Opportunity.

" }, "StateOrRegion":{ "shape":"AddressPart", - "documentation":"

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" + "documentation":"

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AddressSummaryCityString":{ "type":"string", @@ -470,11 +835,11 @@ }, "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" }, "Identifier":{ "shape":"OpportunityIdentifier", - "documentation":"

Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

" + "documentation":"

Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

" } } }, @@ -529,19 +894,19 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" }, "OpportunityIdentifier":{ "shape":"OpportunityIdentifier", - "documentation":"

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

" + "documentation":"

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

" }, "RelatedEntityIdentifier":{ "shape":"AssociateOpportunityRequestRelatedEntityIdentifierString", - "documentation":"

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

" + "documentation":"

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

" }, "RelatedEntityType":{ "shape":"RelatedEntityType", - "documentation":"

Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

" + "documentation":"

Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

" } } }, @@ -552,13 +917,20 @@ }, "AwsAccount":{ "type":"string", - "pattern":"^[0-9]{12}$", + "pattern":"^([0-9]{12}|\\w{1,12})$", "sensitive":true }, - "AwsAccountIdOrLabel":{ - "type":"string", - "pattern":"^(aws|[0-9]{12})$", - "sensitive":true + "AwsAccountIdOrAliasList":{ + "type":"list", + "member":{"shape":"AwsAccount"}, + "max":10, + "min":1 + }, + "AwsAccountList":{ + "type":"list", + "member":{"shape":"AwsAccount"}, + "max":10, + "min":1 }, "AwsClosedLostReason":{ "type":"string", @@ -783,22 +1155,22 @@ "members":{ "BusinessTitle":{ "shape":"AwsMemberBusinessTitle", - "documentation":"

Specifies the Amazon Web Services team member's business title and indicates their organizational role.

" + "documentation":"

Specifies the Amazon Web Services team member's business title and indicates their organizational role.

" }, "Email":{ "shape":"Email", - "documentation":"

Provides the Amazon Web Services team member's email address.

" + "documentation":"

Provides the Amazon Web Services team member's email address.

" }, "FirstName":{ "shape":"AwsTeamMemberFirstNameString", - "documentation":"

Provides the Amazon Web Services team member's first name.

" + "documentation":"

Provides the Amazon Web Services team member's first name.

" }, "LastName":{ "shape":"AwsTeamMemberLastNameString", - "documentation":"

Provides the Amazon Web Services team member's last name.

" + "documentation":"

Provides the Amazon Web Services team member's last name.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "AwsTeamMemberFirstNameString":{ "type":"string", @@ -838,6 +1210,10 @@ "type":"list", "member":{"shape":"Channel"} }, + "ClientToken":{ + "type":"string", + "pattern":"^[!-~]{1,64}$" + }, "ClosedLostReason":{ "type":"string", "enum":[ @@ -896,7 +1272,7 @@ "members":{ "Message":{"shape":"String"} }, - "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.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

", + "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.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

", "exception":true }, "Contact":{ @@ -904,26 +1280,26 @@ "members":{ "BusinessTitle":{ "shape":"JobTitle", - "documentation":"

The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.

" + "documentation":"

The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.

" }, "Email":{ "shape":"Email", - "documentation":"

The contact's email address associated with the Opportunity.

" + "documentation":"

The contact's email address associated with the Opportunity.

" }, "FirstName":{ "shape":"ContactFirstNameString", - "documentation":"

The contact's first name associated with the Opportunity.

" + "documentation":"

The contact's first name associated with the Opportunity.

" }, "LastName":{ "shape":"ContactLastNameString", - "documentation":"

The contact's last name associated with the Opportunity.

" + "documentation":"

The contact's last name associated with the Opportunity.

" }, "Phone":{ "shape":"PhoneNumber", - "documentation":"

The contact's phone number associated with the Opportunity.

" + "documentation":"

The contact's phone number associated with the Opportunity.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "ContactFirstNameString":{ "type":"string", @@ -1192,6 +1568,100 @@ ], "sensitive":true }, + "CreateEngagementInvitationRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ClientToken", + "EngagementIdentifier", + "Invitation" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

", + "idempotencyToken":true + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

" + }, + "Invitation":{ + "shape":"Invitation", + "documentation":"

The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

" + } + } + }, + "CreateEngagementInvitationResponse":{ + "type":"structure", + "required":[ + "Arn", + "Id" + ], + "members":{ + "Arn":{ + "shape":"EngagementInvitationArn", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.

" + }, + "Id":{ + "shape":"EngagementInvitationIdentifier", + "documentation":"

Unique identifier assigned to the newly created engagement invitation.

" + } + } + }, + "CreateEngagementRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ClientToken", + "Description", + "Title" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

" + }, + "ClientToken":{ + "shape":"CreateEngagementRequestClientTokenString", + "documentation":"

The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

", + "idempotencyToken":true + }, + "Contexts":{ + "shape":"EngagementContexts", + "documentation":"

The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

" + }, + "Description":{ + "shape":"EngagementDescription", + "documentation":"

Provides a description of the Engagement.

" + }, + "Title":{ + "shape":"EngagementTitle", + "documentation":"

Specifies the title of the Engagement.

" + } + } + }, + "CreateEngagementRequestClientTokenString":{ + "type":"string", + "pattern":"^[!-~]{1,64}$" + }, + "CreateEngagementResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"EngagementArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the engagement.

" + }, + "Id":{ + "shape":"EngagementIdentifier", + "documentation":"

Unique identifier assigned to the newly created engagement.

" + } + } + }, "CreateOpportunityRequest":{ "type":"structure", "required":[ @@ -1201,20 +1671,20 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" }, "ClientToken":{ "shape":"CreateOpportunityRequestClientTokenString", - "documentation":"

Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

Default: None

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: \"Conflicting client token submitted for a new request body.\"

", + "documentation":"

Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

Default: None

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: \"Conflicting client token submitted for a new request body.\"

", "idempotencyToken":true }, "Customer":{ "shape":"Customer", - "documentation":"

Specifies customer details associated with the Opportunity.

" + "documentation":"

Specifies customer details associated with the Opportunity.

" }, "LifeCycle":{ "shape":"LifeCycle", - "documentation":"

An object that contains lifecycle details for the Opportunity.

" + "documentation":"

An object that contains lifecycle details for the Opportunity.

" }, "Marketing":{ "shape":"Marketing", @@ -1230,23 +1700,23 @@ }, "OpportunityType":{ "shape":"OpportunityType", - "documentation":"

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" + "documentation":"

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" }, "Origin":{ "shape":"OpportunityOrigin", - "documentation":"

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

" + "documentation":"

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

" }, "PartnerOpportunityIdentifier":{ "shape":"CreateOpportunityRequestPartnerOpportunityIdentifierString", - "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

" + "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

" }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" + "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" }, "Project":{ "shape":"Project", - "documentation":"

An object that contains project details for the Opportunity.

" + "documentation":"

An object that contains project details for the Opportunity.

" }, "SoftwareRevenue":{ "shape":"SoftwareRevenue", @@ -1269,15 +1739,125 @@ "members":{ "Id":{ "shape":"OpportunityIdentifier", - "documentation":"

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.

" + "documentation":"

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.

" }, "LastModifiedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.

" + "documentation":"

DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.

" }, "PartnerOpportunityIdentifier":{ "shape":"String", - "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" + "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" + } + } + }, + "CreateResourceSnapshotJobRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ClientToken", + "EngagementIdentifier", + "ResourceIdentifier", + "ResourceSnapshotTemplateIdentifier", + "ResourceType" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

" + }, + "ClientToken":{ + "shape":"CreateResourceSnapshotJobRequestClientTokenString", + "documentation":"

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot job creations.

", + "idempotencyToken":true + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

Specifies the identifier of the engagement associated with the resource to be snapshotted.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

" + }, + "ResourceSnapshotTemplateIdentifier":{ + "shape":"ResourceTemplateName", + "documentation":"

Specifies the name of the template that defines the schema for the snapshot.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource for which the snapshot job is being created. Must be one of the supported resource types Opportunity.

" + } + } + }, + "CreateResourceSnapshotJobRequestClientTokenString":{ + "type":"string", + "pattern":"^[!-~]{1,64}$" + }, + "CreateResourceSnapshotJobResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ResourceSnapshotJobArn", + "documentation":"

The Amazon Resource Name (ARN) of the created snapshot job.

" + }, + "Id":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The unique identifier for the created snapshot job.

" + } + } + }, + "CreateResourceSnapshotRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ClientToken", + "EngagementIdentifier", + "ResourceIdentifier", + "ResourceSnapshotTemplateIdentifier", + "ResourceType" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

" + }, + "ClientToken":{ + "shape":"CreateResourceSnapshotRequestClientTokenString", + "documentation":"

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

", + "idempotencyToken":true + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.

" + }, + "ResourceSnapshotTemplateIdentifier":{ + "shape":"ResourceTemplateName", + "documentation":"

The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

" + } + } + }, + "CreateResourceSnapshotRequestClientTokenString":{ + "type":"string", + "pattern":"^[!-~]{1,64}$" + }, + "CreateResourceSnapshotResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ResourceArn", + "documentation":"

Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.

" + }, + "Revision":{ + "shape":"ResourceSnapshotRevision", + "documentation":"

Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.

" } } }, @@ -1467,12 +2047,23 @@ "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.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "CustomerContactsList":{ "type":"list", "member":{"shape":"Contact"} }, + "CustomerProjectsContext":{ + "type":"structure", + "members":{ + "Customer":{"shape":"EngagementCustomer"}, + "Project":{ + "shape":"EngagementCustomerProjectDetails", + "documentation":"

Information about the customer project associated with the Engagement.

" + } + }, + "documentation":"

The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers.

All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.

" + }, "CustomerSummary":{ "type":"structure", "members":{ @@ -1481,7 +2072,7 @@ "documentation":"

An object that contains a customer's account details.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "Date":{ "type":"string", @@ -1491,6 +2082,23 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "DeleteResourceSnapshotJobRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ResourceSnapshotJobIdentifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.

" + }, + "ResourceSnapshotJobIdentifier":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The unique identifier of the resource snapshot job to be deleted.

" + } + } + }, "DeliveryModel":{ "type":"string", "enum":[ @@ -1517,19 +2125,19 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" }, "OpportunityIdentifier":{ "shape":"OpportunityIdentifier", - "documentation":"

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

" + "documentation":"

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

" }, "RelatedEntityIdentifier":{ "shape":"DisassociateOpportunityRequestRelatedEntityIdentifierString", - "documentation":"

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

" + "documentation":"

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

" }, "RelatedEntityType":{ "shape":"RelatedEntityType", - "documentation":"

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

" + "documentation":"

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

" } } }, @@ -1550,6 +2158,50 @@ "pattern":"^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$", "sensitive":true }, + "EngagementArn":{ + "type":"string", + "pattern":"^arn:.*" + }, + "EngagementArnOrIdentifier":{ + "type":"string", + "pattern":"^(arn:.*|eng-[0-9a-z]{14})$" + }, + "EngagementContextDetails":{ + "type":"structure", + "required":["Type"], + "members":{ + "Payload":{ + "shape":"EngagementContextPayload", + "documentation":"

Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

" + }, + "Type":{ + "shape":"EngagementContextType", + "documentation":"

Specifies the type of Engagement context. Valid values are \"CustomerProject\" or \"Document\", indicating whether the context relates to a customer project or a document respectively.

" + } + }, + "documentation":"

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

" + }, + "EngagementContextPayload":{ + "type":"structure", + "members":{ + "CustomerProject":{ + "shape":"CustomerProjectsContext", + "documentation":"

Contains detailed information about a customer project when the context type is \"CustomerProject\". This field is present only when the Type in EngagementContextDetails is set to \"CustomerProject\".

" + } + }, + "documentation":"

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

", + "union":true + }, + "EngagementContextType":{ + "type":"string", + "enum":["CustomerProject"] + }, + "EngagementContexts":{ + "type":"list", + "member":{"shape":"EngagementContextDetails"}, + "max":5, + "min":0 + }, "EngagementCustomer":{ "type":"structure", "required":[ @@ -1584,6 +2236,57 @@ "min":20, "sensitive":true }, + "EngagementCustomerProjectDetails":{ + "type":"structure", + "required":[ + "BusinessProblem", + "TargetCompletionDate", + "Title" + ], + "members":{ + "BusinessProblem":{ + "shape":"EngagementCustomerBusinessProblem", + "documentation":"

A description of the business problem the project aims to solve.

" + }, + "TargetCompletionDate":{ + "shape":"EngagementCustomerProjectDetailsTargetCompletionDateString", + "documentation":"

The target completion date for the customer's project.

" + }, + "Title":{ + "shape":"EngagementCustomerProjectTitle", + "documentation":"

The title of the project.

" + } + }, + "documentation":"

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

" + }, + "EngagementCustomerProjectDetailsTargetCompletionDateString":{ + "type":"string", + "pattern":"^[1-9][0-9]{3}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$" + }, + "EngagementCustomerProjectTitle":{ + "type":"string", + "max":255, + "min":1 + }, + "EngagementDescription":{ + "type":"string", + "max":255, + "min":0 + }, + "EngagementIdentifier":{ + "type":"string", + "pattern":"^eng-[0-9a-z]{14}$" + }, + "EngagementIdentifiers":{ + "type":"list", + "member":{"shape":"EngagementArnOrIdentifier"}, + "max":10, + "min":1 + }, + "EngagementInvitationArn":{ + "type":"string", + "pattern":"^arn:aws:partnercentral::[0-9]{12}:[a-zA-Z]+/engagement-invitation/engi-[0-9,a-z]{13}$" + }, "EngagementInvitationArnOrIdentifier":{ "type":"string", "max":255, @@ -1594,6 +2297,12 @@ "type":"string", "pattern":"^engi-[0-9,a-z]{13}$" }, + "EngagementInvitationIdentifiers":{ + "type":"list", + "member":{"shape":"EngagementInvitationArnOrIdentifier"}, + "max":10, + "min":1 + }, "EngagementInvitationPayloadType":{ "type":"string", "enum":["OpportunityInvitation"] @@ -1617,6 +2326,10 @@ "shape":"CatalogIdentifier", "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.

" }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.

" + }, "EngagementTitle":{ "shape":"EngagementTitle", "documentation":"

Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.

" @@ -1633,6 +2346,10 @@ "shape":"DateTime", "documentation":"

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.

" }, + "ParticipantType":{ + "shape":"ParticipantType", + "documentation":"

Identifies the role of the caller in the engagement invitation.

" + }, "PayloadType":{ "shape":"EngagementInvitationPayloadType", "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.

" @@ -1642,7 +2359,7 @@ "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.

" }, "SenderAwsAccountId":{ - "shape":"AwsAccountIdOrLabel", + "shape":"AwsAccount", "documentation":"

Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.

" }, "SenderCompanyName":{ @@ -1665,37 +2382,176 @@ "type":"list", "member":{"shape":"EngagementInvitationPayloadType"} }, - "EngagementScore":{ - "type":"string", - "enum":[ - "High", - "Medium", - "Low" - ] - }, - "EngagementTitle":{ - "type":"string", - "max":40, - "min":1 - }, - "ExpectedCustomerSpend":{ + "EngagementMember":{ "type":"structure", - "required":[ - "Amount", - "CurrencyCode", - "Frequency", - "TargetCompany" - ], "members":{ - "Amount":{ - "shape":"String", - "documentation":"

Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

" + "AccountId":{ + "shape":"AwsAccount", + "documentation":"

This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification.

" }, - "CurrencyCode":{ - "shape":"ExpectedCustomerSpendCurrencyCodeEnum", - "documentation":"

Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

" + "CompanyName":{ + "shape":"MemberCompanyName", + "documentation":"

The official name of the member's company or organization.

" }, - "Frequency":{ + "WebsiteUrl":{ + "shape":"String", + "documentation":"

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

" + } + }, + "documentation":"

Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement.

Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.

" + }, + "EngagementMemberSummaries":{ + "type":"list", + "member":{"shape":"EngagementMemberSummary"} + }, + "EngagementMemberSummary":{ + "type":"structure", + "members":{ + "CompanyName":{ + "shape":"MemberCompanyName", + "documentation":"

The official name of the member's company or organization.

" + }, + "WebsiteUrl":{ + "shape":"String", + "documentation":"

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

" + } + }, + "documentation":"

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

" + }, + "EngagementMembers":{ + "type":"list", + "member":{"shape":"EngagementMember"}, + "max":10, + "min":0 + }, + "EngagementPageSize":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "EngagementResourceAssociationSummary":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Indicates the environment in which the resource and engagement exist.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

The AWS account ID of the entity that created the association.

" + }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

A unique identifier for the engagement associated with the resource.

" + }, + "ResourceId":{ + "shape":"ResourceIdentifier", + "documentation":"

A unique identifier for the specific resource. Varies depending on the resource type.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Categorizes the type of resource associated with the engagement.

" + } + }, + "documentation":"

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

" + }, + "EngagementResourceAssociationSummaryList":{ + "type":"list", + "member":{"shape":"EngagementResourceAssociationSummary"} + }, + "EngagementScore":{ + "type":"string", + "enum":[ + "High", + "Medium", + "Low" + ] + }, + "EngagementSort":{ + "type":"structure", + "required":[ + "SortBy", + "SortOrder" + ], + "members":{ + "SortBy":{ + "shape":"EngagementSortName", + "documentation":"

The field by which to sort the results.

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

The order in which to sort the results.

" + } + }, + "documentation":"

Specifies the sorting parameters for listing Engagements.

" + }, + "EngagementSortName":{ + "type":"string", + "enum":["CreatedDate"] + }, + "EngagementSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"EngagementArn", + "documentation":"

The Amazon Resource Name (ARN) of the created engagement.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The date and time when the engagement was created.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

The AWS account ID of the engagement creator.

" + }, + "Id":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier for the engagement.

" + }, + "MemberCount":{ + "shape":"Integer", + "documentation":"

The number of members in the engagement.

" + }, + "Title":{ + "shape":"EngagementTitle", + "documentation":"

The title of the engagement.

" + } + }, + "documentation":"

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

" + }, + "EngagementSummaryList":{ + "type":"list", + "member":{"shape":"EngagementSummary"} + }, + "EngagementTitle":{ + "type":"string", + "max":40, + "min":1 + }, + "ExpectedCustomerSpend":{ + "type":"structure", + "required":[ + "Amount", + "CurrencyCode", + "Frequency", + "TargetCompany" + ], + "members":{ + "Amount":{ + "shape":"String", + "documentation":"

Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

" + }, + "CurrencyCode":{ + "shape":"ExpectedCustomerSpendCurrencyCodeEnum", + "documentation":"

Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

" + }, + "EstimationUrl":{ + "shape":"WebsiteUrl", + "documentation":"

A URL providing additional information or context about the spend estimation.

" + }, + "Frequency":{ "shape":"PaymentFrequency", "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.

" }, @@ -1900,11 +2756,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

" + "documentation":"

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

" }, "RelatedOpportunityIdentifier":{ "shape":"OpportunityIdentifier", - "documentation":"

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

" + "documentation":"

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

" } } }, @@ -1914,51 +2770,51 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

" + "documentation":"

Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

" }, "Customer":{ "shape":"AwsOpportunityCustomer", - "documentation":"

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.

" + "documentation":"

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.

" }, "Insights":{ "shape":"AwsOpportunityInsights", - "documentation":"

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

" + "documentation":"

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

" }, "InvolvementType":{ "shape":"SalesInvolvementType", - "documentation":"

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.

" + "documentation":"

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.

" }, "InvolvementTypeChangeReason":{ "shape":"InvolvementTypeChangeReason", - "documentation":"

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

" + "documentation":"

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

" }, "LifeCycle":{ "shape":"AwsOpportunityLifeCycle", - "documentation":"

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

" + "documentation":"

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

" }, "OpportunityTeam":{ "shape":"AwsOpportunityTeamMembersList", - "documentation":"

Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.

" + "documentation":"

Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.

" }, "Origin":{ "shape":"OpportunityOrigin", - "documentation":"

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

" + "documentation":"

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

" }, "Project":{ "shape":"AwsOpportunityProject", - "documentation":"

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

" + "documentation":"

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

" }, "RelatedEntityIds":{ "shape":"AwsOpportunityRelatedEntities", - "documentation":"

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

" + "documentation":"

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

" }, "RelatedOpportunityId":{ "shape":"OpportunityIdentifier", - "documentation":"

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

" + "documentation":"

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

" }, "Visibility":{ "shape":"Visibility", - "documentation":"

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

" + "documentation":"

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

" } } }, @@ -1994,10 +2850,22 @@ "shape":"CatalogIdentifier", "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.

" }, + "EngagementDescription":{ + "shape":"EngagementDescription", + "documentation":"

The description of the engagement associated with this invitation.

" + }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

" + }, "EngagementTitle":{ "shape":"EngagementTitle", "documentation":"

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

" }, + "ExistingMembers":{ + "shape":"EngagementMemberSummaries", + "documentation":"

A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.

" + }, "ExpirationDate":{ "shape":"DateTime", "documentation":"

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

" @@ -2010,6 +2878,10 @@ "shape":"DateTime", "documentation":"

The date when the engagement invitation was sent to the partner.

" }, + "InvitationMessage":{ + "shape":"InvitationMessage", + "documentation":"

The message sent to the invited partner when the invitation was created.

" + }, "Payload":{ "shape":"Payload", "documentation":"

Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

" @@ -2027,8 +2899,8 @@ "documentation":"

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

" }, "SenderAwsAccountId":{ - "shape":"AwsAccountIdOrLabel", - "documentation":"

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

" + "shape":"AwsAccount", + "documentation":"

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

" }, "SenderCompanyName":{ "shape":"GetEngagementInvitationResponseSenderCompanyNameString", @@ -2045,6 +2917,60 @@ "max":120, "min":0 }, + "GetEngagementRequest":{ + "type":"structure", + "required":[ + "Catalog", + "Identifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

" + }, + "Identifier":{ + "shape":"EngagementArnOrIdentifier", + "documentation":"

Specifies the identifier of the Engagement record to retrieve.

" + } + } + }, + "GetEngagementResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"EngagementArn", + "documentation":"

The Amazon Resource Name (ARN) of the engagement retrieved.

" + }, + "Contexts":{ + "shape":"EngagementContexts", + "documentation":"

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the Engagement.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

" + }, + "Description":{ + "shape":"EngagementDescription", + "documentation":"

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

" + }, + "Id":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique resource identifier of the engagement retrieved.

" + }, + "MemberCount":{ + "shape":"Integer", + "documentation":"

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

" + }, + "Title":{ + "shape":"EngagementTitle", + "documentation":"

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

" + } + } + }, "GetOpportunityRequest":{ "type":"structure", "required":[ @@ -2054,11 +2980,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

" }, "Identifier":{ "shape":"OpportunityIdentifier", - "documentation":"

Read-only, system generated Opportunity unique identifier.

" + "documentation":"

Read-only, system generated Opportunity unique identifier.

" } } }, @@ -2072,33 +2998,37 @@ "RelatedEntityIdentifiers" ], "members":{ + "Arn":{ + "shape":"OpportunityArn", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the opportunity.

" + }, "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

" }, "CreatedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the Opportunity was last created.

" + "documentation":"

DateTime when the Opportunity was last created.

" }, "Customer":{ "shape":"Customer", - "documentation":"

Specifies details of the customer associated with the Opportunity.

" + "documentation":"

Specifies details of the customer associated with the Opportunity.

" }, "Id":{ "shape":"OpportunityIdentifier", - "documentation":"

Read-only, system generated Opportunity unique identifier.

" + "documentation":"

Read-only, system generated Opportunity unique identifier.

" }, "LastModifiedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the opportunity was last modified.

" + "documentation":"

DateTime when the opportunity was last modified.

" }, "LifeCycle":{ "shape":"LifeCycle", - "documentation":"

An object that contains lifecycle details for the Opportunity.

" + "documentation":"

An object that contains lifecycle details for the Opportunity.

" }, "Marketing":{ "shape":"Marketing", - "documentation":"

An object that contains marketing details for the Opportunity.

" + "documentation":"

An object that contains marketing details for the Opportunity.

" }, "NationalSecurity":{ "shape":"NationalSecurity", @@ -2110,23 +3040,23 @@ }, "OpportunityType":{ "shape":"OpportunityType", - "documentation":"

Specifies the opportunity type as renewal, new, or expansion.

Opportunity types:

" + "documentation":"

Specifies the opportunity type as renewal, new, or expansion.

Opportunity types:

" }, "PartnerOpportunityIdentifier":{ "shape":"GetOpportunityResponsePartnerOpportunityIdentifierString", - "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" + "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" + "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" }, "Project":{ "shape":"Project", - "documentation":"

An object that contains project details summary for the Opportunity.

" + "documentation":"

An object that contains project details summary for the Opportunity.

" }, "RelatedEntityIdentifiers":{ "shape":"RelatedEntityIdentifiers", - "documentation":"

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

" + "documentation":"

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

" }, "SoftwareRevenue":{ "shape":"SoftwareRevenue", @@ -2139,6 +3069,180 @@ "max":64, "min":0 }, + "GetResourceSnapshotJobRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ResourceSnapshotJobIdentifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request. Valid values are:

" + }, + "ResourceSnapshotJobIdentifier":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

" + } + } + }, + "GetResourceSnapshotJobResponse":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Arn":{ + "shape":"ResourceSnapshotJobArn", + "documentation":"

he Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

" + }, + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

The catalog in which the snapshot job was created. This will match the catalog specified in the request.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The date and time when the snapshot job was created, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"

" + }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

" + }, + "Id":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

" + }, + "LastFailure":{ + "shape":"String", + "documentation":"

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

" + }, + "LastSuccessfulExecutionDate":{ + "shape":"DateTime", + "documentation":"

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"

" + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

" + }, + "ResourceId":{ + "shape":"ResourceIdentifier", + "documentation":"

The identifier of the specific resource being snapshotted. The format may vary depending on the ResourceType.

" + }, + "ResourceSnapshotTemplateName":{ + "shape":"ResourceTemplateName", + "documentation":"

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource being snapshotted. This would have Opportunity as a value as it is dependent on the supported resource type.

" + }, + "Status":{ + "shape":"ResourceSnapshotJobStatus", + "documentation":"

The current status of the snapshot job. Valid values:

" + } + } + }, + "GetResourceSnapshotRequest":{ + "type":"structure", + "required":[ + "Catalog", + "EngagementIdentifier", + "ResourceIdentifier", + "ResourceSnapshotTemplateIdentifier", + "ResourceType" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request. Valid values are:

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

" + }, + "ResourceSnapshotTemplateIdentifier":{ + "shape":"ResourceTemplateName", + "documentation":"

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

" + }, + "Revision":{ + "shape":"ResourceSnapshotRevision", + "documentation":"

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

" + } + } + }, + "GetResourceSnapshotResponse":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Arn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for resource-specific operations across AWS services.

" + }, + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

The catalog in which the snapshot was created. Matches the Catalog specified in the request.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The timestamp when the snapshot was created, in ISO 8601 format (e.g., \"2023-06-01T14:30:00Z\"). This allows for precise tracking of when the snapshot was taken.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.

" + }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.

" + }, + "Payload":{"shape":"ResourceSnapshotPayload"}, + "ResourceId":{ + "shape":"ResourceIdentifier", + "documentation":"

The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.

" + }, + "ResourceSnapshotTemplateName":{ + "shape":"ResourceTemplateName", + "documentation":"

The name of the view used for this snapshot. This is the same as the template name.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of the resource that was snapshotted. Matches the ResourceType specified in the request.

" + }, + "Revision":{ + "shape":"ResourceSnapshotRevision", + "documentation":"

The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.

" + } + } + }, + "GetSellingSystemSettingsRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

" + } + } + }, + "GetSellingSystemSettingsResponse":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

" + }, + "ResourceSnapshotJobRoleArn":{ + "shape":"ResourceSnapshotJobRoleArn", + "documentation":"

Specifies the ARN of the IAM Role used for resource snapshot job executions.

" + } + } + }, "Industry":{ "type":"string", "enum":[ @@ -2172,15 +3276,41 @@ "Other" ] }, + "Integer":{ + "type":"integer", + "box":true + }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, - "documentation":"

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

", + "documentation":"

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

", "exception":true, "fault":true }, + "Invitation":{ + "type":"structure", + "required":[ + "Message", + "Payload", + "Receiver" + ], + "members":{ + "Message":{ + "shape":"InvitationMessage", + "documentation":"

A message accompanying the invitation.

" + }, + "Payload":{"shape":"Payload"}, + "Receiver":{"shape":"Receiver"} + }, + "documentation":"

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

" + }, + "InvitationMessage":{ + "type":"string", + "max":255, + "min":1 + }, "InvitationStatus":{ "type":"string", "enum":[ @@ -2190,6 +3320,12 @@ "EXPIRED" ] }, + "InvitationStatusList":{ + "type":"list", + "member":{"shape":"InvitationStatus"}, + "max":10, + "min":1 + }, "InvolvementTypeChangeReason":{ "type":"string", "enum":[ @@ -2225,15 +3361,15 @@ "members":{ "ClosedLostReason":{ "shape":"ClosedLostReason", - "documentation":"

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

" + "documentation":"

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

" }, "NextSteps":{ "shape":"LifeCycleNextStepsString", - "documentation":"

Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.

" + "documentation":"

Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.

" }, "NextStepsHistory":{ "shape":"LifeCycleNextStepsHistoryList", - "documentation":"

Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

" + "documentation":"

Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

" }, "ReviewComments":{ "shape":"String", @@ -2241,28 +3377,56 @@ }, "ReviewStatus":{ "shape":"ReviewStatus", - "documentation":"

Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

" + "documentation":"

Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

" }, "ReviewStatusReason":{ "shape":"String", - "documentation":"

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.

" + "documentation":"

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.

" }, "Stage":{ "shape":"Stage", - "documentation":"

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" + "documentation":"

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" }, "TargetCloseDate":{ "shape":"Date", - "documentation":"

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" + "documentation":"

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" } }, - "documentation":"

An object that contains the Opportunity lifecycle's details.

" - }, - "LifeCycleNextStepsHistoryList":{ - "type":"list", - "member":{"shape":"NextStepsHistory"}, - "max":50, - "min":0 + "documentation":"

An object that contains the Opportunity lifecycle's details.

" + }, + "LifeCycleForView":{ + "type":"structure", + "members":{ + "NextSteps":{ + "shape":"LifeCycleForViewNextStepsString", + "documentation":"

Describes the next steps for the opportunity shared through a snapshot.

" + }, + "ReviewStatus":{ + "shape":"ReviewStatus", + "documentation":"

Defines the approval status of the opportunity shared through a snapshot.

" + }, + "Stage":{ + "shape":"Stage", + "documentation":"

Defines the current stage of the opportunity shared through a snapshot.

" + }, + "TargetCloseDate":{ + "shape":"Date", + "documentation":"

The projected launch date of the opportunity shared through a snapshot.

" + } + }, + "documentation":"

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

" + }, + "LifeCycleForViewNextStepsString":{ + "type":"string", + "max":255, + "min":0, + "sensitive":true + }, + "LifeCycleNextStepsHistoryList":{ + "type":"list", + "member":{"shape":"NextStepsHistory"}, + "max":50, + "min":0 }, "LifeCycleNextStepsString":{ "type":"string", @@ -2275,11 +3439,11 @@ "members":{ "ClosedLostReason":{ "shape":"ClosedLostReason", - "documentation":"

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.

" + "documentation":"

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.

" }, "NextSteps":{ "shape":"LifeCycleSummaryNextStepsString", - "documentation":"

Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

" + "documentation":"

Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

" }, "ReviewComments":{ "shape":"String", @@ -2287,22 +3451,22 @@ }, "ReviewStatus":{ "shape":"ReviewStatus", - "documentation":"

Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:

" + "documentation":"

Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:

" }, "ReviewStatusReason":{ "shape":"String", - "documentation":"

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.

" + "documentation":"

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.

" }, "Stage":{ "shape":"Stage", - "documentation":"

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" + "documentation":"

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" }, "TargetCloseDate":{ "shape":"Date", - "documentation":"

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" + "documentation":"

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "LifeCycleSummaryNextStepsString":{ "type":"string", @@ -2310,6 +3474,226 @@ "min":0, "sensitive":true }, + "ListEngagementByAcceptingInvitationTaskSummaries":{ + "type":"list", + "member":{"shape":"ListEngagementByAcceptingInvitationTaskSummary"} + }, + "ListEngagementByAcceptingInvitationTaskSummary":{ + "type":"structure", + "members":{ + "EngagementInvitationId":{ + "shape":"EngagementInvitationIdentifier", + "documentation":"

The unique identifier of the engagement invitation that was accepted.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Detailed message describing the failure and possible recovery steps.

" + }, + "OpportunityId":{ + "shape":"OpportunityIdentifier", + "documentation":"

Unique identifier of opportunity that was created.

" + }, + "ReasonCode":{ + "shape":"ReasonCode", + "documentation":"

A code pointing to the specific reason for the failure.

" + }, + "ResourceSnapshotJobId":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

Unique identifier of the resource snapshot job that was created.

" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

Task start timestamp.

" + }, + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the task.

" + }, + "TaskId":{ + "shape":"TaskIdentifier", + "documentation":"

Unique identifier of the task.

" + }, + "TaskStatus":{ + "shape":"TaskStatus", + "documentation":"

Status of the task.

" + } + }, + "documentation":"

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

" + }, + "ListEngagementByAcceptingInvitationTasksRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request. Valid values are:

" + }, + "EngagementInvitationIdentifier":{ + "shape":"EngagementInvitationIdentifiers", + "documentation":"

Filters tasks by the identifiers of the engagement invitations they are processing.

" + }, + "MaxResults":{ + "shape":"ListEngagementByAcceptingInvitationTasksRequestMaxResultsInteger", + "documentation":"

Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

" + }, + "NextToken":{ + "shape":"ListEngagementByAcceptingInvitationTasksRequestNextTokenString", + "documentation":"

Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

" + }, + "OpportunityIdentifier":{ + "shape":"OpportunityIdentifiers", + "documentation":"

Filters tasks by the identifiers of the opportunities they created or are associated with.

" + }, + "Sort":{ + "shape":"ListTasksSortBase", + "documentation":"

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

" + }, + "TaskIdentifier":{ + "shape":"TaskIdentifiers", + "documentation":"

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

" + }, + "TaskStatus":{ + "shape":"TaskStatuses", + "documentation":"

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

" + } + } + }, + "ListEngagementByAcceptingInvitationTasksRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListEngagementByAcceptingInvitationTasksRequestNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListEngagementByAcceptingInvitationTasksResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

" + }, + "TaskSummaries":{ + "shape":"ListEngagementByAcceptingInvitationTaskSummaries", + "documentation":"

An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

" + } + } + }, + "ListEngagementFromOpportunityTaskSummaries":{ + "type":"list", + "member":{"shape":"ListEngagementFromOpportunityTaskSummary"} + }, + "ListEngagementFromOpportunityTaskSummary":{ + "type":"structure", + "members":{ + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.

" + }, + "EngagementInvitationId":{ + "shape":"EngagementInvitationIdentifier", + "documentation":"

The unique identifier of the engagement identifier created as a result of the task. This field is populated when the task is completed successfully.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution

" + }, + "OpportunityId":{ + "shape":"OpportunityIdentifier", + "documentation":"

The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

" + }, + "ReasonCode":{ + "shape":"ReasonCode", + "documentation":"

A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

" + }, + "ResourceSnapshotJobId":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

" + }, + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

" + }, + "TaskId":{ + "shape":"TaskIdentifier", + "documentation":"

A unique identifier for a specific task.

" + }, + "TaskStatus":{ + "shape":"TaskStatus", + "documentation":"

The current status of the task.

" + } + }, + "documentation":"

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

" + }, + "ListEngagementFromOpportunityTasksRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request. Valid values are:

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifiers", + "documentation":"

Filters tasks by the identifiers of the engagements they created or are associated with.

" + }, + "MaxResults":{ + "shape":"ListEngagementFromOpportunityTasksRequestMaxResultsInteger", + "documentation":"

Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

" + }, + "NextToken":{ + "shape":"ListEngagementFromOpportunityTasksRequestNextTokenString", + "documentation":"

The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

" + }, + "OpportunityIdentifier":{ + "shape":"OpportunityIdentifiers", + "documentation":"

The identifier of the original opportunity associated with this task.

" + }, + "Sort":{ + "shape":"ListTasksSortBase", + "documentation":"

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

" + }, + "TaskIdentifier":{ + "shape":"TaskIdentifiers", + "documentation":"

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

" + }, + "TaskStatus":{ + "shape":"TaskStatuses", + "documentation":"

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

" + } + } + }, + "ListEngagementFromOpportunityTasksRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListEngagementFromOpportunityTasksRequestNextTokenString":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListEngagementFromOpportunityTasksResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

" + }, + "TaskSummaries":{ + "shape":"ListEngagementFromOpportunityTaskSummaries", + "documentation":"

TaskSummaries An array of TaskSummary objects containing details about each task.

" + } + } + }, "ListEngagementInvitationsRequest":{ "type":"structure", "required":[ @@ -2321,6 +3705,10 @@ "shape":"CatalogIdentifier", "documentation":"

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

" }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifiers", + "documentation":"

Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

" + }, "MaxResults":{ "shape":"PageSize", "documentation":"

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

" @@ -2337,9 +3725,17 @@ "shape":"EngagementInvitationsPayloadType", "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.

" }, + "SenderAwsAccountId":{ + "shape":"AwsAccountIdOrAliasList", + "documentation":"

List of sender AWS account IDs to filter the invitations.

" + }, "Sort":{ "shape":"OpportunityEngagementInvitationSort", "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.

" + }, + "Status":{ + "shape":"InvitationStatusList", + "documentation":"

Status values to filter the invitations.

" } } }, @@ -2356,13 +3752,154 @@ } } }, + "ListEngagementMembersRequest":{ + "type":"structure", + "required":[ + "Catalog", + "Identifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

The catalog related to the request.

" + }, + "Identifier":{ + "shape":"EngagementArnOrIdentifier", + "documentation":"

Identifier of the engagement record to retrieve members from.

" + }, + "MaxResults":{ + "shape":"MemberPageSize", + "documentation":"

The maximum number of results to return in a single call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + } + } + }, + "ListEngagementMembersResponse":{ + "type":"structure", + "required":["EngagementMemberList"], + "members":{ + "EngagementMemberList":{ + "shape":"EngagementMembers", + "documentation":"

Provides a list of engagement members.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.

" + } + } + }, + "ListEngagementResourceAssociationsRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which to search for engagement-resource associations.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

Filters the results to include only associations with resources owned by the specified AWS account. Use this when you want to find associations related to resources owned by a particular account.

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

" + }, + "MaxResults":{ + "shape":"ListEngagementResourceAssociationsRequestMaxResultsInteger", + "documentation":"

Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Filters the results to include only associations with resources of the specified type.

" + } + } + }, + "ListEngagementResourceAssociationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListEngagementResourceAssociationsResponse":{ + "type":"structure", + "required":["EngagementResourceAssociationSummaries"], + "members":{ + "EngagementResourceAssociationSummaries":{ + "shape":"EngagementResourceAssociationSummaryList", + "documentation":"

A list of engagement-resource association summaries.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.

" + } + } + }, + "ListEngagementsRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "CreatedBy":{ + "shape":"AwsAccountList", + "documentation":"

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifiers", + "documentation":"

An array of strings representing engagement identifiers to retrieve.

" + }, + "ExcludeCreatedBy":{ + "shape":"AwsAccountList", + "documentation":"

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

" + }, + "MaxResults":{ + "shape":"EngagementPageSize", + "documentation":"

The maximum number of results to return in a single call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results. This value is returned from a previous call.

" + }, + "Sort":{ + "shape":"EngagementSort", + "documentation":"

An object that specifies the sort order of the results.

" + } + } + }, + "ListEngagementsResponse":{ + "type":"structure", + "required":["EngagementSummaryList"], + "members":{ + "EngagementSummaryList":{ + "shape":"EngagementSummaryList", + "documentation":"

An array of engagement summary objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next set of results. This field will be null if there are no more results.

" + } + } + }, "ListOpportunitiesRequest":{ "type":"structure", "required":["Catalog"], "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

" }, "CustomerCompanyName":{ "shape":"ListOpportunitiesRequestCustomerCompanyNameList", @@ -2386,15 +3923,15 @@ }, "MaxResults":{ "shape":"PageSize", - "documentation":"

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

" + "documentation":"

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

" }, "NextToken":{ "shape":"String", - "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" + "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" }, "Sort":{ "shape":"OpportunitySort", - "documentation":"

An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

" + "documentation":"

An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

" } } }, @@ -2416,23 +3953,134 @@ "max":10, "min":0 }, - "ListOpportunitiesRequestLifeCycleStageList":{ - "type":"list", - "member":{"shape":"Stage"}, - "max":10, - "min":0 + "ListOpportunitiesRequestLifeCycleStageList":{ + "type":"list", + "member":{"shape":"Stage"}, + "max":10, + "min":0 + }, + "ListOpportunitiesResponse":{ + "type":"structure", + "required":["OpportunitySummaries"], + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" + }, + "OpportunitySummaries":{ + "shape":"OpportunitySummaries", + "documentation":"

An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

" + } + } + }, + "ListResourceSnapshotJobsRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the engagement to filter the response.

" + }, + "MaxResults":{ + "shape":"ListResourceSnapshotJobsRequestMaxResultsInteger", + "documentation":"

The maximum number of results to return in a single call. If omitted, defaults to 50.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "Sort":{ + "shape":"SortObject", + "documentation":"

Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

" + }, + "Status":{ + "shape":"ResourceSnapshotJobStatus", + "documentation":"

The status of the jobs to filter the response.

" + } + } + }, + "ListResourceSnapshotJobsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "ListResourceSnapshotJobsResponse":{ + "type":"structure", + "required":["ResourceSnapshotJobSummaries"], + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next set of results. If there are no additional results, this value is null.

" + }, + "ResourceSnapshotJobSummaries":{ + "shape":"ResourceSnapshotJobSummaryList", + "documentation":"

An array of resource snapshot job summary objects.

" + } + } + }, + "ListResourceSnapshotsRequest":{ + "type":"structure", + "required":[ + "Catalog", + "EngagementIdentifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

Filters the response to include only snapshots of resources created by the specified AWS account.

" + }, + "EngagementIdentifier":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier of the engagement associated with the snapshots.

" + }, + "MaxResults":{ + "shape":"ListResourceSnapshotsRequestMaxResultsInteger", + "documentation":"

The maximum number of results to return in a single call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Filters the response to include only snapshots of the specified resource.

" + }, + "ResourceSnapshotTemplateIdentifier":{ + "shape":"ResourceTemplateName", + "documentation":"

Filters the response to include only snapshots created using the specified template.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Filters the response to include only snapshots of the specified resource type.

" + } + } + }, + "ListResourceSnapshotsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 }, - "ListOpportunitiesResponse":{ + "ListResourceSnapshotsResponse":{ "type":"structure", - "required":["OpportunitySummaries"], + "required":["ResourceSnapshotSummaries"], "members":{ "NextToken":{ "shape":"String", - "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" + "documentation":"

The token to retrieve the next set of results. If there are no additional results, this value is null.

" }, - "OpportunitySummaries":{ - "shape":"OpportunitySummaries", - "documentation":"

An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

" + "ResourceSnapshotSummaries":{ + "shape":"ResourceSnapshotSummaryList", + "documentation":"

An array of resource snapshot summary objects.

" } } }, @@ -2442,7 +4090,7 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

" }, "Category":{ "shape":"ListSolutionsRequestCategoryList", @@ -2454,15 +4102,15 @@ }, "MaxResults":{ "shape":"PageSize", - "documentation":"

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

" + "documentation":"

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

" }, "NextToken":{ "shape":"String", - "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" + "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" }, "Sort":{ "shape":"SolutionSort", - "documentation":"

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

" + "documentation":"

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

" }, "Status":{ "shape":"ListSolutionsRequestStatusList", @@ -2494,7 +4142,7 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" + "documentation":"

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" }, "SolutionSummaries":{ "shape":"SolutionList", @@ -2502,31 +4150,53 @@ } } }, + "ListTasksSortBase":{ + "type":"structure", + "required":[ + "SortBy", + "SortOrder" + ], + "members":{ + "SortBy":{ + "shape":"ListTasksSortName", + "documentation":"

Specifies the field by which the task list should be sorted.

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

Determines the order in which the sorted results are presented.

" + } + }, + "documentation":"

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

" + }, + "ListTasksSortName":{ + "type":"string", + "enum":["StartTime"] + }, "Marketing":{ "type":"structure", "members":{ "AwsFundingUsed":{ "shape":"AwsFundingUsed", - "documentation":"

Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

" + "documentation":"

Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

" }, "CampaignName":{ "shape":"String", - "documentation":"

Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.

" + "documentation":"

Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.

" }, "Channels":{ "shape":"Channels", - "documentation":"

Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

" + "documentation":"

Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

" }, "Source":{ "shape":"MarketingSource", - "documentation":"

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.

" + "documentation":"

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.

" }, "UseCases":{ "shape":"UseCases", - "documentation":"

Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

" + "documentation":"

Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

" } }, - "documentation":"

An object that contains marketing details for the Opportunity.

" + "documentation":"

An object that contains marketing details for the Opportunity.

" }, "MarketingSource":{ "type":"string", @@ -2535,6 +4205,17 @@ "None" ] }, + "MemberCompanyName":{ + "type":"string", + "max":120, + "min":1 + }, + "MemberPageSize":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, "MonetaryValue":{ "type":"structure", "required":[ @@ -2588,6 +4269,10 @@ }, "documentation":"

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

" }, + "OpportunityArn":{ + "type":"string", + "pattern":"^arn:.*$" + }, "OpportunityEngagementInvitationSort":{ "type":"structure", "required":[ @@ -2614,6 +4299,12 @@ "type":"string", "pattern":"^O[0-9]{1,19}$" }, + "OpportunityIdentifiers":{ + "type":"list", + "member":{"shape":"OpportunityIdentifier"}, + "max":10, + "min":1 + }, "OpportunityInvitationPayload":{ "type":"structure", "required":[ @@ -2682,44 +4373,76 @@ "type":"structure", "required":["Catalog"], "members":{ + "Arn":{ + "shape":"OpportunityArn", + "documentation":"

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

" + }, "Catalog":{ "shape":"CatalogIdentifier", "documentation":"

Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

" }, "CreatedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the Opportunity was last created.

" + "documentation":"

DateTime when the Opportunity was last created.

" }, "Customer":{ "shape":"CustomerSummary", - "documentation":"

An object that contains the Opportunity's customer details.

" + "documentation":"

An object that contains the Opportunity's customer details.

" }, "Id":{ "shape":"OpportunityIdentifier", - "documentation":"

Read-only, system-generated Opportunity unique identifier.

" + "documentation":"

Read-only, system-generated Opportunity unique identifier.

" }, "LastModifiedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the Opportunity was last modified.

" + "documentation":"

DateTime when the Opportunity was last modified.

" }, "LifeCycle":{ "shape":"LifeCycleSummary", - "documentation":"

An object that contains the Opportunity's lifecycle details.

" + "documentation":"

An object that contains the Opportunity's lifecycle details.

" }, "OpportunityType":{ "shape":"OpportunityType", - "documentation":"

Specifies opportunity type as a renewal, new, or expansion.

Opportunity types:

" + "documentation":"

Specifies opportunity type as a renewal, new, or expansion.

Opportunity types:

" }, "PartnerOpportunityIdentifier":{ "shape":"String", - "documentation":"

Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

" + "documentation":"

Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

" }, "Project":{ "shape":"ProjectSummary", - "documentation":"

An object that contains the Opportunity's project details summary.

" + "documentation":"

An object that contains the Opportunity's project details summary.

" } }, - "documentation":"

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

" + "documentation":"

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

" + }, + "OpportunitySummaryView":{ + "type":"structure", + "members":{ + "Customer":{"shape":"Customer"}, + "Lifecycle":{ + "shape":"LifeCycleForView", + "documentation":"

Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.

" + }, + "OpportunityTeam":{ + "shape":"PartnerOpportunityTeamMembersList", + "documentation":"

Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.

" + }, + "OpportunityType":{ + "shape":"OpportunityType", + "documentation":"

Specifies the opportunity type.

" + }, + "PrimaryNeedsFromAws":{ + "shape":"PrimaryNeedsFromAws", + "documentation":"

Identifies the type of support the partner needs from AWS.

" + }, + "Project":{ + "shape":"ProjectView", + "documentation":"

Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.

" + }, + "RelatedEntityIdentifiers":{"shape":"RelatedEntityIdentifiers"} + }, + "documentation":"

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

" }, "OpportunityType":{ "type":"string", @@ -2737,7 +4460,10 @@ }, "ParticipantType":{ "type":"string", - "enum":["RECEIVER"] + "enum":[ + "SENDER", + "RECEIVER" + ] }, "PartnerOpportunityTeamMembersList":{ "type":"list", @@ -2807,27 +4533,27 @@ "members":{ "AdditionalComments":{ "shape":"ProjectAdditionalCommentsString", - "documentation":"

Captures additional comments or information for the Opportunity that weren't captured in other fields.

" + "documentation":"

Captures additional comments or information for the Opportunity that weren't captured in other fields.

" }, "ApnPrograms":{ "shape":"ApnPrograms", - "documentation":"

Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

" + "documentation":"

Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

" }, "CompetitorName":{ "shape":"CompetitorName", - "documentation":"

Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

" + "documentation":"

Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

" }, "CustomerBusinessProblem":{ "shape":"ProjectCustomerBusinessProblemString", - "documentation":"

Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

" + "documentation":"

Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

" }, "CustomerUseCase":{ "shape":"String", - "documentation":"

Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

" + "documentation":"

Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

" }, "DeliveryModels":{ "shape":"DeliveryModels", - "documentation":"

Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" + "documentation":"

Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" }, "ExpectedCustomerSpend":{ "shape":"ExpectedCustomerSpendList", @@ -2835,26 +4561,26 @@ }, "OtherCompetitorNames":{ "shape":"ProjectOtherCompetitorNamesString", - "documentation":"

Only allowed when CompetitorNames has Other selected.

" + "documentation":"

Only allowed when CompetitorNames has Other selected.

" }, "OtherSolutionDescription":{ "shape":"ProjectOtherSolutionDescriptionString", - "documentation":"

Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

" + "documentation":"

Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

" }, "RelatedOpportunityIdentifier":{ "shape":"OpportunityIdentifier", - "documentation":"

Specifies the current opportunity's parent opportunity identifier.

" + "documentation":"

Specifies the current opportunity's parent opportunity identifier.

" }, "SalesActivities":{ "shape":"SalesActivities", - "documentation":"

Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

Valid values:

" + "documentation":"

Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

Valid values:

" }, "Title":{ "shape":"ProjectTitleString", - "documentation":"

Specifies the Opportunity's title or name.

" + "documentation":"

Specifies the Opportunity's title or name.

" } }, - "documentation":"

An object that contains the Opportunity's project details.

" + "documentation":"

An object that contains the Opportunity's project details.

" }, "ProjectAdditionalCommentsString":{ "type":"string", @@ -2916,14 +4642,14 @@ "members":{ "DeliveryModels":{ "shape":"DeliveryModels", - "documentation":"

Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" + "documentation":"

Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" }, "ExpectedCustomerSpend":{ "shape":"ExpectedCustomerSpendList", "documentation":"

Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "ProjectTitleString":{ "type":"string", @@ -2931,20 +4657,88 @@ "min":0, "sensitive":true }, + "ProjectView":{ + "type":"structure", + "members":{ + "CustomerUseCase":{ + "shape":"String", + "documentation":"

Specifies the proposed solution focus or type of workload for the project.

" + }, + "DeliveryModels":{ + "shape":"DeliveryModels", + "documentation":"

Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.

" + }, + "ExpectedCustomerSpend":{ + "shape":"ExpectedCustomerSpendList", + "documentation":"

Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.

" + }, + "OtherSolutionDescription":{ + "shape":"ProjectViewOtherSolutionDescriptionString", + "documentation":"

Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.

" + }, + "SalesActivities":{ + "shape":"SalesActivities", + "documentation":"

Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.

" + } + }, + "documentation":"

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

" + }, + "ProjectViewOtherSolutionDescriptionString":{ + "type":"string", + "max":255, + "min":0, + "sensitive":true + }, + "PutSellingSystemSettingsRequest":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.

" + }, + "ResourceSnapshotJobRoleIdentifier":{ + "shape":"ResourceSnapshotJobRoleIdentifier", + "documentation":"

Specifies the ARN of the IAM Role used for resource snapshot job executions.

" + } + } + }, + "PutSellingSystemSettingsResponse":{ + "type":"structure", + "required":["Catalog"], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

" + }, + "ResourceSnapshotJobRoleArn":{ + "shape":"ResourceSnapshotJobRoleArn", + "documentation":"

Specifies the ARN of the IAM Role used for resource snapshot job executions.

" + } + } + }, "ReasonCode":{ "type":"string", "enum":[ "InvitationAccessDenied", + "InvitationValidationFailed", "EngagementAccessDenied", "OpportunityAccessDenied", "ResourceSnapshotJobAccessDenied", + "ResourceSnapshotJobValidationFailed", + "ResourceSnapshotJobConflict", "EngagementValidationFailed", + "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", - "InternalError", "OpportunityValidationFailed", "OpportunityConflict", - "ResourceSnapshotAccessDenied" + "ResourceSnapshotAccessDenied", + "ResourceSnapshotValidationFailed", + "ResourceSnapshotConflict", + "InternalError", + "ServiceQuotaExceeded", + "RequestThrottled" ] }, "Receiver":{ @@ -3006,18 +4800,18 @@ "members":{ "AwsMarketplaceOffers":{ "shape":"AwsMarketplaceOfferIdentifiers", - "documentation":"

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: \"offers\": [\"arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32\"].

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.

" + "documentation":"

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: \"offers\": [\"arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32\"].

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.

" }, "AwsProducts":{ "shape":"AwsProductIdentifiers", - "documentation":"

Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].

Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.

" + "documentation":"

Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].

Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.

" }, "Solutions":{ "shape":"SolutionIdentifiers", - "documentation":"

Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.

If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.

By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.

" + "documentation":"

Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.

If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.

By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "RelatedEntityType":{ "type":"string", @@ -3027,14 +4821,137 @@ "AwsMarketplaceOffers" ] }, + "ResourceArn":{ + "type":"string", + "pattern":"^arn:.*" + }, + "ResourceIdentifier":{ + "type":"string", + "pattern":"^O[0-9]{1,19}$" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, - "documentation":"

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

", + "documentation":"

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

", "exception":true }, + "ResourceSnapshotArn":{ + "type":"string", + "pattern":"^arn:.*" + }, + "ResourceSnapshotJobArn":{ + "type":"string", + "pattern":"^arn:.*" + }, + "ResourceSnapshotJobIdentifier":{ + "type":"string", + "pattern":"^job-[0-9a-z]{13}$" + }, + "ResourceSnapshotJobRoleArn":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^arn:aws:iam::\\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*[-+=,.@_a-zA-Z0-9]{1,64}$" + }, + "ResourceSnapshotJobRoleIdentifier":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"^(arn:aws:iam::\\d{12}:role/([-+=,.@_a-zA-Z0-9]+/)*)?[-+=,.@_a-zA-Z0-9]{1,64}$" + }, + "ResourceSnapshotJobStatus":{ + "type":"string", + "enum":[ + "Running", + "Stopped" + ] + }, + "ResourceSnapshotJobSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ResourceSnapshotJobArn", + "documentation":"

The Amazon Resource Name (ARN) for the resource snapshot job.

" + }, + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The unique identifier for the engagement within the AWS Partner Central system. This ID is used for direct references to the engagement within the service.

" + }, + "Id":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.

" + }, + "Status":{ + "shape":"ResourceSnapshotJobStatus", + "documentation":"

Represents the current status of the resource snapshot job.

" + } + }, + "documentation":"

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

" + }, + "ResourceSnapshotJobSummaryList":{ + "type":"list", + "member":{"shape":"ResourceSnapshotJobSummary"} + }, + "ResourceSnapshotPayload":{ + "type":"structure", + "members":{ + "OpportunitySummary":{ + "shape":"OpportunitySummaryView", + "documentation":"

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

" + } + }, + "documentation":"

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

", + "union":true + }, + "ResourceSnapshotRevision":{ + "type":"integer", + "box":true, + "min":1 + }, + "ResourceSnapshotSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"ResourceSnapshotArn", + "documentation":"

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.

" + }, + "CreatedBy":{ + "shape":"AwsAccount", + "documentation":"

The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.

" + }, + "ResourceId":{ + "shape":"ResourceIdentifier", + "documentation":"

The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.

" + }, + "ResourceSnapshotTemplateName":{ + "shape":"ResourceTemplateName", + "documentation":"

The name of the template used to create the snapshot.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource snapshotted.

" + }, + "Revision":{ + "shape":"ResourceSnapshotRevision", + "documentation":"

The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.

" + } + }, + "documentation":"

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

" + }, + "ResourceSnapshotSummaryList":{ + "type":"list", + "member":{"shape":"ResourceSnapshotSummary"} + }, + "ResourceTemplateName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9]{3,80}$" + }, + "ResourceType":{ + "type":"string", + "enum":["Opportunity"] + }, "RevenueModel":{ "type":"string", "enum":[ @@ -3084,26 +5001,26 @@ "members":{ "BusinessTitle":{ "shape":"JobTitle", - "documentation":"

The sender-provided contact's title (job title or role) associated with the EngagementInvitation.

" + "documentation":"

The sender-provided contact's title (job title or role) associated with the EngagementInvitation.

" }, "Email":{ "shape":"SenderContactEmail", - "documentation":"

The sender-provided contact's email address associated with the EngagementInvitation.

" + "documentation":"

The sender-provided contact's email address associated with the EngagementInvitation.

" }, "FirstName":{ "shape":"Name", - "documentation":"

The sender-provided contact's last name associated with the EngagementInvitation.

" + "documentation":"

The sender-provided contact's last name associated with the EngagementInvitation.

" }, "LastName":{ "shape":"Name", - "documentation":"

The sender-provided contact's first name associated with the EngagementInvitation.

" + "documentation":"

The sender-provided contact's first name associated with the EngagementInvitation.

" }, "Phone":{ "shape":"PhoneNumber", - "documentation":"

The sender-provided contact's phone number associated with the EngagementInvitation.

" + "documentation":"

The sender-provided contact's phone number associated with the EngagementInvitation.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "SenderContactEmail":{ "type":"string", @@ -3123,7 +5040,7 @@ "members":{ "Message":{"shape":"String"} }, - "documentation":"

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

", + "documentation":"

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

", "exception":true }, "SoftwareRevenue":{ @@ -3131,15 +5048,15 @@ "members":{ "DeliveryModel":{ "shape":"RevenueModel", - "documentation":"

Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

" + "documentation":"

Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

" }, "EffectiveDate":{ "shape":"Date", - "documentation":"

Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

" + "documentation":"

Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

" }, "ExpirationDate":{ "shape":"Date", - "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 period between both parties.

" + "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 period between both parties.

" }, "Value":{ "shape":"MonetaryValue", @@ -3148,6 +5065,10 @@ }, "documentation":"

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

" }, + "SolutionArn":{ + "type":"string", + "pattern":"^S-[0-9]{1,19}$" + }, "SolutionBase":{ "type":"structure", "required":[ @@ -3159,13 +5080,17 @@ "Status" ], "members":{ + "Arn":{ + "shape":"SolutionArn", + "documentation":"

The SolutionBase structure provides essential information about a solution.

" + }, "Catalog":{ "shape":"CatalogIdentifier", "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.

" }, "Category":{ "shape":"String", - "documentation":"

Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.

" + "documentation":"

Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.

" }, "CreatedDate":{ "shape":"DateTime", @@ -3181,7 +5106,7 @@ }, "Status":{ "shape":"SolutionStatus", - "documentation":"

Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.

" + "documentation":"

Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.

" } }, "documentation":"

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

" @@ -3207,14 +5132,14 @@ "members":{ "SortBy":{ "shape":"SolutionSortName", - "documentation":"

Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

" + "documentation":"

Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

" }, "SortOrder":{ "shape":"SortOrder", - "documentation":"

Specifies the sorting order, either Ascending or Descending. The default is Descending.

" + "documentation":"

Specifies the sorting order, either Ascending or Descending. The default is Descending.

" } }, - "documentation":"

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

" + "documentation":"

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

" }, "SolutionSortName":{ "type":"string", @@ -3234,6 +5159,24 @@ "Draft" ] }, + "SortBy":{ + "type":"string", + "enum":["CreatedDate"] + }, + "SortObject":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"SortBy", + "documentation":"

Specifies the field by which to sort the resource snapshot jobs.

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

Determines the order in which the sorted results are presented.

" + } + }, + "documentation":"

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

" + }, "SortOrder":{ "type":"string", "enum":[ @@ -3300,6 +5243,10 @@ "shape":"ReasonCode", "documentation":"

Indicates the reason for task failure using an enumerated code.

" }, + "ResourceSnapshotJobId":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The identifier of the resource snapshot job created as part of this task.

" + }, "StartTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

" @@ -3351,6 +5298,14 @@ "StartEngagementFromOpportunityTaskResponse":{ "type":"structure", "members":{ + "EngagementId":{ + "shape":"EngagementIdentifier", + "documentation":"

The identifier of the newly created engagement. Only populated if TaskStatus is COMPLETE.

" + }, + "EngagementInvitationId":{ + "shape":"EngagementInvitationIdentifier", + "documentation":"

The identifier of the new engagement invitation. Only populated if TaskStatus is COMPLETE.

" + }, "Message":{ "shape":"String", "documentation":"

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

" @@ -3363,6 +5318,10 @@ "shape":"ReasonCode", "documentation":"

Indicates the reason for task failure using an enumerated code.

" }, + "ResourceSnapshotJobId":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE.

" + }, "StartTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

" @@ -3381,15 +5340,85 @@ } } }, + "StartResourceSnapshotJobRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ResourceSnapshotJobIdentifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "ResourceSnapshotJobIdentifier":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The identifier of the resource snapshot job to start.

" + } + } + }, + "StopResourceSnapshotJobRequest":{ + "type":"structure", + "required":[ + "Catalog", + "ResourceSnapshotJobIdentifier" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "ResourceSnapshotJobIdentifier":{ + "shape":"ResourceSnapshotJobIdentifier", + "documentation":"

The identifier of the job to stop.

" + } + } + }, "String":{"type":"string"}, + "SubmitOpportunityRequest":{ + "type":"structure", + "required":[ + "Catalog", + "Identifier", + "InvolvementType" + ], + "members":{ + "Catalog":{ + "shape":"CatalogIdentifier", + "documentation":"

Specifies the catalog related to the request.

" + }, + "Identifier":{ + "shape":"OpportunityIdentifier", + "documentation":"

The identifier of the opportunity previously created by partner and needs to be submitted.

" + }, + "InvolvementType":{ + "shape":"SalesInvolvementType", + "documentation":"

Specifies the level of AWS sellers' involvement on the opportunity.

" + }, + "Visibility":{ + "shape":"Visibility", + "documentation":"

Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full.

" + } + } + }, "TaskArn":{ "type":"string", "pattern":"^arn:.*" }, + "TaskArnOrIdentifier":{ + "type":"string", + "pattern":"^(arn:.*|task-[0-9a-z]{13})$" + }, "TaskIdentifier":{ "type":"string", "pattern":"task-[0-9a-z]{13}$" }, + "TaskIdentifiers":{ + "type":"list", + "member":{"shape":"TaskArnOrIdentifier"}, + "max":10, + "min":1 + }, "TaskStatus":{ "type":"string", "enum":[ @@ -3398,12 +5427,18 @@ "FAILED" ] }, + "TaskStatuses":{ + "type":"list", + "member":{"shape":"TaskStatus"}, + "max":3, + "min":1 + }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, - "documentation":"

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

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

", + "documentation":"

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

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

", "exception":true }, "UpdateOpportunityRequest":{ @@ -3416,27 +5451,27 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

" + "documentation":"

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

" }, "Customer":{ "shape":"Customer", - "documentation":"

Specifies details of the customer associated with the Opportunity.

" + "documentation":"

Specifies details of the customer associated with the Opportunity.

" }, "Identifier":{ "shape":"OpportunityIdentifier", - "documentation":"

Read-only, system generated Opportunity unique identifier.

" + "documentation":"

Read-only, system generated Opportunity unique identifier.

" }, "LastModifiedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the opportunity was last modified.

" + "documentation":"

DateTime when the opportunity was last modified.

" }, "LifeCycle":{ "shape":"LifeCycle", - "documentation":"

An object that contains lifecycle details for the Opportunity.

" + "documentation":"

An object that contains lifecycle details for the Opportunity.

" }, "Marketing":{ "shape":"Marketing", - "documentation":"

An object that contains marketing details for the Opportunity.

" + "documentation":"

An object that contains marketing details for the Opportunity.

" }, "NationalSecurity":{ "shape":"NationalSecurity", @@ -3444,19 +5479,19 @@ }, "OpportunityType":{ "shape":"OpportunityType", - "documentation":"

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" + "documentation":"

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" }, "PartnerOpportunityIdentifier":{ "shape":"UpdateOpportunityRequestPartnerOpportunityIdentifierString", - "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" + "documentation":"

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" + "documentation":"

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" }, "Project":{ "shape":"Project", - "documentation":"

An object that contains project details summary for the Opportunity.

" + "documentation":"

An object that contains project details summary for the Opportunity.

" }, "SoftwareRevenue":{ "shape":"SoftwareRevenue", @@ -3478,11 +5513,11 @@ "members":{ "Id":{ "shape":"OpportunityIdentifier", - "documentation":"

Read-only, system generated Opportunity unique identifier.

" + "documentation":"

Read-only, system generated Opportunity unique identifier.

" }, "LastModifiedDate":{ "shape":"DateTime", - "documentation":"

DateTime when the opportunity was last modified.

" + "documentation":"

DateTime when the opportunity was last modified.

" } } }, @@ -3499,15 +5534,15 @@ "members":{ "ErrorList":{ "shape":"ValidationExceptionErrorList", - "documentation":"

A list of issues that were discovered in the submitted request or the resource state.

" + "documentation":"

A list of issues that were discovered in the submitted request or the resource state.

" }, "Message":{"shape":"String"}, "Reason":{ "shape":"ValidationExceptionReason", - "documentation":"

The primary reason for this validation exception to occur.

" + "documentation":"

The primary reason for this validation exception to occur.

" } }, - "documentation":"

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

", + "documentation":"

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

", "exception":true }, "ValidationExceptionError":{ @@ -3530,7 +5565,7 @@ "documentation":"

Specifies the detailed error message for the invalid field value.

" } }, - "documentation":"

Indicates an invalid value for a field.

" + "documentation":"

Indicates an invalid value for a field.

" }, "ValidationExceptionErrorCode":{ "type":"string", diff --git a/botocore/data/qbusiness/2023-11-27/service-2.json b/botocore/data/qbusiness/2023-11-27/service-2.json index cad3f65daf..da91069559 100644 --- a/botocore/data/qbusiness/2023-11-27/service-2.json +++ b/botocore/data/qbusiness/2023-11-27/service-2.json @@ -1102,7 +1102,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"

Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as user ID, user groups, content source, and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

" + "documentation":"

Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

" }, "StartDataSourceSyncJob":{ "name":"StartDataSourceSyncJob", @@ -7289,18 +7289,6 @@ "location":"uri", "locationName":"applicationId" }, - "userId":{ - "shape":"UserId", - "documentation":"

The ID of the user performing the search. Used for access control.

", - "location":"querystring", - "locationName":"userId" - }, - "userGroups":{ - "shape":"UserGroups", - "documentation":"

The groups the user belongs to. Used for access control.

", - "location":"querystring", - "locationName":"userGroups" - }, "queryText":{ "shape":"QueryText", "documentation":"

The text to search for.

"