update_engagement_context async ¶

async def update_engagement_context(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    engagement_identifier: "capo_partnercentral_selling.types.engagement_arn_or_identifier.EngagementArnOrIdentifier",
    context_identifier: "capo_partnercentral_selling.types.engagement_context_identifier.EngagementContextIdentifier",
    engagement_last_modified_at: "capo_partnercentral_selling.types.date_time.DateTime",
    type: "capo_partnercentral_selling.types.engagement_context_type.EngagementContextType",
    payload: "capo_partnercentral_selling.types.update_engagement_context_payload.UpdateEngagementContextPayload",
    *,
    config_overrides: Optional[AsyncPartnerCentralSellingClientConfig] = None,
) -> "capo_partnercentral_selling.types.update_engagement_context_response.UpdateEngagementContextResponse":
    """<p>Updates the context information for an existing engagement with new or modified data.</p>

    Args:
        catalog: <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: <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: <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: <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: <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: <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>

    Raises:
        capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
        capo_partnercentral_selling.errors.conflict_exception.ConflictException: <p>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.</p> <p>Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.</p>
        capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>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.</p>
        capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>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.</p>
        capo_partnercentral_selling.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>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.</p> <p>Suggested action: Review the <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> for the resource, and either reduce usage or request a quota increase.</p>
        capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
        capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
        capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_partnercentral_selling.types.update_engagement_context_request.UpdateEngagementContextRequest]",
    ) -> AsyncOperationResponse[
        "capo_partnercentral_selling.types.update_engagement_context_response.UpdateEngagementContextResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.update_engagement_context

        (
            output,
            http_response,
        ) = await capo_partnercentral_selling._operations.aws_partner_central_selling.update_engagement_context.async_update_engagement_context(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_partnercentral_selling.types.update_engagement_context_request.UpdateEngagementContextRequest",
    ) -> dict[str, Any]:
        import capo_partnercentral_selling.types.update_engagement_context_request

        return capo_partnercentral_selling.types.update_engagement_context_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateEngagementContext", redact_input=_redact_input),
    )
    input_: capo_partnercentral_selling.types.update_engagement_context_request.UpdateEngagementContextRequest = {
        "catalog": catalog,
        "engagement_identifier": engagement_identifier,
        "context_identifier": context_identifier,
        "engagement_last_modified_at": engagement_last_modified_at,
        "type": type,
        "payload": payload,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output