get_remaining_free_trial_days

get_remaining_free_trial_days(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_remaining_free_trial_days(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

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

  • AccountIds (list) --

    A list of account identifiers of the GuardDuty member account.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'Accounts': [
        {
            'AccountId': 'string',
            'DataSources': {
                'CloudTrail': {
                    'FreeTrialDaysRemaining': 123
                },
                'DnsLogs': {
                    'FreeTrialDaysRemaining': 123
                },
                'FlowLogs': {
                    'FreeTrialDaysRemaining': 123
                },
                'S3Logs': {
                    'FreeTrialDaysRemaining': 123
                },
                'Kubernetes': {
                    'AuditLogs': {
                        'FreeTrialDaysRemaining': 123
                    }
                },
                'MalwareProtection': {
                    'ScanEc2InstanceWithFindings': {
                        'FreeTrialDaysRemaining': 123
                    }
                }
            }
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Accounts (list) --

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

      • (dict) --

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

        • AccountId (string) --

          The account identifier of the GuardDuty member account.

        • DataSources (dict) --

          Describes the data source enabled for the GuardDuty member account.

          • CloudTrail (dict) --

            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 (dict) --

            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 (dict) --

            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 (dict) --

            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 (dict) --

            Describes whether any Kubernetes logs are enabled as data sources.

            • AuditLogs (dict) --

              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 (dict) --

            Describes whether Malware Protection is enabled as a data source.

            • ScanEc2InstanceWithFindings (dict) --

              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.

    • UnprocessedAccounts (list) --

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

      • (dict) --

        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.

Exceptions

  • GuardDuty.Client.exceptions.BadRequestException
  • GuardDuty.Client.exceptions.InternalServerErrorException