Skip to content

list_program_management_accounts

list_program_management_accounts(
    catalog: Catalog,
    *,
    config_overrides: Optional[PartnerCentralChannelClientConfig] = None,
    max_results: Optional[int] = None,
    display_names: Optional[ProgramManagementAccountDisplayNameList] = None,
    programs: Optional[ProgramList] = None,
    account_ids: Optional[AccountIdList] = None,
    statuses: Optional[ProgramManagementAccountStatusList] = None,
    sort: Optional[ListProgramManagementAccountsSortBase] = None,
    next_token: Optional[NextToken] = None,
) -> ListProgramManagementAccountsResponse

Lists program management accounts based on specified criteria.

Parameters:

Raises:

Examples:

Example for ListProgramManagementAccounts

>>> client.list_program_management_accounts(catalog='AWS', max_results=20, programs=['SOLUTION_PROVIDER'], display_names=['TestDisplayName'], account_ids=['111122223333'], statuses=['PENDING'], sort={'sortBy': 'UpdatedAt', 'sortOrder': 'Descending'})
Source code in docs_src/capo_partnercentral_channel/_services/partner_central_channel.py
def list_program_management_accounts(
    self,
    catalog: "capo_partnercentral_channel.types.catalog.Catalog",
    *,
    config_overrides: Optional[PartnerCentralChannelClientConfig] = None,
    max_results: Optional[int] = None,
    display_names: Optional[
        "capo_partnercentral_channel.types.program_management_account_display_name_list.ProgramManagementAccountDisplayNameList"
    ] = None,
    programs: Optional[
        "capo_partnercentral_channel.types.program_list.ProgramList"
    ] = None,
    account_ids: Optional[
        "capo_partnercentral_channel.types.account_id_list.AccountIdList"
    ] = None,
    statuses: Optional[
        "capo_partnercentral_channel.types.program_management_account_status_list.ProgramManagementAccountStatusList"
    ] = None,
    sort: Optional[
        "capo_partnercentral_channel.types.list_program_management_accounts_sort_base.ListProgramManagementAccountsSortBase"
    ] = None,
    next_token: Optional[
        "capo_partnercentral_channel.types.next_token.NextToken"
    ] = None,
) -> "capo_partnercentral_channel.types.list_program_management_accounts_response.ListProgramManagementAccountsResponse":
    """<p>Lists program management accounts based on specified criteria.</p>

    Args:
        catalog: <p>The catalog identifier to filter accounts.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        display_names: <p>Filter by display names.</p>
        programs: <p>Filter by program types.</p>
        account_ids: <p>Filter by AWS account IDs.</p>
        statuses: <p>Filter by program management account statuses.</p>
        sort: <p>Sorting options for the results.</p>
        next_token: <p>Token for retrieving the next page of results.</p>

    Raises:
        capo_partnercentral_channel.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions.</p>
        capo_partnercentral_channel.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request.</p>
        capo_partnercentral_channel.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_partnercentral_channel.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period.</p>
        capo_partnercentral_channel.errors.validation_exception.ValidationException: <p>The request failed validation due to invalid input parameters.</p>
        capo_partnercentral_channel.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example for ListProgramManagementAccounts

        >>> client.list_program_management_accounts(catalog='AWS', max_results=20, programs=['SOLUTION_PROVIDER'], display_names=['TestDisplayName'], account_ids=['111122223333'], statuses=['PENDING'], sort={'sortBy': 'UpdatedAt', 'sortOrder': 'Descending'})
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_channel.types.list_program_management_accounts_request.ListProgramManagementAccountsRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_channel.types.list_program_management_accounts_response.ListProgramManagementAccountsResponse"
    ]:
        import capo_partnercentral_channel._operations.partner_central_channel.list_program_management_accounts

        output, http_response = (
            capo_partnercentral_channel._operations.partner_central_channel.list_program_management_accounts.list_program_management_accounts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProgramManagementAccounts")
    )
    input_: capo_partnercentral_channel.types.list_program_management_accounts_request.ListProgramManagementAccountsRequest = {
        "catalog": catalog
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if display_names is not None:
        input_["display_names"] = display_names
    if programs is not None:
        input_["programs"] = programs
    if account_ids is not None:
        input_["account_ids"] = account_ids
    if statuses is not None:
        input_["statuses"] = statuses
    if sort is not None:
        input_["sort"] = sort
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output