Skip to content

update_space

update_space(
    aws_account_id: AwsAccountId,
    space_id: PublicSpaceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    name: Optional[SpaceName] = None,
    description: Optional[SpaceDescription] = None,
) -> UpdateSpaceResponse

Updates the metadata of an Amazon QuickSight space.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the space.

  • space_id (PublicSpaceId) –

    The ID of the space that you want to update.

  • name (Optional[SpaceName], default: None ) –

    A new display name for the space.

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

    A new description for the space.

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_space(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    space_id: "capo_quicksight.types.public_space_id.PublicSpaceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    name: Optional["capo_quicksight.types.space_name.SpaceName"] = None,
    description: Optional[
        "capo_quicksight.types.space_description.SpaceDescription"
    ] = None,
) -> "capo_quicksight.types.update_space_response.UpdateSpaceResponse":
    """<p>Updates the metadata of an Amazon QuickSight space.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the space.</p>
        space_id: <p>The ID of the space that you want to update.</p>
        name: <p>A new display name for the space.</p>
        description: <p>A new description for the space.</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_space_request.UpdateSpaceRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.update_space_response.UpdateSpaceResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_space

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

    def _redact_input(
        input_: "capo_quicksight.types.update_space_request.UpdateSpaceRequest",
    ) -> dict[str, Any]:
        import capo_quicksight.types.update_space_request

        return capo_quicksight.types.update_space_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateSpace", redact_input=_redact_input),
    )
    input_: capo_quicksight.types.update_space_request.UpdateSpaceRequest = {
        "aws_account_id": aws_account_id,
        "space_id": space_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description

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