StartOpportunityFromEngagementTask

Specifies the catalog in which the opportunity creation task is executed. Acceptable values include AWS for production and Sandbox for testing environments.

Type: String

Pattern: [a-zA-Z]+

Required: Yes

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.

Type: String

Pattern: .{1,255}

Required: Yes

The unique identifier of the engagement context from which to create the opportunity. This specifies the specific contextual information within the engagement that will be used for opportunity creation.

Type: String

Pattern: [1-9][0-9]*

Required: Yes

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

Type: String

Pattern: (arn:.*|eng-[0-9a-z]{14})

Required: Yes

A map of the key-value pairs of the tag or tags to assign.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

The unique identifier of the engagement context used to create the opportunity.

Type: String

Pattern: [1-9][0-9]*

The unique identifier of the engagement from which the opportunity was created.

Type: String

Pattern: eng-[0-9a-z]{14}

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

Type: String

The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.

Type: String

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

Indicates the reason for task failure using an enumerated code.

Type: String

Valid Values: InvitationAccessDenied | InvitationValidationFailed | EngagementAccessDenied | OpportunityAccessDenied | ResourceSnapshotJobAccessDenied | ResourceSnapshotJobValidationFailed | ResourceSnapshotJobConflict | EngagementValidationFailed | EngagementConflict | OpportunitySubmissionFailed | EngagementInvitationConflict | InternalError | OpportunityValidationFailed | OpportunityConflict | ResourceSnapshotAccessDenied | ResourceSnapshotValidationFailed | ResourceSnapshotConflict | ServiceQuotaExceeded | RequestThrottled | ContextNotFound | CustomerProjectContextNotPermitted | DisqualifiedLeadNotPermitted

The identifier of the resource snapshot job created as part of the opportunity creation process.

Type: String

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

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

Type: Timestamp

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

Type: String

Pattern: arn:.*

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

Type: String

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

Indicates the current status of the task.

Type: String

Valid Values: IN_PROGRESS | COMPLETE | FAILED

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

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

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

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

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

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

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