Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetConnectionPreferences

Retrieves the connection preferences for a partner account, including access settings and exclusions.

Request Syntax


{
   "Catalog": "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

Response Syntax


{
   "AccessType": "string",
   "Arn": "string",
   "Catalog": "string",
   "ExcludedParticipantIds": [ "string" ],
   "Revision": number,
   "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.

AccessType

The access type setting for connections (e.g., open, restricted, invitation-only).

Type: String

Valid Values: ALLOW_ALL | DENY_ALL | ALLOW_BY_DEFAULT_DENY_SOME

Arn

The Amazon Resource Name (ARN) of the connection preferences.

Type: String

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

Pattern: arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9\-]*:[0-9]{12}:catalog/[a-zA-Z]+/connection-preferences

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-]+

Revision

The revision number of the connection preferences for optimistic locking.

Type: Long

UpdatedAt

The timestamp when the connection preferences were last updated.

Type: Timestamp

ExcludedParticipantIds

A list of participant IDs that are excluded from connection requests or interactions.

Type: Array of strings

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

Pattern: [a-zA-Z0-9-]+

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