[ aws . configservice ]

put-external-evaluation

Description

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-external-evaluation
--config-rule-name <value>
--external-evaluation <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--config-rule-name (string)

The name of the Config rule.

--external-evaluation (structure)

An ExternalEvaluation object that provides details about compliance.

ComplianceResourceType -> (string)

The evaluated compliance resource type. Config accepts AWS::::Account resource type.

ComplianceResourceId -> (string)

The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

ComplianceType -> (string)

The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE .

Annotation -> (string)

Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

OrderingTimestamp -> (timestamp)

The time when the compliance was recorded.

Shorthand Syntax:

ComplianceResourceType=string,ComplianceResourceId=string,ComplianceType=string,Annotation=string,OrderingTimestamp=timestamp

JSON Syntax:

{
  "ComplianceResourceType": "string",
  "ComplianceResourceId": "string",
  "ComplianceType": "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
  "Annotation": "string",
  "OrderingTimestamp": timestamp
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None