create_folder ¶

def create_folder(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    folder_id: "capo_quicksight.types.restrictive_resource_id.RestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    name: Optional["capo_quicksight.types.folder_name.FolderName"] = None,
    folder_type: Optional["capo_quicksight.types.folder_type.FolderType"] = None,
    parent_folder_arn: Optional["capo_quicksight.types.arn.Arn"] = None,
    permissions: Optional[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ] = None,
    tags: Optional["capo_quicksight.types.tag_list.TagList"] = None,
    sharing_model: Optional[
        "capo_quicksight.types.sharing_model.SharingModel"
    ] = None,
) -> "capo_quicksight.types.create_folder_response.CreateFolderResponse":
    """<p>Creates an empty shared folder.</p>

    Args:
        aws_account_id: <p>The ID for the Amazon Web Services account where you want to create the folder.</p>
        folder_id: <p>The ID of the folder.</p>
        name: <p>The name of the folder.</p>
        folder_type: <p>The type of folder. By default, <code>folderType</code> is <code>SHARED</code>.</p>
        parent_folder_arn: <p>The Amazon Resource Name (ARN) for the parent folder.</p> <p> <code>ParentFolderArn</code> can be null. An empty <code>parentFolderArn</code> creates a root-level folder.</p>
        permissions: <p>A structure that describes the principals and the resource-level permissions of a folder.</p> <p>To specify no permissions, omit <code>Permissions</code>.</p>
        tags: <p>Tags for the folder.</p>
        sharing_model: <p>An optional parameter that determines the sharing scope of the folder. The default value for this parameter is <code>ACCOUNT</code>.</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.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</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.create_folder_request.CreateFolderRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_folder_response.CreateFolderResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_folder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFolder")
    )
    input_: capo_quicksight.types.create_folder_request.CreateFolderRequest = {
        "aws_account_id": aws_account_id,
        "folder_id": folder_id,
    }
    if name is not None:
        input_["name"] = name
    if folder_type is not None:
        input_["folder_type"] = folder_type
    if parent_folder_arn is not None:
        input_["parent_folder_arn"] = parent_folder_arn
    if permissions is not None:
        input_["permissions"] = permissions
    if tags is not None:
        input_["tags"] = tags
    if sharing_model is not None:
        input_["sharing_model"] = sharing_model

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