List Access Grants Locations

s3control_list_access_grants_locations

R Documentation

Returns a list of the locations registered in your S3 Access Grants instance¶

Description¶

Returns a list of the locations registered in your S3 Access Grants instance.

Permissions¶

You must have the s3:ListAccessGrantsLocations permission to use this operation.

Usage¶

s3control_list_access_grants_locations(AccountId, NextToken, MaxResults,
  LocationScope)

Arguments¶

AccountId

[required] The Amazon Web Services account ID of the S3 Access Grants instance.

NextToken

A pagination token to request the next page of results. Pass this value into a subsequent ⁠List Access Grants Locations⁠ request in order to retrieve the next page of results.

MaxResults

The maximum number of access grants that you would like returned in the ⁠List Access Grants⁠ response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

LocationScope

The S3 path to the location that you are registering. The location scope can be the default S3 location ⁠s3://⁠, the S3 path to a bucket ⁠s3://<bucket>⁠, or the S3 path to a bucket and prefix ⁠s3://<bucket>/<prefix>⁠. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the ⁠engineering/⁠ prefix or object key names that start with the ⁠marketing/campaigns/⁠ prefix.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  AccessGrantsLocationsList = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      AccessGrantsLocationId = "string",
      AccessGrantsLocationArn = "string",
      LocationScope = "string",
      IAMRoleArn = "string"
    )
  )
)

Request syntax¶

svc$list_access_grants_locations(
  AccountId = "string",
  NextToken = "string",
  MaxResults = 123,
  LocationScope = "string"
)