PartnerCentralAccountAPI / Client / get_connection_preferences

get_connection_preferences¶

PartnerCentralAccountAPI.Client.get_connection_preferences(**kwargs)¶

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

Request Syntax

response = client.get_connection_preferences(
    Catalog='string'
)

Parameters:

Catalog (string) –

[REQUIRED]

The catalog identifier for the partner account.

Return type:

dict

Returns:

Response Syntax

{
    'Catalog': 'string',
    'Arn': 'string',
    'AccessType': 'ALLOW_ALL'|'DENY_ALL'|'ALLOW_BY_DEFAULT_DENY_SOME',
    'ExcludedParticipantIds': [
        'string',
    ],
    'UpdatedAt': datetime(2015, 1, 1),
    'Revision': 123
}

Response Structure

(dict) –
- Catalog (string) –
  
  The catalog identifier for the partner account.
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the connection preferences.
- AccessType (string) –
  
  The access type setting for connections (e.g., open, restricted, invitation-only).
- ExcludedParticipantIds (list) –
  
  A list of participant IDs that are excluded from connection requests or interactions.
  - (string) –
- UpdatedAt (datetime) –
  
  The timestamp when the connection preferences were last updated.
- Revision (integer) –
  
  The revision number of the connection preferences for optimistic locking.

Exceptions

PartnerCentralAccountAPI.Client.exceptions.AccessDeniedException
PartnerCentralAccountAPI.Client.exceptions.ThrottlingException
PartnerCentralAccountAPI.Client.exceptions.ValidationException
PartnerCentralAccountAPI.Client.exceptions.InternalServerException