Skip to content

list_limits_profiles

list_limits_profiles(
    account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    resource_type: Optional[ResourceType] = None,
    max_results: Optional[ListLimitsProfilesRequestMaxResultsInteger] = None,
    next_token: Optional[str] = None,
) -> ListLimitsProfilesResponse

Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page of results.

Parameters:

  • account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the limits profiles.

  • resource_type (Optional[ResourceType], default: None ) –

    An optional filter that limits the results to profiles that contain the specified resource type. If you don't specify a value, the operation returns all profiles.

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

    The maximum number of results to return in a single call. If you don't specify a value, the service uses the default maximum.

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

    The token for the next set of results, or null if there are no more results.

Raises:

  • AccessDeniedException –

    You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

  • InternalFailureException –

    An internal failure occurred.

  • InvalidParameterValueException –

    One or more parameters has a value that isn't valid.

  • ThrottlingException –

    Access is throttled.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def list_limits_profiles(
    self,
    account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    resource_type: Optional[
        "capo_quicksight.types.resource_type.ResourceType"
    ] = None,
    max_results: Optional[
        "capo_quicksight.types.list_limits_profiles_request_max_results_integer.ListLimitsProfilesRequestMaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> (
    "capo_quicksight.types.list_limits_profiles_response.ListLimitsProfilesResponse"
):
    """<p>Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the <code>maxResults</code> parameter to limit the number of results returned in a single call, and use the <code>nextToken</code> parameter to retrieve the next page of results.</p>

    Args:
        account_id: <p>The ID of the Amazon Web Services account that contains the limits profiles.</p>
        resource_type: <p>An optional filter that limits the results to profiles that contain the specified resource type. If you don't specify a value, the operation returns all profiles.</p>
        max_results: <p>The maximum number of results to return in a single call. If you don't specify a value, the service uses the default maximum.</p>
        next_token: <p>The token for the next set of results, or null if there are no more results.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.list_limits_profiles_request.ListLimitsProfilesRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_limits_profiles_response.ListLimitsProfilesResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_limits_profiles

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.list_limits_profiles.list_limits_profiles(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLimitsProfiles")
    )
    input_: capo_quicksight.types.list_limits_profiles_request.ListLimitsProfilesRequest = {
        "account_id": account_id
    }
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if max_results is not None:
        input_["max_results"] = max_results
    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