create_file_system ¶

def create_file_system(
    self,
    bucket: "capo_s3files.types.bucket_arn.BucketArn",
    role_arn: "capo_s3files.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[S3FilesClientConfig] = None,
    prefix: Optional[str] = None,
    client_token: Optional[
        "capo_s3files.types.creation_token.CreationToken"
    ] = None,
    kms_key_id: Optional["capo_s3files.types.kms_key_id.KmsKeyId"] = None,
    tags: Optional["capo_s3files.types.tag_list.TagList"] = None,
    accept_bucket_warning: Optional[bool] = None,
) -> "capo_s3files.types.create_file_system_response.CreateFileSystemResponse":
    """<p>Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.</p>

    Args:
        bucket: <p>The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.</p>
        prefix: <p>An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
        kms_key_id: <p>The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use <code>KmsKeyId</code>, the file system will be encrypted.</p>
        role_arn: <p>The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.</p>
        tags: <p>An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.</p>
        accept_bucket_warning: <p>Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.</p>

    Raises:
        capo_s3files.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Retry your request using exponential backoff.</p>
        capo_s3files.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. This can occur when trying to create a resource that already exists or delete a resource that is in use.</p>
        capo_s3files.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_s3files.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource exists and that you have permission to access it.</p>
        capo_s3files.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed a service quota. Review your service quotas and either delete resources or request a quota increase.</p>
        capo_s3files.errors.validation_exception.ValidationException: <p>The input parameters are not valid. Check the parameter values and try again.</p>
        capo_s3files.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3files.types.create_file_system_request.CreateFileSystemRequest]",
    ) -> OperationResponse[
        "capo_s3files.types.create_file_system_response.CreateFileSystemResponse"
    ]:
        import capo_s3files._operations.s3_files.create_file_system

        output, http_response = (
            capo_s3files._operations.s3_files.create_file_system.create_file_system(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFileSystem")
    )
    input_: capo_s3files.types.create_file_system_request.CreateFileSystemRequest = {
        "bucket": bucket,
        "role_arn": role_arn,
    }
    if prefix is not None:
        input_["prefix"] = prefix
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if tags is not None:
        input_["tags"] = tags
    if accept_bucket_warning is not None:
        input_["accept_bucket_warning"] = accept_bucket_warning

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