v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

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

post/#X-Amz-Target=AWSPartnerCentralSelling.CreateEngagementContext

Headers

X-Amz-Target'AWSPartnerCentralSelling.CreateEngagementContext' required

Request body

Catalogstring required

Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: <code>AWS</code> or <code>Sandbox</code>. The catalog determines which environment the engagement context is created in. Use <code>AWS</code> to create contexts in the production environment, and <code>Sandbox</code> for testing in secure, isolated environments.

EngagementIdentifierstring required

The unique identifier of the <code>Engagement</code> for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.

ClientTokenstring required

A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.

Type'CustomerProject' | 'Lead' | 'ProspectingResult' required

Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include <code>CustomerProject</code> for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.

Response

Success

EngagementIdstring

The unique identifier of the engagement to which the context was added. This ID confirms the successful association of the context with the specified engagement.

EngagementArnstring

The Amazon Resource Name (ARN) of the engagement to which the context was added. This globally unique identifier can be used for cross-service references and IAM policies.

EngagementLastModifiedAtstring date-time

The timestamp indicating when the engagement was last modified as a result of adding the context, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".

ContextIdstring

The unique identifier assigned to the newly created engagement context. This ID can be used to reference the specific context within the engagement for future operations.