PartnerCentralSellingAPI / Client / start_engagement_from_opportunity_task

start_engagement_from_opportunity_task

PartnerCentralSellingAPI.Client.start_engagement_from_opportunity_task(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_engagement_from_opportunity_task(
    AwsSubmission={
        'InvolvementType': 'For Visibility Only'|'Co-Sell',
        'Visibility': 'Full'|'Limited'
    },
    Catalog='string',
    ClientToken='string',
    Identifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• AwsSubmission (dict) –

  [REQUIRED]

  Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

  • InvolvementType (string) – [REQUIRED]

    Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.

  • Visibility (string) –

    Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

• ClientToken (string) –

  [REQUIRED]

  A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

  This field is autopopulated if not provided.

• Identifier (string) –

  [REQUIRED]

  The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

• Tags (list) –

  A list of objects specifying each tag name and value.

  • (dict) –

    The key-value pair assigned to a specified resource.

    • Key (string) – [REQUIRED]

      The key in the tag.

    • Value (string) – [REQUIRED]

      The value in the tag.

Return type:

dict

Returns:

Response Syntax

{
    'EngagementId': 'string',
    'EngagementInvitationId': 'string',
    'Message': 'string',
    'OpportunityId': 'string',
    'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled',
    'ResourceSnapshotJobId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'TaskArn': 'string',
    'TaskId': 'string',
    'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
}

Response Structure

• (dict) –

  • EngagementId (string) –

    The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.

  • EngagementInvitationId (string) –

    The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.

  • Message (string) –

    If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

  • OpportunityId (string) –

    Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

  • ReasonCode (string) –

    Indicates the reason for task failure using an enumerated code.

  • ResourceSnapshotJobId (string) –

    The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

  • StartTime (datetime) –

    The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

  • TaskArn (string) –

    The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

  • TaskId (string) –

    The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

  • TaskStatus (string) –

    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

Exceptions

• PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

• PartnerCentralSellingAPI.Client.exceptions.ConflictException

• PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

• PartnerCentralSellingAPI.Client.exceptions.InternalServerException

• PartnerCentralSellingAPI.Client.exceptions.ValidationException

• PartnerCentralSellingAPI.Client.exceptions.ServiceQuotaExceededException

• PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException