PartnerCentralChannelAPI / Client / list_program_management_accounts

list_program_management_accounts

PartnerCentralChannelAPI.Client.list_program_management_accounts(**kwargs)

Lists program management accounts based on specified criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_program_management_accounts(
    catalog='string',
    maxResults=123,
    displayNames=[
        'string',
    ],
    programs=[
        'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
    ],
    accountIds=[
        'string',
    ],
    statuses=[
        'PENDING'|'ACTIVE'|'INACTIVE',
    ],
    sort={
        'sortOrder': 'Ascending'|'Descending',
        'sortBy': 'UpdatedAt'
    },
    nextToken='string'
)
Parameters:

  • catalog (string) –

    [REQUIRED]

    The catalog identifier to filter accounts.

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

  • displayNames (list) –

    Filter by display names.

    • (string) –

  • programs (list) –

    Filter by program types.

    • (string) –

  • accountIds (list) –

    Filter by AWS account IDs.

    • (string) –

  • statuses (list) –

    Filter by program management account statuses.

    • (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': [
        {
            'id': 'string',
            'revision': 'string',
            'catalog': 'string',
            'program': 'SOLUTION_PROVIDER'|'DISTRIBUTION'|'DISTRIBUTION_SELLER',
            'displayName': 'string',
            'accountId': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'startDate': datetime(2015, 1, 1),
            'status': 'PENDING'|'ACTIVE'|'INACTIVE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      List of program management accounts matching the criteria.

      • (dict) –

        Summary information about a program management account.

        • id (string) –

          The unique identifier of the program management account.

        • revision (string) –

          The current revision number of the program management account.

        • catalog (string) –

          The catalog identifier associated with the account.

        • program (string) –

          The program type for the management account.

        • displayName (string) –

          The display name of the program management account.

        • accountId (string) –

          The AWS account ID associated with the program management account.

        • arn (string) –

          The Amazon Resource Name (ARN) of the program management account.

        • createdAt (datetime) –

          The timestamp when the account was created.

        • updatedAt (datetime) –

          The timestamp when the account was last updated.

        • startDate (datetime) –

          The start date of the program management account.

        • status (string) –

          The current status of the program management account.

    • nextToken (string) –

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

Exceptions