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

get-remaining-free-trial-days

Description

Provides the number of days left for each data source used in the free trial period.

See also: AWS API Documentation

Synopsis

  get-remaining-free-trial-days
--detector-id <value>
[--account-ids <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

--detector-id (string)

The unique ID of the detector of the GuardDuty member account.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

--account-ids (list)

A list of account identifiers of the GuardDuty member account.

(string)

Syntax:

"string" "string" ...

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

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

Accounts -> (list)

The member accounts which were included in a request and were processed successfully.

(structure)

Provides details of the GuardDuty member account that uses a free trial service.

AccountId -> (string)

The account identifier of the GuardDuty member account.

DataSources -> (structure)

Describes the data source enabled for the GuardDuty member account.

CloudTrail -> (structure)

Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

DnsLogs -> (structure)

Describes whether any DNS logs are enabled as data sources.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

FlowLogs -> (structure)

Describes whether any VPC Flow logs are enabled as data sources.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

S3Logs -> (structure)

Describes whether any S3 data event logs are enabled as data sources.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

Kubernetes -> (structure)

Describes whether any Kubernetes logs are enabled as data sources.

AuditLogs -> (structure)

Describes whether Kubernetes audit logs are enabled as a data source.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

MalwareProtection -> (structure)

Describes whether Malware Protection is enabled as a data source.

ScanEc2InstanceWithFindings -> (structure)

Describes whether Malware Protection for EC2 instances with findings is enabled as a data source.

FreeTrialDaysRemaining -> (integer)

A value that specifies the number of days left to use each enabled data source.

Features -> (list)

A list of features enabled for the GuardDuty account.

(structure)

Contains information about the free trial period for a feature.

Name -> (string)

The name of the feature for which the free trial is configured.

FreeTrialDaysRemaining -> (integer)

The number of the remaining free trial days for the feature.

UnprocessedAccounts -> (list)

The member account that was included in a request but for which the request could not be processed.

(structure)

Contains information about the accounts that weren't processed.

AccountId -> (string)

The Amazon Web Services account ID.

Result -> (string)

A reason why the account hasn't been processed.