Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartEngagementByAcceptingInvitationTask

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.

Request Syntax


{
   "Catalog": "string",
   "ClientToken": "string",
   "Identifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

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

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1.

Pattern: ^[!-~]{1,64}$

Required: Yes

Identifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(arn:.*|engi-[0-9a-z]{13})$

Required: Yes

Response Syntax


{
   "EngagementInvitationId": "string",
   "Message": "string",
   "OpportunityId": "string",
   "ReasonCode": "string",
   "ResourceSnapshotJobId": "string",
   "StartTime": "string",
   "TaskArn": "string",
   "TaskId": "string",
   "TaskStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EngagementInvitationId

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

Type: String

Pattern: ^engi-[0-9,a-z]{13}$

Message

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

Type: String

OpportunityId

Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.

Type: String

Pattern: ^O[0-9]{1,19}$

ReasonCode

Indicates the reason for task failure using an enumerated code.

Type: String

ResourceSnapshotJobId

The identifier of the Resource Snapshot Job created as part of this task.

Type: String

Pattern: ^job-[0-9a-z]{13}$

StartTime

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

Type: Timestamp

TaskArn

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

Type: String

Pattern: ^arn:.*

TaskId

The unique identifier of the task, used to track the task’s progress.

Type: String

Pattern: task-[0-9a-z]{13}$

TaskStatus

Indicates the current status of the task.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | FAILED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

ConflictException

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.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

HTTP Status Code: 400

InternalServerException

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

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.

HTTP Status Code: 500

ResourceNotFoundException

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

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.

HTTP Status Code: 400

ServiceQuotaExceededException

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.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

HTTP Status Code: 400

ThrottlingException

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400