Get Settings

auditmanager_get_settings

R Documentation

Gets the settings for a specified Amazon Web Services account¶

Description¶

Gets the settings for a specified Amazon Web Services account.

Usage¶

auditmanager_get_settings(attribute)

Arguments¶

attribute

[required] The list of setting attribute enum values.

Value¶

A list with the following syntax:

list(
  settings = list(
    isAwsOrgEnabled = TRUE|FALSE,
    snsTopic = "string",
    defaultAssessmentReportsDestination = list(
      destinationType = "S3",
      destination = "string"
    ),
    defaultProcessOwners = list(
      list(
        roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
        roleArn = "string"
      )
    ),
    kmsKey = "string",
    evidenceFinderEnablement = list(
      eventDataStoreArn = "string",
      enablementStatus = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS",
      backfillStatus = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED",
      error = "string"
    ),
    deregistrationPolicy = list(
      deleteResources = "ALL"|"DEFAULT"
    ),
    defaultExportDestination = list(
      destinationType = "S3",
      destination = "string"
    )
  )
)

Request syntax¶

svc$get_settings(
  attribute = "ALL"|"IS_AWS_ORG_ENABLED"|"SNS_TOPIC"|"DEFAULT_ASSESSMENT_REPORTS_DESTINATION"|"DEFAULT_PROCESS_OWNERS"|"EVIDENCE_FINDER_ENABLEMENT"|"DEREGISTRATION_POLICY"|"DEFAULT_EXPORT_DESTINATION"
)