S3Files / Client / get_file_system

get_file_system

S3Files.Client.get_file_system(**kwargs)

Returns resource information for the specified S3 File System including status, configuration, and metadata.

See also: AWS API Documentation

Request Syntax

response = client.get_file_system(
    fileSystemId='string'
)

Parameters:

fileSystemId (string) –

[REQUIRED]

The ID or Amazon Resource Name (ARN) of the S3 File System to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'fileSystemArn': 'string',
    'fileSystemId': 'string',
    'bucket': 'string',
    'prefix': 'string',
    'clientToken': 'string',
    'kmsKeyId': 'string',
    'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
    'statusMessage': 'string',
    'roleArn': 'string',
    'ownerId': 'string',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'name': 'string'
}

Response Structure

• (dict) –

  • creationTime (datetime) –

    The time when the file system was created.

  • fileSystemArn (string) –

    The Amazon Resource Name (ARN) of the file system.

  • fileSystemId (string) –

    The ID of the file system.

  • bucket (string) –

    The Amazon Resource Name (ARN) of the S3 bucket.

  • prefix (string) –

    The prefix in the S3 bucket that the file system provides access to.

  • clientToken (string) –

    The client token used for idempotency when the file system was created.

  • kmsKeyId (string) –

    The Amazon Resource Name (ARN) of the Amazon Web Services KMS key used for encryption.

  • status (string) –

    The current status of the file system.

  • statusMessage (string) –

    Additional information about the file system status.

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the IAM role used for S3 access.

  • ownerId (string) –

    The Amazon Web Services account ID of the file system owner.

  • tags (list) –

    The tags associated with the file system.

    • (dict) –

      A key-value pair for resource tagging.

      • key (string) –

        The tag key. The key can’t start with aws:.

      • value (string) –

        The tag value.

  • name (string) –

    The name of the file system.

Exceptions

• S3Files.Client.exceptions.InternalServerException

• S3Files.Client.exceptions.ResourceNotFoundException

• S3Files.Client.exceptions.ThrottlingException

• S3Files.Client.exceptions.ValidationException