Skip to content

/AWS1/IF_S3C=>LISTACCESSPOINTS()

About ListAccessPoints

This operation is not supported by directory buckets.

Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL.

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 ListAccessPoints:

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature

METHODS /AWS1/IF_S3C~LISTACCESSPOINTS
  IMPORTING
    !IV_ACCOUNTID TYPE /AWS1/S3CACCOUNTID OPTIONAL
    !IV_BUCKET TYPE /AWS1/S3CBUCKETNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/S3CNONEMPTYMAXLENGTH1000 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/S3CMAXRESULTS OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/S3CDATASOURCEID OPTIONAL
    !IV_DATASOURCETYPE TYPE /AWS1/S3CDATASOURCETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3clistaccpointsrslt
  RAISING
    /AWS1/CX_S3CCLIENTEXC
    /AWS1/CX_S3CSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_accountid TYPE /AWS1/S3CACCOUNTID /AWS1/S3CACCOUNTID

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

Optional arguments:

iv_bucket TYPE /AWS1/S3CBUCKETNAME /AWS1/S3CBUCKETNAME

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

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:::outpost//bucket/. 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.

iv_nexttoken TYPE /AWS1/S3CNONEMPTYMAXLENGTH1000 /AWS1/S3CNONEMPTYMAXLENGTH1000

A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.

iv_maxresults TYPE /AWS1/S3CMAXRESULTS /AWS1/S3CMAXRESULTS

The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.

iv_datasourceid TYPE /AWS1/S3CDATASOURCEID /AWS1/S3CDATASOURCEID

The unique identifier for the data source of the access point.

iv_datasourcetype TYPE /AWS1/S3CDATASOURCETYPE /AWS1/S3CDATASOURCETYPE

The type of the data source that the access point is attached to. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3clistaccpointsrslt /AWS1/CL_S3CLISTACCPOINTSRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listaccesspoints(
  iv_accountid = |string|
  iv_bucket = |string|
  iv_datasourceid = |string|
  iv_datasourcetype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_accesspointlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_accesspointname = lo_row_1->get_name( ).
      lv_networkorigin = lo_row_1->get_networkorigin( ).
      lo_vpcconfiguration = lo_row_1->get_vpcconfiguration( ).
      IF lo_vpcconfiguration IS NOT INITIAL.
        lv_vpcid = lo_vpcconfiguration->get_vpcid( ).
      ENDIF.
      lv_accesspointbucketname = lo_row_1->get_bucket( ).
      lv_s3accesspointarn = lo_row_1->get_accesspointarn( ).
      lv_alias = lo_row_1->get_alias( ).
      lv_accountid = lo_row_1->get_bucketaccountid( ).
      lv_datasourceid = lo_row_1->get_datasourceid( ).
      lv_datasourcetype = lo_row_1->get_datasourcetype( ).
    ENDIF.
  ENDLOOP.
  lv_nonemptymaxlength1024st = lo_result->get_nexttoken( ).
ENDIF.