S3Files / Client / get_access_point

get_access_point¶

S3Files.Client.get_access_point(**kwargs)¶

Returns resource information for an S3 File System Access Point.

Request Syntax

response = client.get_access_point(
    accessPointId='string'
)

Parameters:

accessPointId (string) –

[REQUIRED]

The ID or Amazon Resource Name (ARN) of the access point to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'accessPointArn': 'string',
    'accessPointId': 'string',
    'clientToken': 'string',
    'fileSystemId': 'string',
    'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
    'ownerId': 'string',
    'posixUser': {
        'uid': 123,
        'gid': 123,
        'secondaryGids': [
            123,
        ]
    },
    'rootDirectory': {
        'path': 'string',
        'creationPermissions': {
            'ownerUid': 123,
            'ownerGid': 123,
            'permissions': 'string'
        }
    },
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'name': 'string'
}

Response Structure

(dict) –
- accessPointArn (string) –
  
  The ARN of the access point.
- accessPointId (string) –
  
  The ID of the access point.
- clientToken (string) –
  
  The client token used for idempotency when the access point was created.
- fileSystemId (string) –
  
  The ID of the S3 File System.
- status (string) –
  
  The current status of the access point.
- ownerId (string) –
  
  The Amazon Web Services account ID of the access point owner.
- posixUser (dict) –
  
  The POSIX identity configured for this access point.
  - uid (integer) –
    
    The POSIX user ID.
  - gid (integer) –
    
    The POSIX group ID.
  - secondaryGids (list) –
    
    An array of secondary POSIX group IDs.
    - (integer) –
- rootDirectory (dict) –
  
  The root directory configuration for this access point.
  - path (string) –
    
    The path to use as the root directory for the access point.
  - creationPermissions (dict) –
    
    The permissions to set on newly created directories.
    - ownerUid (integer) –
      
      The POSIX user ID to assign to newly created directories.
    - ownerGid (integer) –
      
      The POSIX group ID to assign to newly created directories.
    - permissions (string) –
      
      The octal permissions to assign to newly created directories.
- tags (list) –
  
  The tags associated with the access point.
  - (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 access point.

Exceptions

S3Files.Client.exceptions.InternalServerException
S3Files.Client.exceptions.ResourceNotFoundException
S3Files.Client.exceptions.ThrottlingException
S3Files.Client.exceptions.ValidationException