Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetEngagementInvitation

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

Request Syntax


{
   "Catalog": "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 associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

Type: String

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

Required: Yes

Identifier

Specifies the unique identifier for the retrieved engagement invitation.

Type: String

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

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

Required: Yes

Response Syntax


{
   "Arn": "string",
   "Catalog": "string",
   "EngagementTitle": "string",
   "ExpirationDate": "string",
   "Id": "string",
   "InvitationDate": "string",
   "Payload": { ... },
   "PayloadType": "string",
   "Receiver": { ... },
   "RejectionReason": "string",
   "SenderAwsAccountId": "string",
   "SenderCompanyName": "string",
   "Status": "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.

Catalog

Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

Type: String

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

Id

Unique identifier assigned to the engagement invitation being retrieved.

Type: String

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

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

Arn

The Amazon Resource Name (ARN) that identifies the engagement invitation.

Type: String

EngagementTitle

The title of the engagement invitation, summarizing the purpose or key objectives of the opportunity shared by AWS.

Type: String

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

ExpirationDate

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

Type: Timestamp

InvitationDate

The date when the engagement invitation was sent to the partner.

Type: Timestamp

Payload

Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

Type: Payload object

Note: This object is a Union. Only one member of this object can be specified or returned.

PayloadType

The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

Type: String

Valid Values: OpportunityInvitation

Receiver

Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

Type: Receiver object

Note: This object is a Union. Only one member of this object can be specified or returned.

RejectionReason

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

Type: String

Pattern: ^[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]{1,80}$

SenderAwsAccountId

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

Type: String

Pattern: ^(aws|[0-9]{12})$

SenderCompanyName

The name of the AWS organization or team that sent the engagement invitation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 120.

Status

The current status of the engagement invitation.

Type: String

Valid Values: ACCEPTED | PENDING | REJECTED | EXPIRED

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

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

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