GetControlResponse ¶

class GetControlResponse(TypedDict, closed=True):
    arn: "capo_controlcatalog.types.control_arn.ControlArn"
    """<p>The Amazon Resource Name (ARN) of the control.</p>"""
    aliases: NotRequired["capo_controlcatalog.types.control_aliases.ControlAliases"]
    """<p>A list of alternative identifiers for the control. These are human-readable designators, such as <code>SH.S3.1</code>. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.</p>"""
    name: "str"
    """<p>The display name of the control.</p>"""
    description: "str"
    """<p>A description of what the control does.</p>"""
    behavior: "capo_controlcatalog.types.control_behavior.ControlBehavior"
    """<p>A term that identifies the control's functional behavior. One of <code>Preventive</code>, <code>Detective</code>, <code>Proactive</code> </p>"""
    severity: NotRequired["capo_controlcatalog.types.control_severity.ControlSeverity"]
    """<p>An enumerated type, with the following possible values:</p>"""
    region_configuration: (
        "capo_controlcatalog.types.region_configuration.RegionConfiguration"
    )
    implementation: NotRequired[
        "capo_controlcatalog.types.implementation_details.ImplementationDetails"
    ]
    """<p>Returns information about the control, as an <code>ImplementationDetails</code> object that shows the underlying implementation type for a control.</p>"""
    parameter_requirement_summary: NotRequired[
        "capo_controlcatalog.types.parameter_requirement_summary.ParameterRequirementSummary"
    ]
    """<p>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.</p>"""
    parameters: NotRequired[
        "capo_controlcatalog.types.control_parameters.ControlParameters"
    ]
    """<p>Returns an array of <code>ControlParameter</code> objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters. </p>"""
    create_time: NotRequired["datetime.datetime"]
    """<p>A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.</p>"""
    governed_resources: NotRequired[
        "capo_controlcatalog.types.governed_resources.GovernedResources"
    ]
    """<p>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 <code>GovernedResources</code> cannot be represented by available resource types, it’s returned as an empty list.</p>"""
    governed_providers: NotRequired[
        "capo_controlcatalog.types.governed_providers.GovernedProviders"
    ]
    """<p>A list of providers whose resources are governed by this control. For example, a value of <code>AWS</code> indicates that the control governs Amazon Web Services resources.</p>"""