Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRemainingFreeTrialDays

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

Request Syntax


POST /detector/detectorId/freeTrial/daysRemaining HTTP/1.1
Content-type: application/json

{
   "accountIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

detectorId

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.

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Request Body

The request accepts the following data in JSON format.

accountIds

A list of account identifiers of the GuardDuty member account.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Fixed length of 12.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accounts": [ 
      { 
         "accountId": "string",
         "dataSources": { 
            "cloudTrail": { 
               "freeTrialDaysRemaining": number
            },
            "dnsLogs": { 
               "freeTrialDaysRemaining": number
            },
            "flowLogs": { 
               "freeTrialDaysRemaining": number
            },
            "kubernetes": { 
               "auditLogs": { 
                  "freeTrialDaysRemaining": number
               }
            },
            "malwareProtection": { 
               "scanEc2InstanceWithFindings": { 
                  "freeTrialDaysRemaining": number
               }
            },
            "s3Logs": { 
               "freeTrialDaysRemaining": number
            }
         },
         "features": [ 
            { 
               "freeTrialDaysRemaining": number,
               "name": "string"
            }
         ]
      }
   ],
   "unprocessedAccounts": [ 
      { 
         "accountId": "string",
         "result": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

accounts

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

Type: Array of AccountFreeTrialInfo objects

unprocessedAccounts

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

Type: Array of UnprocessedAccount objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500