Skip to content

UpdateEngagementContextRequest

Source code in docs_src/capo_partnercentral_selling/types/update_engagement_context_request.py
class UpdateEngagementContextRequest(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>Specifies the catalog associated with the engagement context update 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 updated in.</p>"""
    engagement_identifier: "capo_partnercentral_selling.types.engagement_arn_or_identifier.EngagementArnOrIdentifier"
    """<p>The unique identifier of the <code>Engagement</code> containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.</p>"""
    context_identifier: "capo_partnercentral_selling.types.engagement_context_identifier.EngagementContextIdentifier"
    """<p>The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.</p>"""
    engagement_last_modified_at: "capo_partnercentral_selling.types.date_time.DateTime"
    """<p>The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.</p>"""
    type: "capo_partnercentral_selling.types.engagement_context_type.EngagementContextType"
    """<p>Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.</p>"""
    payload: "capo_partnercentral_selling.types.update_engagement_context_payload.UpdateEngagementContextPayload"
    """<p>Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.</p>"""

catalog instance-attribute

Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.

context_identifier instance-attribute

context_identifier: EngagementContextIdentifier

The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.

engagement_identifier instance-attribute

engagement_identifier: EngagementArnOrIdentifier

The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.

engagement_last_modified_at instance-attribute

engagement_last_modified_at: DateTime

The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.

payload instance-attribute

Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.

type instance-attribute

Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.