Skip to content

/AWS1/CL_BUPDESCRFRAMEWORKOUT

DescribeFrameworkOutput

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_frameworkname TYPE /AWS1/BUPFRAMEWORKNAME /AWS1/BUPFRAMEWORKNAME

The unique name of a framework.

iv_frameworkarn TYPE /AWS1/BUPARN /AWS1/BUPARN

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

iv_frameworkdescription TYPE /AWS1/BUPFRAMEWORKDESCRIPTION /AWS1/BUPFRAMEWORKDESCRIPTION

An optional description of the framework.

it_frameworkcontrols TYPE /AWS1/CL_BUPFRAMEWORKCONTROL=>TT_FRAMEWORKCONTROLS TT_FRAMEWORKCONTROLS

The controls that make up the framework. Each control in the list has a name, input parameters, and scope.

iv_creationtime TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

iv_deploymentstatus TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

iv_frameworkstatus TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.

  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

  • INACTIVE when recording is turned off for all resources governed by the framework.

  • UNAVAILABLE when Backup is unable to validate recording status at this time.

iv_idempotencytoken TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Queryable Attributes

FrameworkName

The unique name of a framework.

Accessible with the following methods

Method Description
GET_FRAMEWORKNAME() Getter for FRAMEWORKNAME, with configurable default
ASK_FRAMEWORKNAME() Getter for FRAMEWORKNAME w/ exceptions if field has no value
HAS_FRAMEWORKNAME() Determine if FRAMEWORKNAME has a value

FrameworkArn

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Accessible with the following methods

Method Description
GET_FRAMEWORKARN() Getter for FRAMEWORKARN, with configurable default
ASK_FRAMEWORKARN() Getter for FRAMEWORKARN w/ exceptions if field has no value
HAS_FRAMEWORKARN() Determine if FRAMEWORKARN has a value

FrameworkDescription

An optional description of the framework.

Accessible with the following methods

Method Description
GET_FRAMEWORKDESCRIPTION() Getter for FRAMEWORKDESCRIPTION, with configurable default
ASK_FRAMEWORKDESCRIPTION() Getter for FRAMEWORKDESCRIPTION w/ exceptions if field has n
HAS_FRAMEWORKDESCRIPTION() Determine if FRAMEWORKDESCRIPTION has a value

FrameworkControls

The controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Accessible with the following methods

Method Description
GET_FRAMEWORKCONTROLS() Getter for FRAMEWORKCONTROLS, with configurable default
ASK_FRAMEWORKCONTROLS() Getter for FRAMEWORKCONTROLS w/ exceptions if field has no v
HAS_FRAMEWORKCONTROLS() Determine if FRAMEWORKCONTROLS has a value

CreationTime

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

DeploymentStatus

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Accessible with the following methods

Method Description
GET_DEPLOYMENTSTATUS() Getter for DEPLOYMENTSTATUS, with configurable default
ASK_DEPLOYMENTSTATUS() Getter for DEPLOYMENTSTATUS w/ exceptions if field has no va
HAS_DEPLOYMENTSTATUS() Determine if DEPLOYMENTSTATUS has a value

FrameworkStatus

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.

  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

  • INACTIVE when recording is turned off for all resources governed by the framework.

  • UNAVAILABLE when Backup is unable to validate recording status at this time.

Accessible with the following methods

Method Description
GET_FRAMEWORKSTATUS() Getter for FRAMEWORKSTATUS, with configurable default
ASK_FRAMEWORKSTATUS() Getter for FRAMEWORKSTATUS w/ exceptions if field has no val
HAS_FRAMEWORKSTATUS() Determine if FRAMEWORKSTATUS has a value

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Accessible with the following methods

Method Description
GET_IDEMPOTENCYTOKEN() Getter for IDEMPOTENCYTOKEN, with configurable default
ASK_IDEMPOTENCYTOKEN() Getter for IDEMPOTENCYTOKEN w/ exceptions if field has no va
HAS_IDEMPOTENCYTOKEN() Determine if IDEMPOTENCYTOKEN has a value