PartnerCentralChannelAPI / Client / list_relationships

list_relationships

PartnerCentralChannelAPI.Client.list_relationships(**kwargs)

Lists partner relationships based on specified criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_relationships(
    catalog='string',
    maxResults=123,
    associatedAccountIds=[
        'string',
    ],
    associationTypes=[
        'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
    ],
    displayNames=[
        'string',
    ],
    programManagementAccountIdentifiers=[
        'string',
    ],
    sort={
        'sortOrder': 'Ascending'|'Descending',
        'sortBy': 'UpdatedAt'
    },
    nextToken='string'
)
Parameters:

  • catalog (string) –

    [REQUIRED]

    The catalog identifier to filter relationships.

  • maxResults (integer) – The maximum number of results to return in a single call.

  • associatedAccountIds (list) –

    Filter by associated AWS account IDs.

    • (string) –

  • associationTypes (list) –

    Filter by association types.

    • (string) –

  • displayNames (list) –

    Filter by display names.

    • (string) –

  • programManagementAccountIdentifiers (list) –

    Filter by program management account identifiers.

    • (string) –

  • sort (dict) –

    Sorting options for the results.

    • sortOrder (string) – [REQUIRED]

      The sort order (ascending or descending).

    • sortBy (string) – [REQUIRED]

      The field to sort by.

  • nextToken (string) – Token for retrieving the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'revision': 'string',
            'catalog': 'string',
            'associationType': 'DOWNSTREAM_SELLER'|'END_CUSTOMER'|'INTERNAL',
            'programManagementAccountId': 'string',
            'associatedAccountId': 'string',
            'displayName': 'string',
            'sector': 'COMMERCIAL'|'GOVERNMENT'|'GOVERNMENT_EXCEPTION',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      List of relationships matching the criteria.

      • (dict) –

        Summary information about a partner relationship.

        • arn (string) –

          The Amazon Resource Name (ARN) of the relationship.

        • id (string) –

          The unique identifier of the relationship.

        • revision (string) –

          The current revision number of the relationship.

        • catalog (string) –

          The catalog identifier associated with the relationship.

        • associationType (string) –

          The type of association for the relationship.

        • programManagementAccountId (string) –

          The identifier of the program management account.

        • associatedAccountId (string) –

          The AWS account ID associated in this relationship.

        • displayName (string) –

          The display name of the relationship.

        • sector (string) –

          The business sector for the relationship.

        • createdAt (datetime) –

          The timestamp when the relationship was created.

        • updatedAt (datetime) –

          The timestamp when the relationship was last updated.

        • startDate (datetime) –

          The start date of the relationship.

    • nextToken (string) –

      Token for retrieving the next page of results, if available.

Exceptions