Describe Framework

backup_describe_framework

R Documentation

Returns the framework details for the specified FrameworkName¶

Description¶

Returns the framework details for the specified FrameworkName.

Usage¶

backup_describe_framework(FrameworkName)

Arguments¶

FrameworkName

[required] The unique name of a framework.

Value¶

A list with the following syntax:

list(
  FrameworkName = "string",
  FrameworkArn = "string",
  FrameworkDescription = "string",
  FrameworkControls = list(
    list(
      ControlName = "string",
      ControlInputParameters = list(
        list(
          ParameterName = "string",
          ParameterValue = "string"
        )
      ),
      ControlScope = list(
        ComplianceResourceIds = list(
          "string"
        ),
        ComplianceResourceTypes = list(
          "string"
        ),
        Tags = list(
          "string"
        )
      )
    )
  ),
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  DeploymentStatus = "string",
  FrameworkStatus = "string",
  IdempotencyToken = "string"
)

Request syntax¶

svc$describe_framework(
  FrameworkName = "string"
)