Skip to content

Returns a list of S3 Access Grants instances

Description

Returns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account.

Permissions

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

Usage

s3control_list_access_grants_instances(AccountId, NextToken, MaxResults)

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 Instances 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.

Value

A list with the following syntax:

list(
  NextToken = "string",
  AccessGrantsInstancesList = list(
    list(
      AccessGrantsInstanceId = "string",
      AccessGrantsInstanceArn = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      IdentityCenterArn = "string",
      IdentityCenterInstanceArn = "string",
      IdentityCenterApplicationArn = "string"
    )
  )
)

Request syntax

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