FSx / Paginator / DescribeS3AccessPointAttachments

DescribeS3AccessPointAttachments

class FSx.Paginator.DescribeS3AccessPointAttachments

paginator = client.get_paginator('describe_s3_access_point_attachments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from FSx.Client.describe_s3_access_point_attachments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Names=[
        'string',
    ],
    Filters=[
        {
            'Name': 'file-system-id'|'volume-id'|'type',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Names (list) –

  The names of the S3 access point attachments whose descriptions you want to retrieve.

  • (string) –

• Filters (list) –

  Enter a filter Name and Values pair to view a select set of S3 access point attachments.

  • (dict) –

    A set of Name and Values pairs used to view a select set of S3 access point attachments.

    • Name (string) –

      The name of the filter.

    • Values (list) –

      The values of the filter.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'S3AccessPointAttachments': [
        {
            'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED',
            'LifecycleTransitionReason': {
                'Message': 'string'
            },
            'CreationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'Type': 'OPENZFS',
            'OpenZFSConfiguration': {
                'VolumeId': 'string',
                'FileSystemIdentity': {
                    'Type': 'POSIX',
                    'PosixUser': {
                        'Uid': 123,
                        'Gid': 123,
                        'SecondaryGids': [
                            123,
                        ]
                    }
                }
            },
            'S3AccessPoint': {
                'ResourceARN': 'string',
                'Alias': 'string',
                'VpcConfiguration': {
                    'VpcId': 'string'
                }
            }
        },
    ],

}

Response Structure

• (dict) –

  • S3AccessPointAttachments (list) –

    Array of S3 access point attachments returned after a successful DescribeS3AccessPointAttachments operation.

    • (dict) –

      An S3 access point attached to an Amazon FSx volume.

      • Lifecycle (string) –

        The lifecycle status of the S3 access point attachment. The lifecycle can have the following values:

        • AVAILABLE - the S3 access point attachment is available for use

        • CREATING - Amazon FSx is creating the S3 access point and attachment

        • DELETING - Amazon FSx is deleting the S3 access point and attachment

        • FAILED - The S3 access point attachment is in a failed state. Delete and detach the S3 access point attachment, and create a new one.

        • UPDATING - Amazon FSx is updating the S3 access point attachment

      • LifecycleTransitionReason (dict) –

        Describes why a resource lifecycle state changed.

        • Message (string) –

          A detailed error message.

      • CreationTime (datetime) –

        The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

      • Name (string) –

        The name of the S3 access point attachment; also used for the name of the S3 access point.

      • Type (string) –

        The type of Amazon FSx volume that the S3 access point is attached to.

      • OpenZFSConfiguration (dict) –

        The OpenZFSConfiguration of the S3 access point attachment.

        • VolumeId (string) –

          The ID of the FSx for OpenZFS volume that the S3 access point is attached to.

        • FileSystemIdentity (dict) –

          The file system identity used to authorize file access requests made using the S3 access point.

          • Type (string) –

            Specifies the FSx for OpenZFS user identity type, accepts only POSIX.

          • PosixUser (dict) –

            Specifies the UID and GIDs of the file system POSIX user.

            • Uid (integer) –

              The UID of the file system user.

            • Gid (integer) –

              The GID of the file system user.

            • SecondaryGids (list) –

              The list of secondary GIDs for the file system user.

              • (integer) –

      • S3AccessPoint (dict) –

        The S3 access point configuration of the S3 access point attachment.

        • ResourceARN (string) –

          he S3 access point’s ARN.

        • Alias (string) –

          The S3 access point’s alias.

        • VpcConfiguration (dict) –

          The S3 access point’s virtual private cloud (VPC) configuration.

          • VpcId (string) –

            Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.