/AWS1/CL_CCGGETCONTROLRESPONSE

GetControlResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/CCGCONTROLARN /AWS1/CCGCONTROLARN

The Amazon Resource Name (ARN) of the control.

iv_name TYPE /AWS1/CCGSTRING /AWS1/CCGSTRING

The display name of the control.

iv_description TYPE /AWS1/CCGSTRING /AWS1/CCGSTRING

A description of what the control does.

iv_behavior TYPE /AWS1/CCGCONTROLBEHAVIOR /AWS1/CCGCONTROLBEHAVIOR

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

io_regionconfiguration TYPE REF TO /AWS1/CL_CCGREGIONCONF /AWS1/CL_CCGREGIONCONF

Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see Global services.

If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you'd see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.

Optional arguments:

it_aliases TYPE /AWS1/CL_CCGCONTROLALIASES_W=>TT_CONTROLALIASES TT_CONTROLALIASES

A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

iv_severity TYPE /AWS1/CCGCONTROLSEVERITY /AWS1/CCGCONTROLSEVERITY

An enumerated type, with the following possible values:

io_implementation TYPE REF TO /AWS1/CL_CCGIMPLEMENTATIONDETS /AWS1/CL_CCGIMPLEMENTATIONDETS

Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.

iv_parameterreqmntsummary TYPE /AWS1/CCGPARAMREQMNTSUMMARY /AWS1/CCGPARAMREQMNTSUMMARY

A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.

it_parameters TYPE /AWS1/CL_CCGCONTROLPARAMETER=>TT_CONTROLPARAMETERS TT_CONTROLPARAMETERS

Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

iv_createtime TYPE /AWS1/CCGTIMESTAMP /AWS1/CCGTIMESTAMP

A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

it_governedresources TYPE /AWS1/CL_CCGGOVERNEDRESS_W=>TT_GOVERNEDRESOURCES TT_GOVERNEDRESOURCES

A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list.

it_governedproviders TYPE /AWS1/CL_CCGGOVERNEDPVDRS_W=>TT_GOVERNEDPROVIDERS TT_GOVERNEDPROVIDERS

A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources.

---

Queryable Attributes

Arn

The Amazon Resource Name (ARN) of the control.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

Aliases

A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.

Accessible with the following methods

Method	Description
GET_ALIASES()	Getter for ALIASES, with configurable default
ASK_ALIASES()	Getter for ALIASES w/ exceptions if field has no value
HAS_ALIASES()	Determine if ALIASES has a value

Name

The display name of the control.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Description

A description of what the control does.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Behavior

A term that identifies the control's functional behavior. One of Preventive, Detective, Proactive

Accessible with the following methods

Method	Description
GET_BEHAVIOR()	Getter for BEHAVIOR, with configurable default
ASK_BEHAVIOR()	Getter for BEHAVIOR w/ exceptions if field has no value
HAS_BEHAVIOR()	Determine if BEHAVIOR has a value

Severity

An enumerated type, with the following possible values:

Accessible with the following methods

Method	Description
GET_SEVERITY()	Getter for SEVERITY, with configurable default
ASK_SEVERITY()	Getter for SEVERITY w/ exceptions if field has no value
HAS_SEVERITY()	Determine if SEVERITY has a value

RegionConfiguration

Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see Global services.

If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you'd see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.

Accessible with the following methods

Method	Description
GET_REGIONCONFIGURATION()	Getter for REGIONCONFIGURATION

Implementation

Returns information about the control, as an ImplementationDetails object that shows the underlying implementation type for a control.

Accessible with the following methods

Method	Description
GET_IMPLEMENTATION()	Getter for IMPLEMENTATION

ParameterRequirementSummary

A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.

Accessible with the following methods

Method	Description
GET_PARAMETERREQMNTSUMMARY()	Getter for PARAMETERREQUIREMENTSUMMARY, with configurable de
ASK_PARAMETERREQMNTSUMMARY()	Getter for PARAMETERREQUIREMENTSUMMARY w/ exceptions if fiel
HAS_PARAMETERREQMNTSUMMARY()	Determine if PARAMETERREQUIREMENTSUMMARY has a value

Parameters

Returns an array of ControlParameter objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.

Accessible with the following methods

Method	Description
GET_PARAMETERS()	Getter for PARAMETERS, with configurable default
ASK_PARAMETERS()	Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS()	Determine if PARAMETERS has a value

CreateTime

A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.

Accessible with the following methods

Method	Description
GET_CREATETIME()	Getter for CREATETIME, with configurable default
ASK_CREATETIME()	Getter for CREATETIME w/ exceptions if field has no value
HAS_CREATETIME()	Determine if CREATETIME has a value

GovernedResources

A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If GovernedResources cannot be represented by available resource types, it’s returned as an empty list.

Accessible with the following methods

Method	Description
GET_GOVERNEDRESOURCES()	Getter for GOVERNEDRESOURCES, with configurable default
ASK_GOVERNEDRESOURCES()	Getter for GOVERNEDRESOURCES w/ exceptions if field has no v
HAS_GOVERNEDRESOURCES()	Determine if GOVERNEDRESOURCES has a value

GovernedProviders

A list of providers whose resources are governed by this control. For example, a value of AWS indicates that the control governs Amazon Web Services resources.

Accessible with the following methods

Method	Description
GET_GOVERNEDPROVIDERS()	Getter for GOVERNEDPROVIDERS, with configurable default
ASK_GOVERNEDPROVIDERS()	Getter for GOVERNEDPROVIDERS w/ exceptions if field has no v
HAS_GOVERNEDPROVIDERS()	Determine if GOVERNEDPROVIDERS has a value