AWS S3 Control

Returns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket.

To list access points for general purpose buckets, see ListAccesspoints.

To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

client.list_access_points_for_directory_buckets(
    AccountId='string',
    DirectoryBucket='string',
    NextToken='string',
    MaxResults=123
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Web Services account ID that owns the access points.

type DirectoryBucket:

string

param DirectoryBucket:

The name of the directory bucket associated with the access points you want to list.

type NextToken:

string

param NextToken:

If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

type MaxResults:

integer

param MaxResults:

The maximum number of access points that you would like returned in the ListAccessPointsForDirectoryBuckets response. If the directory bucket is associated with more than this number of access points, the results include the pagination token NextToken. Make another call using the NextToken to retrieve more results.

rtype:

dict

returns:

Response Syntax

{
    'AccessPointList': [
        {
            'Name': 'string',
            'NetworkOrigin': 'Internet'|'VPC',
            'VpcConfiguration': {
                'VpcId': 'string'
            },
            'Bucket': 'string',
            'AccessPointArn': 'string',
            'Alias': 'string',
            'BucketAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • AccessPointList (list) --

    Contains identification and configuration information for one or more access points associated with the directory bucket.

    • (dict) --

      An access point used to access a bucket.

      • Name (string) --

        The name of this access point.

      • NetworkOrigin (string) --

        Indicates whether this access point allows access from the public internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public internet, subject to the access point and bucket access policies.

      • VpcConfiguration (dict) --

        The virtual private cloud (VPC) configuration for this access point, if one exists.

        • VpcId (string) --

          If this field is specified, this access point will only allow connections from the specified VPC ID.

      • Bucket (string) --

        The name of the bucket associated with this access point.

      • AccessPointArn (string) --

        The ARN for the access point.

      • Alias (string) --

        The name or alias of the access point.

      • BucketAccountId (string) --

        The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

  • NextToken (string) --

    If NextToken is returned, there are more access points available than requested in the maxResults value. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Creates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

You can include one or more of the following API operations as permissions:

• PutObjet

• GetObject

• DeleteObject

• ListBucket

• GetObjectAttributes

• AbortMultipartUpload

• ListBucketMultipartUpload

• ListMultiPartUploadParts

To use this operation, you must have the permission to perform the s3express:PutAccessPointScope action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

client.put_access_point_scope(
    AccountId='string',
    Name='string',
    Scope={
        'Prefixes': [
            'string',
        ],
        'Permissions': [
            'GetObject'|'GetObjectAttributes'|'ListMultipartUploadParts'|'ListBucket'|'ListBucketMultipartUploads'|'PutObject'|'DeleteObject'|'AbortMultipartUpload',
        ]
    }
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Web Services account ID that owns the access point with scope that you want to create or replace.

type Name:

string

param Name:

[REQUIRED]

The name of the access point with the scope that you want to create or replace.

type Scope:

dict

param Scope:

[REQUIRED]

Object prefixes, API operations, or a combination of both.

• Prefixes (list) --

  You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 512 KB in size.

  • (string) --

• Permissions (list) --

  You can include one or more API operations as permissions.

  • (string) --

returns:

None

Returns the access point scope for a directory bucket.

To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

client.get_access_point_scope(
    AccountId='string',
    Name='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Web Services account ID that owns the access point with the scope that you want to retrieve.

type Name:

string

param Name:

[REQUIRED]

The name of the access point with the scope you want to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Scope': {
        'Prefixes': [
            'string',
        ],
        'Permissions': [
            'GetObject'|'GetObjectAttributes'|'ListMultipartUploadParts'|'ListBucket'|'ListBucketMultipartUploads'|'PutObject'|'DeleteObject'|'AbortMultipartUpload',
        ]
    }
}

Response Structure

• (dict) --

  • Scope (dict) --

    The contents of the access point scope.

    • Prefixes (list) --

      You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 512 KB in size.

      • (string) --

    • Permissions (list) --

      You can include one or more API operations as permissions.

      • (string) --

Deletes an existing access point scope for a directory bucket.

To use this operation, you must have the permission to perform the s3express:DeleteAccessPointScope action.

For information about REST API errors, see REST error responses.

See also: AWS API Documentation

Request Syntax

client.delete_access_point_scope(
    AccountId='string',
    Name='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Web Services account ID that owns the access point with the scope that you want to delete.

type Name:

string

param Name:

[REQUIRED]

The name of the access point with the scope that you want to delete.

returns:

None

{'Scope': {'Permissions': ['GetObject | GetObjectAttributes | '
                           'ListMultipartUploadParts | ListBucket | '
                           'ListBucketMultipartUploads | PutObject | '
                           'DeleteObject | AbortMultipartUpload'],
           'Prefixes': ['string']}}

Creates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets in general purpose buckets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

• GetAccessPoint

• DeleteAccessPoint

• ListAccessPoints

• ListAccessPointsForDirectoryBuckets

See also: AWS API Documentation

Request Syntax

client.create_access_point(
    AccountId='string',
    Name='string',
    Bucket='string',
    VpcConfiguration={
        'VpcId': 'string'
    },
    PublicAccessBlockConfiguration={
        'BlockPublicAcls': True|False,
        'IgnorePublicAcls': True|False,
        'BlockPublicPolicy': True|False,
        'RestrictPublicBuckets': True|False
    },
    BucketAccountId='string',
    Scope={
        'Prefixes': [
            'string',
        ],
        'Permissions': [
            'GetObject'|'GetObjectAttributes'|'ListMultipartUploadParts'|'ListBucket'|'ListBucketMultipartUploads'|'PutObject'|'DeleteObject'|'AbortMultipartUpload',
        ]
    }
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Web Services account ID for the account that owns the specified access point.

type Name:

string

param Name:

[REQUIRED]

The name you want to assign to this access point.

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

type Bucket:

string

param Bucket:

[REQUIRED]

The name of the bucket that you want to associate this access point with.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

type VpcConfiguration:

dict

param VpcConfiguration:

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

• VpcId (string) -- [REQUIRED]

  If this field is specified, this access point will only allow connections from the specified VPC ID.

type PublicAccessBlockConfiguration:

dict

param PublicAccessBlockConfiguration:

The PublicAccessBlock configuration that you want to apply to the access point.

• BlockPublicAcls (boolean) --

  Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

  • PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.

  • PUT Object calls fail if the request includes a public ACL.

  • PUT Bucket calls fail if the request includes a public ACL.

  Enabling this setting doesn't affect existing policies or ACLs.

  This property is not supported for Amazon S3 on Outposts.

• IgnorePublicAcls (boolean) --

  Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

  Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

  This property is not supported for Amazon S3 on Outposts.

• BlockPublicPolicy (boolean) --

  Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

  Enabling this setting doesn't affect existing bucket policies.

  This property is not supported for Amazon S3 on Outposts.

• RestrictPublicBuckets (boolean) --

  Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Services service principals and authorized users within this account.

  Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

  This property is not supported for Amazon S3 on Outposts.

type BucketAccountId:

string

param BucketAccountId:

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

type Scope:

dict

param Scope:

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

• Prefixes (list) --

  You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 512 KB in size.

  • (string) --

• Permissions (list) --

  You can include one or more API operations as permissions.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'AccessPointArn': 'string',
    'Alias': 'string'
}

Response Structure

• (dict) --

  • AccessPointArn (string) --

    The ARN of the access point.

  • Alias (string) --

    The name or alias of the access point.