create_folder ¶

create_folder(
    parent_folder_id: ResourceIdType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
    name: Optional[ResourceNameType] = None,
) -> CreateFolderResponse

Creates a folder with the specified name and parent folder.

Parameters:

authentication_token (Optional[AuthenticationHeaderType], default: None ) –

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
name (Optional[ResourceNameType], default: None ) –

The name of the new folder.
parent_folder_id (ResourceIdType) –

The ID of the parent folder.

Raises:

ConcurrentModificationException –

The resource hierarchy is changing.
ConflictingOperationException –

Another operation is in progress on the resource that conflicts with the current operation.
EntityAlreadyExistsException –

The resource already exists.
EntityNotExistsException –

The resource does not exist.
FailedDependencyException –

The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
LimitExceededException –

The maximum of 100,000 files and folders under the parent folder has been exceeded.
ProhibitedStateException –

The specified document version is not in the INITIALIZED state.
ServiceUnavailableException –

One or more of the dependencies is unavailable.
UnauthorizedOperationException –

The operation is not permitted.
UnauthorizedResourceAccessException –

The caller does not have access to perform the action on the resource.
UnknownServiceError –

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

Source code in docs_src/capo_workdocs/_services/work_docs.py

def create_folder(
    self,
    parent_folder_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    name: Optional[
        "capo_workdocs.types.resource_name_type.ResourceNameType"
    ] = None,
) -> "capo_workdocs.types.create_folder_response.CreateFolderResponse":
    """<p>Creates a folder with the specified name and parent folder.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        name: <p>The name of the new folder.</p>
        parent_folder_id: <p>The ID of the parent folder.</p>

    Raises:
        capo_workdocs.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The resource hierarchy is changing.</p>
        capo_workdocs.errors.conflicting_operation_exception.ConflictingOperationException: <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
        capo_workdocs.errors.entity_already_exists_exception.EntityAlreadyExistsException: <p>The resource already exists.</p>
        capo_workdocs.errors.entity_not_exists_exception.EntityNotExistsException: <p>The resource does not exist.</p>
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.limit_exceeded_exception.LimitExceededException: <p>The maximum of 100,000 files and folders under the parent folder has been exceeded.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.service_unavailable_exception.ServiceUnavailableException: <p>One or more of the dependencies is unavailable.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workdocs.types.create_folder_request.CreateFolderRequest]",
    ) -> OperationResponse[
        "capo_workdocs.types.create_folder_response.CreateFolderResponse"
    ]:
        import capo_workdocs._operations.aws_gorilla_boy_service.create_folder

        output, http_response = (
            capo_workdocs._operations.aws_gorilla_boy_service.create_folder.create_folder(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.create_folder_request.CreateFolderRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.create_folder_request

        return capo_workdocs.types.create_folder_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_workdocs.types.create_folder_response.CreateFolderResponse",
    ) -> dict[str, Any]:
        import capo_workdocs.types.create_folder_response

        return capo_workdocs.types.create_folder_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateFolder", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_workdocs.types.create_folder_request.CreateFolderRequest = {
        "parent_folder_id": parent_folder_id
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token
    if name is not None:
        input_["name"] = name

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