Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetExclusionsPreview

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Request Syntax


{
   "assessmentTemplateArn": "string",
   "locale": "string",
   "maxResults": number,
   "nextToken": "string",
   "previewToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

assessmentTemplateArn

The ARN that specifies the assessment template for which the exclusions preview was requested.

Type: String

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

Required: Yes

locale

The locale into which you want to translate the exclusion's title, description, and recommendation.

Type: String

Valid Values: EN_US

Required: No

maxResults

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

Type: Integer

Required: No

nextToken

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

Type: String

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

Required: No

previewToken

The unique identifier associated of the exclusions preview.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Syntax


{
   "exclusionPreviews": [ 
      { 
         "attributes": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "description": "string",
         "recommendation": "string",
         "scopes": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "title": "string"
      }
   ],
   "nextToken": "string",
   "previewStatus": "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.

exclusionPreviews

Information about the exclusions included in the preview.

Type: Array of ExclusionPreview objects

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

nextToken

When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Type: String

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

previewStatus

Specifies the status of the request to generate an exclusions preview.

Type: String

Valid Values: WORK_IN_PROGRESS | COMPLETED

Errors

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

InternalException

Internal server error.

HTTP Status Code: 500

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

NoSuchEntityException

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

HTTP Status Code: 400