Skip to content

Get Access Preview

accessanalyzer_get_access_preview R Documentation

Retrieves information about an access preview for the specified analyzer

Description

Retrieves information about an access preview for the specified analyzer.

Usage

accessanalyzer_get_access_preview(accessPreviewId, analyzerArn)

Arguments

accessPreviewId

[required] The unique ID for the access preview.

analyzerArn

[required] The ARN of the analyzer used to generate the access preview.

Value

A list with the following syntax:

list(
  accessPreview = list(
    id = "string",
    analyzerArn = "string",
    configurations = list(
      list(
        ebsSnapshot = list(
          userIds = list(
            "string"
          ),
          groups = list(
            "string"
          ),
          kmsKeyId = "string"
        ),
        ecrRepository = list(
          repositoryPolicy = "string"
        ),
        iamRole = list(
          trustPolicy = "string"
        ),
        efsFileSystem = list(
          fileSystemPolicy = "string"
        ),
        kmsKey = list(
          keyPolicies = list(
            "string"
          ),
          grants = list(
            list(
              operations = list(
                "CreateGrant"|"Decrypt"|"DescribeKey"|"Encrypt"|"GenerateDataKey"|"GenerateDataKeyPair"|"GenerateDataKeyPairWithoutPlaintext"|"GenerateDataKeyWithoutPlaintext"|"GetPublicKey"|"ReEncryptFrom"|"ReEncryptTo"|"RetireGrant"|"Sign"|"Verify"
              ),
              granteePrincipal = "string",
              retiringPrincipal = "string",
              constraints = list(
                encryptionContextEquals = list(
                  "string"
                ),
                encryptionContextSubset = list(
                  "string"
                )
              ),
              issuingAccount = "string"
            )
          )
        ),
        rdsDbClusterSnapshot = list(
          attributes = list(
            list(
              accountIds = list(
                "string"
              )
            )
          ),
          kmsKeyId = "string"
        ),
        rdsDbSnapshot = list(
          attributes = list(
            list(
              accountIds = list(
                "string"
              )
            )
          ),
          kmsKeyId = "string"
        ),
        secretsManagerSecret = list(
          kmsKeyId = "string",
          secretPolicy = "string"
        ),
        s3Bucket = list(
          bucketPolicy = "string",
          bucketAclGrants = list(
            list(
              permission = "READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|"FULL_CONTROL",
              grantee = list(
                id = "string",
                uri = "string"
              )
            )
          ),
          bucketPublicAccessBlock = list(
            ignorePublicAcls = TRUE|FALSE,
            restrictPublicBuckets = TRUE|FALSE
          ),
          accessPoints = list(
            list(
              accessPointPolicy = "string",
              publicAccessBlock = list(
                ignorePublicAcls = TRUE|FALSE,
                restrictPublicBuckets = TRUE|FALSE
              ),
              networkOrigin = list(
                vpcConfiguration = list(
                  vpcId = "string"
                ),
                internetConfiguration = list()
              )
            )
          )
        ),
        snsTopic = list(
          topicPolicy = "string"
        ),
        sqsQueue = list(
          queuePolicy = "string"
        ),
        s3ExpressDirectoryBucket = list(
          bucketPolicy = "string"
        ),
        dynamodbStream = list(
          streamPolicy = "string"
        ),
        dynamodbTable = list(
          tablePolicy = "string"
        )
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    status = "COMPLETED"|"CREATING"|"FAILED",
    statusReason = list(
      code = "INTERNAL_ERROR"|"INVALID_CONFIGURATION"
    )
  )
)

Request syntax

svc$get_access_preview(
  accessPreviewId = "string",
  analyzerArn = "string"
)