update_folder ¶

update_folder(
    aws_account_id: AwsAccountId,
    folder_id: RestrictiveResourceId,
    name: FolderName,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> UpdateFolderResponse

Updates the name of a folder.

Parameters:

aws_account_id (AwsAccountId) –

The ID for the Amazon Web Services account that contains the folder to update.
folder_id (RestrictiveResourceId) –

The ID of the folder.
name (FolderName) –

The name of the folder.

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.
ResourceExistsException –

The resource specified already exists.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnsupportedUserEditionException –

This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
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_folder(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    folder_id: "capo_quicksight.types.restrictive_resource_id.RestrictiveResourceId",
    name: "capo_quicksight.types.folder_name.FolderName",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.update_folder_response.UpdateFolderResponse":
    """<p>Updates the name of a folder.</p>

    Args:
        aws_account_id: <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
        folder_id: <p>The ID of the folder.</p>
        name: <p>The name of the folder.</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_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.update_folder_request.UpdateFolderRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.update_folder_response.UpdateFolderResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_folder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFolder")
    )
    input_: capo_quicksight.types.update_folder_request.UpdateFolderRequest = {
        "aws_account_id": aws_account_id,
        "folder_id": folder_id,
        "name": name,
    }

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