[ aws . backup ]

describe-scan-job

Description

Returns scan job details for the specified ScanJobID.

See also: AWS API Documentation

Synopsis

  describe-scan-job
--scan-job-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--scan-job-id (string) [required]

Uniquely identifies a request to Backup to scan a resource.

--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.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

AccountId -> (string)

Returns the account ID that owns the scan job.

Pattern: ^[0-9]{12}$

BackupVaultArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

BackupVaultName -> (string)

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

Pattern: ^[a-zA-Z0-9\-\_\.]{2,50}$

CompletionDate -> (timestamp)

The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy -> (structure)

Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

BackupPlanArn -> (string) [required]

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

BackupPlanId -> (string) [required]

The ID of the backup plan.

BackupPlanVersion -> (string) [required]

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

BackupRuleId -> (string) [required]

Uniquely identifies the backup rule that initiated the scan job.

CreationDate -> (timestamp)

The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IamRoleArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:iam::123456789012:role/S3Access .

MalwareScanner -> (string)

The scanning engine used for the corresponding scan job. Currently only GUARDUTY is supported.

Possible values:

• GUARDDUTY

RecoveryPointArn -> (string)

An ARN that uniquely identifies the target recovery point for scanning.; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

ResourceArn -> (string)

An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.

ResourceName -> (string)

The non-unique name of the resource that belongs to the specified backup.

ResourceType -> (string)

The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Possible values:

• EBS
• EC2
• S3

ScanBaseRecoveryPointArn -> (string)

An ARN that uniquely identifies the base recovery point for scanning. This field will only be populated when an incremental scan job has taken place.

ScanId -> (string)

The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

ScanJobId -> (string)

The scan job ID that uniquely identified the request to Backup.

ScanMode -> (string)

Specifies the scan type used for the scan job.

Possible values:

• FULL_SCAN
• INCREMENTAL_SCAN

ScanResult -> (structure)

Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.

ScanResultStatus -> (string) [required]

The status of the scan results.

Valid values: THREATS_FOUND | NO_THREATS_FOUND .

Possible values:

• NO_THREATS_FOUND
• THREATS_FOUND

ScannerRoleArn -> (string)

Specifies the scanner IAM role ARN used to for the scan job.

State -> (string)

The current state of a scan job.

Possible values:

• CANCELED
• COMPLETED
• COMPLETED_WITH_ISSUES
• CREATED
• FAILED
• RUNNING

StatusMessage -> (string)

A detailed message explaining the status of the job to back up a resource.