ListConnectionInvitations
Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
Request Syntax
{
"Catalog": "string",
"ConnectionType": "string",
"MaxResults": number,
"NextToken": "string",
"OtherParticipantIdentifiers": [ "string" ],
"ParticipantType": "string",
"Status": "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
-
The catalog identifier for the partner account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- ConnectionType
-
Filter results by connection type (e.g., reseller, distributor, technology partner).
Type: String
Valid Values:
OPPORTUNITY_COLLABORATION | SUBSIDIARYRequired: No
- MaxResults
-
The maximum number of connection invitations to return in a single response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token for retrieving the next page of results in paginated responses.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\S]+Required: No
- OtherParticipantIdentifiers
-
Filter results by specific participant identifiers.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+Required: No
- ParticipantType
-
Filter results by participant type (inviter or invitee).
Type: String
Valid Values:
SENDER | RECEIVERRequired: No
- Status
-
Filter results by invitation status (pending, accepted, rejected, canceled, expired).
Type: String
Valid Values:
PENDING | ACCEPTED | REJECTED | CANCELED | EXPIREDRequired: No
Response Syntax
{
"ConnectionInvitationSummaries": [
{
"Arn": "string",
"Catalog": "string",
"ConnectionId": "string",
"ConnectionType": "string",
"CreatedAt": "string",
"ExpiresAt": "string",
"Id": "string",
"OtherParticipantIdentifier": "string",
"ParticipantType": "string",
"Status": "string",
"UpdatedAt": "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.
- ConnectionInvitationSummaries
-
A list of connection invitation summaries matching the specified criteria.
Type: Array of ConnectionInvitationSummary objects
- NextToken
-
The token for retrieving the next page of results if more results are available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\S]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.
- Reason
-
The specific reason for the access denial.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.
HTTP Status Code: 500
- ThrottlingException
-
The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.
- QuotaCode
-
The quota code associated with the throttling error.
- ServiceCode
-
The service code associated with the throttling error.
HTTP Status Code: 400
- ValidationException
-
The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.
- ErrorDetails
-
A list of detailed validation errors that occurred during request processing.
- Reason
-
The reason for the validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
