Skip to content

Retrieves the S3 Access Grants instance for a Region in your account

Description

Retrieves the S3 Access Grants instance for a Region in your account.

Permissions

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

get_access_grants_instance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.

Usage

s3control_get_access_grants_instance(AccountId)

Arguments

  • AccountId

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

Value

A list with the following syntax:

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

Request syntax

svc$get_access_grants_instance(
  AccountId = "string"
)