AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . configservice ]

start-resource-evaluation

Description

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.

Note

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

You can find the Resource type schema in "Amazon Web Services public extensions " within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE .

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

See also: AWS API Documentation

Synopsis

  start-resource-evaluation
--resource-details <value>
[--evaluation-context <value>]
--evaluation-mode <value>
[--evaluation-timeout <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--resource-details (structure)

Returns a ResourceDetails object.

ResourceId -> (string)

A unique resource ID for an evaluation.

ResourceType -> (string)

The type of resource being evaluated.

ResourceConfiguration -> (string)

The resource definition to be evaluated as per the resource configuration schema type.

ResourceConfigurationSchemaType -> (string)

The schema type of the resource configuration.

Note

You can find the Resource type schema , or CFN_RESOURCE_SCHEMA , in "Amazon Web Services public extensions " within the CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE .

For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Shorthand Syntax:

ResourceId=string,ResourceType=string,ResourceConfiguration=string,ResourceConfigurationSchemaType=string

JSON Syntax:

{
  "ResourceId": "string",
  "ResourceType": "string",
  "ResourceConfiguration": "string",
  "ResourceConfigurationSchemaType": "CFN_RESOURCE_SCHEMA"
}

--evaluation-context (structure)

Returns an EvaluationContext object.

EvaluationContextIdentifier -> (string)

A unique EvaluationContextIdentifier ID for an EvaluationContext.

Shorthand Syntax:

EvaluationContextIdentifier=string

JSON Syntax:

{
  "EvaluationContextIdentifier": "string"
}

--evaluation-mode (string)

The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE .

Possible values:

  • DETECTIVE
  • PROACTIVE

--evaluation-timeout (integer)

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

--client-token (string)

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Note

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ResourceEvaluationId -> (string)

A unique ResourceEvaluationId that is associated with a single execution.