GetConnectionInvitation
Retrieves detailed information about a specific connection invitation.
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
-
The catalog identifier where the connection invitation exists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- Identifier
-
The unique identifier of the connection invitation to retrieve.
Type: String
Pattern:
pacinv-[A-Za-z0-9]{13}Required: Yes
Response Syntax
{
"Arn": "string",
"Catalog": "string",
"ConnectionId": "string",
"ConnectionType": "string",
"CreatedAt": "string",
"ExpiresAt": "string",
"Id": "string",
"InvitationMessage": "string",
"InviterEmail": "string",
"InviterName": "string",
"OtherParticipantIdentifier": "string",
"ParticipantType": "string",
"Status": "string",
"UpdatedAt": "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.
- Arn
-
The Amazon Resource Name (ARN) of the connection invitation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13} - Catalog
-
The catalog identifier where the connection invitation exists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]+ - ConnectionType
-
The type of connection being requested in the invitation.
Type: String
Valid Values:
OPPORTUNITY_COLLABORATION | SUBSIDIARY - CreatedAt
-
The timestamp when the connection invitation was created.
Type: Timestamp
- Id
-
The unique identifier of the connection invitation.
Type: String
Pattern:
pacinv-[A-Za-z0-9]{13} - InvitationMessage
-
The custom message included with the connection invitation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+ - InviterEmail
-
The email address of the person who sent the connection invitation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 320.
Pattern:
[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)* - InviterName
-
The name of the person who sent the connection invitation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
Pattern:
[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+ - OtherParticipantIdentifier
-
The identifier of the other participant in the connection invitation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+ - ParticipantType
-
The type of participant (inviter or invitee) in the connection invitation.
Type: String
Valid Values:
SENDER | RECEIVER - Status
-
The current status of the connection invitation.
Type: String
Valid Values:
PENDING | ACCEPTED | REJECTED | CANCELED | EXPIRED - UpdatedAt
-
The timestamp when the connection invitation was last updated.
Type: Timestamp
- ConnectionId
-
The identifier of the connection associated with this invitation.
Type: String
Pattern:
pac-[A-Za-z0-9]{13} - ExpiresAt
-
The timestamp when the connection invitation will expire.
Type: Timestamp
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
- ResourceNotFoundException
-
The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.
- Reason
-
The specific reason why the resource was not found.
HTTP Status Code: 400
- 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:
