Skip to content

update_limits_profile

update_limits_profile(
    profile_id: ProfileId,
    account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    profile_name: Optional[ProfileName] = None,
    description: Optional[ProfileDescription] = None,
    resource_limits: Optional[ResourceLimitsMap] = None,
) -> UpdateLimitsProfileResponse

Updates the properties of an existing limits profile.

Parameters:

  • profile_id (ProfileId) –

    The unique identifier for the limits profile to update.

  • account_id (AwsAccountId) –

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

  • profile_name (Optional[ProfileName], default: None ) –

    A new display name for the limits profile.

  • description (Optional[ProfileDescription], default: None ) –

    A new description for the limits profile.

  • resource_limits (Optional[ResourceLimitsMap], default: None ) –

    A map of resource types to their updated limit values.

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.

  • ConflictException –

    Updating or deleting a resource can cause an inconsistent state.

  • InternalFailureException –

    An internal failure occurred.

  • InvalidParameterValueException –

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

  • ResourceNotFoundException –

    One or more resources can't be found.

  • 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 update_limits_profile(
    self,
    profile_id: "capo_quicksight.types.profile_id.ProfileId",
    account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    profile_name: Optional["capo_quicksight.types.profile_name.ProfileName"] = None,
    description: Optional[
        "capo_quicksight.types.profile_description.ProfileDescription"
    ] = None,
    resource_limits: Optional[
        "capo_quicksight.types.resource_limits_map.ResourceLimitsMap"
    ] = None,
) -> "capo_quicksight.types.update_limits_profile_response.UpdateLimitsProfileResponse":
    """<p>Updates the properties of an existing limits profile.</p>

    Args:
        profile_id: <p>The unique identifier for the limits profile to update.</p>
        account_id: <p>The ID of the Amazon Web Services account that contains the limits profile.</p>
        profile_name: <p>A new display name for the limits profile.</p>
        description: <p>A new description for the limits profile.</p>
        resource_limits: <p>A map of resource types to their updated limit values.</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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</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.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</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.update_limits_profile_request.UpdateLimitsProfileRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.update_limits_profile_response.UpdateLimitsProfileResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_limits_profile

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateLimitsProfile")
    )
    input_: capo_quicksight.types.update_limits_profile_request.UpdateLimitsProfileRequest = {
        "profile_id": profile_id,
        "account_id": account_id,
    }
    if profile_name is not None:
        input_["profile_name"] = profile_name
    if description is not None:
        input_["description"] = description
    if resource_limits is not None:
        input_["resource_limits"] = resource_limits

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