Partner Central Selling API

{'ReasonCode': {'ResourceSnapshotAccessDenied'}}

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

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

type Catalog:

string

param Catalog:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

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

type Identifier:

string

param Identifier:

[REQUIRED]

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

rtype:

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.

{'ReasonCode': {'ResourceSnapshotAccessDenied'}}

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

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

type AwsSubmission:

dict

param AwsSubmission:

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

type Catalog:

string

param Catalog:

[REQUIRED]

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

type ClientToken:

string

param ClientToken:

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

type Identifier:

string

param Identifier:

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

rtype:

dict

returns:

Response Syntax

{
    '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) --

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

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