PartnerCentralSellingAPI / Client / start_engagement_by_accepting_invitation_task

start_engagement_by_accepting_invitation_task#

PartnerCentralSellingAPI.Client.start_engagement_by_accepting_invitation_task(**kwargs)#

This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner’s account.

See also: AWS API Documentation

Request Syntax

response = client.start_engagement_by_accepting_invitation_task(
    Catalog='string',
    ClientToken='string',
    Identifier='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

  • ClientToken (string) –

    [REQUIRED]

    A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

    This field is autopopulated if not provided.

  • Identifier (string) –

    [REQUIRED]

    Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

Return type:

dict

Returns:

Response Syntax

{
    'EngagementInvitationId': 'string',
    'Message': 'string',
    'OpportunityId': 'string',
    'ReasonCode': 'InvitationAccessDenied'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'EngagementValidationFailed'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied',
    'StartTime': datetime(2015, 1, 1),
    'TaskArn': 'string',
    'TaskId': 'string',
    'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
}

Response Structure

  • (dict) –

    • EngagementInvitationId (string) –

      Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.

    • 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. This is the unique identifier for the opportunity.

    • ReasonCode (string) –

      Indicates the reason for task failure using an enumerated code.

    • 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.

    • TaskStatus (string) –

      Indicates the current status of the task.

Exceptions