Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListEngagementInvitations

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

Request Syntax


{
   "Catalog": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ParticipantType": "string",
   "PayloadType": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "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 from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

Type: String

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

Required: Yes

ParticipantType

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

Type: String

Valid Values: RECEIVER

Required: Yes

MaxResults

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

Type: String

Required: No

PayloadType

Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

Type: Array of strings

Valid Values: OpportunityInvitation

Required: No

Sort

Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

Type: OpportunityEngagementInvitationSort object

Required: No

Response Syntax


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

EngagementInvitationSummaries

An array containing summaries of engagement invitations. Each summary includes key information such as the invitation title, invitation date, and the current status of the invitation.

Type: Array of EngagementInvitationSummary objects

NextToken

A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

Type: String

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