get_folder ¶

def get_folder(
    self,
    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,
    include_custom_metadata: Optional[
        "capo_workdocs.types.boolean_type.BooleanType"
    ] = None,
) -> "capo_workdocs.types.get_folder_response.GetFolderResponse":
    """<p>Retrieves the metadata of the specified folder.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        folder_id: <p>The ID of the folder.</p>
        include_custom_metadata: <p>Set to TRUE to include custom metadata in the response.</p>

    Raises:
        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.invalid_argument_exception.InvalidArgumentException: <p>The pagination marker or limit fields are not valid.</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.get_folder_request.GetFolderRequest]",
    ) -> OperationResponse[
        "capo_workdocs.types.get_folder_response.GetFolderResponse"
    ]:
        import capo_workdocs._operations.aws_gorilla_boy_service.get_folder

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

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

        return capo_workdocs.types.get_folder_request.redact_sensitive(input_)

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

        return capo_workdocs.types.get_folder_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetFolder", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_workdocs.types.get_folder_request.GetFolderRequest = {
        "folder_id": folder_id
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token
    if include_custom_metadata is not None:
        input_["include_custom_metadata"] = include_custom_metadata

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