Skip to content

list_services

list_services(
    *,
    config_overrides: Optional[uxcClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListServicesOutput

Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations. The available services vary by Amazon Web Services partition. Use pagination to retrieve all results.

The visibleServices setting controls only the appearance of services in the Amazon Web Services Management Console. It does not restrict access through the CLI, SDKs, or other APIs.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    The token for retrieving the next page of results. Use the nextToken value from a previous response.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return per page.

Raises:

Examples:

List available services Retrieves a paginated list of available AWS services

>>> client.list_services()
Source code in docs_src/capo_uxc/_services/uxc.py
def list_services(
    self,
    *,
    config_overrides: Optional[uxcClientConfig] = None,
    next_token: Optional["capo_uxc.types.next_token.NextToken"] = None,
    max_results: Optional["capo_uxc.types.max_results.MaxResults"] = None,
) -> "capo_uxc.types.list_services_output.ListServicesOutput":
    """<p>Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the <code>visibleServices</code> setting in <a href="https://docs.aws.amazon.com/awsconsolehelpdocs/latest/APIReference/API_UpdateAccountCustomizations.html">UpdateAccountCustomizations</a>. The available services vary by Amazon Web Services partition. Use pagination to retrieve all results.</p> <note> <p>The <code>visibleServices</code> setting controls only the appearance of services in the Amazon Web Services Management Console. It does not restrict access through the CLI, SDKs, or other APIs.</p> </note>

    Args:
        next_token: <p>The token for retrieving the next page of results. Use the <code>nextToken</code> value from a previous response.</p>
        max_results: <p>The maximum number of results to return per page.</p>

    Raises:
        capo_uxc.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation. Verify that your IAM policy includes the required <code>uxc:</code> permissions for the operation that you are calling. For more information on IAM permissions, see <a href="https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/security-iam-awsmanpol.html">Amazon Web Services managed policies for Amazon Web Services Management Console</a>.</p>
        capo_uxc.errors.internal_server_exception.InternalServerException: <p>The service encountered an internal error. Try your request again later.</p>
        capo_uxc.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Reduce the frequency of your requests.</p>
        capo_uxc.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_uxc.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List available services
        Retrieves a paginated list of available AWS services

        >>> client.list_services()
    """

    def _handler(
        req: "OperationRequest[capo_uxc.types.list_services_input.ListServicesInput]",
    ) -> OperationResponse[
        "capo_uxc.types.list_services_output.ListServicesOutput"
    ]:
        import capo_uxc._operations.aws_account_ux_setting.list_services

        output, http_response = (
            capo_uxc._operations.aws_account_ux_setting.list_services.list_services(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListServices")
    )
    input_: capo_uxc.types.list_services_input.ListServicesInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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