Create Assessment

auditmanager_create_assessment

R Documentation

Creates an assessment in Audit Manager

Description

Creates an assessment in Audit Manager.

Usage

auditmanager_create_assessment(name, description,
  assessmentReportsDestination, scope, roles, frameworkId, tags)

Arguments

name	[required] The name of the assessment to be created.
description	The optional description of the assessment to be created.
assessmentReportsDestination	[required] The assessment report storage destination for the assessment that's being created.
scope	[required] The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment. You no longer need to specify which Amazon Web Services services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services services. If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.
roles	[required] The list of roles for the assessment.
frameworkId	[required] The identifier for the framework that the assessment will be created from.
tags	The tags that are associated with the assessment.

Value

A list with the following syntax:

list(
  assessment = list(
    arn = "string",
    awsAccount = list(
      id = "string",
      emailAddress = "string",
      name = "string"
    ),
    metadata = list(
      name = "string",
      id = "string",
      description = "string",
      complianceType = "string",
      status = "ACTIVE"|"INACTIVE",
      assessmentReportsDestination = list(
        destinationType = "S3",
        destination = "string"
      ),
      scope = list(
        awsAccounts = list(
          list(
            id = "string",
            emailAddress = "string",
            name = "string"
          )
        ),
        awsServices = list(
          list(
            serviceName = "string"
          )
        )
      ),
      roles = list(
        list(
          roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
          roleArn = "string"
        )
      ),
      delegations = list(
        list(
          id = "string",
          assessmentName = "string",
          assessmentId = "string",
          status = "IN_PROGRESS"|"UNDER_REVIEW"|"COMPLETE",
          roleArn = "string",
          roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
          creationTime = as.POSIXct(
            "2015-01-01"
          ),
          lastUpdated = as.POSIXct(
            "2015-01-01"
          ),
          controlSetId = "string",
          comment = "string",
          createdBy = "string"
        )
      ),
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdated = as.POSIXct(
        "2015-01-01"
      )
    ),
    framework = list(
      id = "string",
      arn = "string",
      metadata = list(
        name = "string",
        description = "string",
        logo = "string",
        complianceType = "string"
      ),
      controlSets = list(
        list(
          id = "string",
          description = "string",
          status = "ACTIVE"|"UNDER_REVIEW"|"REVIEWED",
          roles = list(
            list(
              roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
              roleArn = "string"
            )
          ),
          controls = list(
            list(
              id = "string",
              name = "string",
              description = "string",
              status = "UNDER_REVIEW"|"REVIEWED"|"INACTIVE",
              response = "MANUAL"|"AUTOMATE"|"DEFER"|"IGNORE",
              comments = list(
                list(
                  authorName = "string",
                  commentBody = "string",
                  postedDate = as.POSIXct(
                    "2015-01-01"
                  )
                )
              ),
              evidenceSources = list(
                "string"
              ),
              evidenceCount = 123,
              assessmentReportEvidenceCount = 123
            )
          ),
          delegations = list(
            list(
              id = "string",
              assessmentName = "string",
              assessmentId = "string",
              status = "IN_PROGRESS"|"UNDER_REVIEW"|"COMPLETE",
              roleArn = "string",
              roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
              creationTime = as.POSIXct(
                "2015-01-01"
              ),
              lastUpdated = as.POSIXct(
                "2015-01-01"
              ),
              controlSetId = "string",
              comment = "string",
              createdBy = "string"
            )
          ),
          systemEvidenceCount = 123,
          manualEvidenceCount = 123
        )
      )
    ),
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$create_assessment(
  name = "string",
  description = "string",
  assessmentReportsDestination = list(
    destinationType = "S3",
    destination = "string"
  ),
  scope = list(
    awsAccounts = list(
      list(
        id = "string",
        emailAddress = "string",
        name = "string"
      )
    ),
    awsServices = list(
      list(
        serviceName = "string"
      )
    )
  ),
  roles = list(
    list(
      roleType = "PROCESS_OWNER"|"RESOURCE_OWNER",
      roleArn = "string"
    )
  ),
  frameworkId = "string",
  tags = list(
    "string"
  )
)