The maximum number of results that are returned per call. The default is 100.
" + } + }, "ListRecommendationsRequest": { "base": null, "refs": { @@ -381,7 +387,6 @@ "base": null, "refs": { "ListRecommendationFeedbackRequest$MaxResults": "The maximum number of results that are returned per call. The default is 100.
", - "ListRecommendationsRequest$MaxResults": "The maximum number of results that are returned per call. The default is 100.
", "ListRepositoryAssociationsRequest$MaxResults": "The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.
The block index.
", "ChangedBlock$BlockIndex": "The block index.
", "GetSnapshotBlockRequest$BlockIndex": "The block index of the block from which to get data.
Obtain the BlockIndex by running the ListChangedBlocks or ListSnapshotBlocks operations.
The block index from which the comparison should start.
The list in the response will start from this block index or the next valid block index in the snapshots.
", - "ListSnapshotBlocksRequest$StartingBlockIndex": "The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.
", + "ListChangedBlocksRequest$StartingBlockIndex": "The block index from which the comparison should start.
The list in the response will start from this block index or the next valid block index in the snapshots.
If you specify NextToken, then StartingBlockIndex is ignored.
", + "ListSnapshotBlocksRequest$StartingBlockIndex": "The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.
If you specify NextToken, then StartingBlockIndex is ignored.
", "PutSnapshotBlockRequest$BlockIndex": "The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.
The number of results to return.
", - "ListSnapshotBlocksRequest$MaxResults": "The number of results to return.
" + "ListChangedBlocksRequest$MaxResults": "The maximum number of blocks to be returned by the request.
Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.
To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.
The maximum number of blocks to be returned by the request.
Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.
To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.
The token to request the next page of results.
", + "ListChangedBlocksRequest$NextToken": "The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
", "ListChangedBlocksResponse$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", - "ListSnapshotBlocksRequest$NextToken": "The token to request the next page of results.
", + "ListSnapshotBlocksRequest$NextToken": "The token to request the next page of results.
If you specify NextToken, then StartingBlockIndex is ignored.
", "ListSnapshotBlocksResponse$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
" } }, diff --git a/models/apis/frauddetector/2019-11-15/api-2.json b/models/apis/frauddetector/2019-11-15/api-2.json index 72f20ad40a..e8e8725be0 100644 --- a/models/apis/frauddetector/2019-11-15/api-2.json +++ b/models/apis/frauddetector/2019-11-15/api-2.json @@ -583,6 +583,22 @@ {"shape":"ResourceUnavailableException"} ] }, + "GetEventPredictionMetadata":{ + "name":"GetEventPredictionMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEventPredictionMetadataRequest"}, + "output":{"shape":"GetEventPredictionMetadataResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "GetEventTypes":{ "name":"GetEventTypes", "http":{ @@ -725,6 +741,21 @@ {"shape":"AccessDeniedException"} ] }, + "ListEventPredictions":{ + "name":"ListEventPredictions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventPredictionsRequest"}, + "output":{"shape":"ListEventPredictionsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -1188,6 +1219,7 @@ "type":"list", "member":{"shape":"BatchPrediction"} }, + "Boolean":{"type":"boolean"}, "CancelBatchImportJobRequest":{ "type":"structure", "required":["jobId"], @@ -1724,6 +1756,40 @@ "arn":{"shape":"fraudDetectorArn"} } }, + "EvaluatedExternalModel":{ + "type":"structure", + "members":{ + "modelEndpoint":{"shape":"string"}, + "useEventVariables":{"shape":"Boolean"}, + "inputVariables":{"shape":"MapOfStrings"}, + "outputVariables":{"shape":"MapOfStrings"} + } + }, + "EvaluatedModelVersion":{ + "type":"structure", + "members":{ + "modelId":{"shape":"string"}, + "modelVersion":{"shape":"string"}, + "modelType":{"shape":"string"}, + "evaluations":{"shape":"ListOfModelVersionEvaluations"} + } + }, + "EvaluatedRule":{ + "type":"structure", + "members":{ + "ruleId":{"shape":"identifier"}, + "ruleVersion":{"shape":"wholeNumberVersionString"}, + "expression":{"shape":"sensitiveString"}, + "expressionWithValues":{"shape":"sensitiveString"}, + "outcomes":{"shape":"ListOfStrings"}, + "evaluated":{"shape":"Boolean"}, + "matched":{"shape":"Boolean"} + } + }, + "EvaluatedRuleList":{ + "type":"list", + "member":{"shape":"EvaluatedRule"} + }, "Event":{ "type":"structure", "members":{ @@ -1748,6 +1814,23 @@ "DISABLED" ] }, + "EventPredictionSummary":{ + "type":"structure", + "members":{ + "eventId":{"shape":"identifier"}, + "eventTypeName":{"shape":"identifier"}, + "eventTimestamp":{"shape":"time"}, + "predictionTimestamp":{"shape":"time"}, + "detectorId":{"shape":"identifier"}, + "detectorVersionId":{"shape":"wholeNumberVersionString"} + } + }, + "EventPredictionsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":50 + }, "EventType":{ "type":"structure", "members":{ @@ -1770,6 +1853,14 @@ "value":{"shape":"variableValue"}, "min":1 }, + "EventVariableSummary":{ + "type":"structure", + "members":{ + "name":{"shape":"sensitiveString"}, + "value":{"shape":"sensitiveString"}, + "source":{"shape":"sensitiveString"} + } + }, "ExternalEventsDetail":{ "type":"structure", "required":[ @@ -1848,6 +1939,12 @@ "type":{"shape":"string"} } }, + "FilterCondition":{ + "type":"structure", + "members":{ + "value":{"shape":"filterString"} + } + }, "GetBatchImportJobsRequest":{ "type":"structure", "members":{ @@ -1949,6 +2046,43 @@ "nextToken":{"shape":"string"} } }, + "GetEventPredictionMetadataRequest":{ + "type":"structure", + "required":[ + "eventId", + "eventTypeName", + "detectorId", + "detectorVersionId", + "predictionTimestamp" + ], + "members":{ + "eventId":{"shape":"identifier"}, + "eventTypeName":{"shape":"identifier"}, + "detectorId":{"shape":"identifier"}, + "detectorVersionId":{"shape":"wholeNumberVersionString"}, + "predictionTimestamp":{"shape":"time"} + } + }, + "GetEventPredictionMetadataResult":{ + "type":"structure", + "members":{ + "eventId":{"shape":"identifier"}, + "eventTypeName":{"shape":"identifier"}, + "entityId":{"shape":"string"}, + "entityType":{"shape":"string"}, + "eventTimestamp":{"shape":"time"}, + "detectorId":{"shape":"identifier"}, + "detectorVersionId":{"shape":"wholeNumberVersionString"}, + "detectorVersionStatus":{"shape":"string"}, + "eventVariables":{"shape":"ListOfEventVariableSummaries"}, + "rules":{"shape":"EvaluatedRuleList"}, + "ruleExecutionMode":{"shape":"RuleExecutionMode"}, + "outcomes":{"shape":"ListOfStrings"}, + "evaluatedModelVersions":{"shape":"ListOfEvaluatedModelVersions"}, + "evaluatedExternalModels":{"shape":"ListOfEvaluatedExternalModels"}, + "predictionTimestamp":{"shape":"time"} + } + }, "GetEventPredictionRequest":{ "type":"structure", "required":[ @@ -2214,6 +2348,41 @@ "type":"string", "enum":["DETECTORPL"] }, + "ListEventPredictionsRequest":{ + "type":"structure", + "members":{ + "eventId":{"shape":"FilterCondition"}, + "eventType":{"shape":"FilterCondition"}, + "detectorId":{"shape":"FilterCondition"}, + "detectorVersionId":{"shape":"FilterCondition"}, + "predictionTimeRange":{"shape":"PredictionTimeRange"}, + "nextToken":{"shape":"string"}, + "maxResults":{"shape":"EventPredictionsMaxResults"} + } + }, + "ListEventPredictionsResult":{ + "type":"structure", + "members":{ + "eventPredictionSummaries":{"shape":"ListOfEventPredictionSummaries"}, + "nextToken":{"shape":"string"} + } + }, + "ListOfEvaluatedExternalModels":{ + "type":"list", + "member":{"shape":"EvaluatedExternalModel"} + }, + "ListOfEvaluatedModelVersions":{ + "type":"list", + "member":{"shape":"EvaluatedModelVersion"} + }, + "ListOfEventPredictionSummaries":{ + "type":"list", + "member":{"shape":"EventPredictionSummary"} + }, + "ListOfEventVariableSummaries":{ + "type":"list", + "member":{"shape":"EventVariableSummary"} + }, "ListOfExternalModelOutputs":{ "type":"list", "member":{"shape":"ExternalModelOutputs"} @@ -2226,6 +2395,10 @@ "type":"list", "member":{"shape":"ModelScores"} }, + "ListOfModelVersionEvaluations":{ + "type":"list", + "member":{"shape":"ModelVersionEvaluation"} + }, "ListOfModelVersions":{ "type":"list", "member":{"shape":"ModelVersion"} @@ -2268,6 +2441,12 @@ } }, "Long":{"type":"long"}, + "MapOfStrings":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"}, + "sensitive":true + }, "MetricDataPoint":{ "type":"structure", "members":{ @@ -2391,6 +2570,14 @@ "arn":{"shape":"fraudDetectorArn"} } }, + "ModelVersionEvaluation":{ + "type":"structure", + "members":{ + "outputVariableName":{"shape":"string"}, + "evaluationScore":{"shape":"string"}, + "predictionExplanations":{"shape":"PredictionExplanations"} + } + }, "ModelVersionStatus":{ "type":"string", "enum":[ @@ -2430,6 +2617,23 @@ "max":100, "min":50 }, + "PredictionExplanations":{ + "type":"structure", + "members":{ + "variableImpactExplanations":{"shape":"listOfVariableImpactExplanations"} + } + }, + "PredictionTimeRange":{ + "type":"structure", + "required":[ + "startTime", + "endTime" + ], + "members":{ + "startTime":{"shape":"time"}, + "endTime":{"shape":"time"} + } + }, "PutDetectorRequest":{ "type":"structure", "required":[ @@ -2977,6 +3181,14 @@ "max":25, "min":1 }, + "VariableImpactExplanation":{ + "type":"structure", + "members":{ + "eventVariableName":{"shape":"string"}, + "relativeImpact":{"shape":"string"}, + "logOddsImpact":{"shape":"float"} + } + }, "VariableImportanceMetrics":{ "type":"structure", "members":{ @@ -3061,6 +3273,12 @@ "type":"list", "member":{"shape":"FileValidationMessage"} }, + "filterString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[0-9A-Za-z_-]+$" + }, "float":{"type":"float"}, "floatVersionString":{ "type":"string", @@ -3106,6 +3324,10 @@ "type":"list", "member":{"shape":"Entity"} }, + "listOfVariableImpactExplanations":{ + "type":"list", + "member":{"shape":"VariableImpactExplanation"} + }, "metricDataPointsList":{ "type":"list", "member":{"shape":"MetricDataPoint"} @@ -3153,6 +3375,10 @@ "min":1, "pattern":"^[0-9A-Za-z_-]+$" }, + "sensitiveString":{ + "type":"string", + "sensitive":true + }, "string":{"type":"string"}, "tagKey":{ "type":"string", diff --git a/models/apis/frauddetector/2019-11-15/docs-2.json b/models/apis/frauddetector/2019-11-15/docs-2.json index b78c4c092f..341716e331 100644 --- a/models/apis/frauddetector/2019-11-15/docs-2.json +++ b/models/apis/frauddetector/2019-11-15/docs-2.json @@ -38,6 +38,7 @@ "GetEntityTypes": "Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
", "GetEventPrediction": "Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
", "GetEventTypes": "Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
", @@ -47,6 +48,7 @@ "GetOutcomes": "Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.
This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
", "GetVariables": "Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz event type - { \"eventType\":{ \"value\": \"xyz\" }” }
This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.
Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
", "PutDetector": "Creates or updates a detector.
", "PutEntityType": "Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
", @@ -151,6 +153,14 @@ "GetBatchPredictionJobsResult$batchPredictions": "An array containing the details of each batch prediction job.
" } }, + "Boolean": { + "base": null, + "refs": { + "EvaluatedExternalModel$useEventVariables": "Indicates whether event variables were used to generate predictions.
", + "EvaluatedRule$evaluated": "Indicates whether the rule was evaluated.
", + "EvaluatedRule$matched": "Indicates whether the rule matched.
" + } + }, "CancelBatchImportJobRequest": { "base": null, "refs": { @@ -505,6 +515,30 @@ "entityTypeList$member": null } }, + "EvaluatedExternalModel": { + "base": "The details of the external (Amazon Sagemaker) model evaluated for generating predictions.
", + "refs": { + "ListOfEvaluatedExternalModels$member": null + } + }, + "EvaluatedModelVersion": { + "base": "The model version evaluated for generating prediction.
", + "refs": { + "ListOfEvaluatedModelVersions$member": null + } + }, + "EvaluatedRule": { + "base": "The details of the rule used for evaluating variable values.
", + "refs": { + "EvaluatedRuleList$member": null + } + }, + "EvaluatedRuleList": { + "base": null, + "refs": { + "GetEventPredictionMetadataResult$rules": "List of rules associated with the detector version that were used for evaluating variable values.
" + } + }, "Event": { "base": "The event details.
", "refs": { @@ -524,6 +558,18 @@ "PutEventTypeRequest$eventIngestion": "Specifies if ingenstion is enabled or disabled.
" } }, + "EventPredictionSummary": { + "base": "Information about the summary of an event prediction.
", + "refs": { + "ListOfEventPredictionSummaries$member": null + } + }, + "EventPredictionsMaxResults": { + "base": null, + "refs": { + "ListEventPredictionsRequest$maxResults": "The maximum number of predictions to return for the request.
" + } + }, "EventType": { "base": "The event type details.
", "refs": { @@ -537,6 +583,12 @@ "SendEventRequest$eventVariables": "Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
" } }, + "EventVariableSummary": { + "base": "Information about the summary of an event variable that was evaluated for generating prediction.
", + "refs": { + "ListOfEventVariableSummaries$member": null + } + }, "ExternalEventsDetail": { "base": "Details for the external events data used for model version training.
", "refs": { @@ -600,6 +652,15 @@ "fileValidationMessageList$member": null } }, + "FilterCondition": { + "base": "A conditional statement for filtering a list of past predictions.
", + "refs": { + "ListEventPredictionsRequest$eventId": "The event ID.
", + "ListEventPredictionsRequest$eventType": "The event type associated with the detector.
", + "ListEventPredictionsRequest$detectorId": "The detector ID.
", + "ListEventPredictionsRequest$detectorVersionId": "The detector version ID.
" + } + }, "GetBatchImportJobsRequest": { "base": null, "refs": { @@ -660,6 +721,16 @@ "refs": { } }, + "GetEventPredictionMetadataRequest": { + "base": null, + "refs": { + } + }, + "GetEventPredictionMetadataResult": { + "base": null, + "refs": { + } + }, "GetEventPredictionRequest": { "base": null, "refs": { @@ -840,6 +911,40 @@ "UpdateRuleVersionRequest$language": "The language.
" } }, + "ListEventPredictionsRequest": { + "base": null, + "refs": { + } + }, + "ListEventPredictionsResult": { + "base": null, + "refs": { + } + }, + "ListOfEvaluatedExternalModels": { + "base": null, + "refs": { + "GetEventPredictionMetadataResult$evaluatedExternalModels": "External (Amazon SageMaker) models that were evaluated for generating predictions.
" + } + }, + "ListOfEvaluatedModelVersions": { + "base": null, + "refs": { + "GetEventPredictionMetadataResult$evaluatedModelVersions": "Model versions that were evaluated for generating predictions.
" + } + }, + "ListOfEventPredictionSummaries": { + "base": null, + "refs": { + "ListEventPredictionsResult$eventPredictionSummaries": "The summary of the past predictions.
" + } + }, + "ListOfEventVariableSummaries": { + "base": null, + "refs": { + "GetEventPredictionMetadataResult$eventVariables": "A list of event variables that influenced the prediction scores.
" + } + }, "ListOfExternalModelOutputs": { "base": null, "refs": { @@ -858,6 +963,12 @@ "GetEventPredictionResult$modelScores": "The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.
" } }, + "ListOfModelVersionEvaluations": { + "base": null, + "refs": { + "EvaluatedModelVersion$evaluations": "Evaluations generated for the model version.
" + } + }, "ListOfModelVersions": { "base": null, "refs": { @@ -876,9 +987,11 @@ "base": null, "refs": { "CreateDetectorVersionRequest$externalModelEndpoints": "The Amazon Sagemaker model endpoints to include in the detector version.
", + "EvaluatedRule$outcomes": "The rule outcome.
", "EventType$eventVariables": "The event type event variables.
", "EventType$labels": "The event type labels.
", "GetDetectorVersionResult$externalModelEndpoints": "The Amazon SageMaker model endpoints included in the detector version.
", + "GetEventPredictionMetadataResult$outcomes": "The outcomes of the matched rule, based on the rule execution mode.
", "PutEventTypeRequest$labels": "The event type labels.
", "RuleResult$outcomes": "The outcomes of the matched rule, based on the rule execution mode.
", "TrainingDataSchema$modelVariables": "The training data schema variables.
", @@ -908,6 +1021,13 @@ "IngestedEventStatistics$eventDataSizeInBytes": "The total size of the stored events.
" } }, + "MapOfStrings": { + "base": null, + "refs": { + "EvaluatedExternalModel$inputVariables": "Input variables use for generating predictions.
", + "EvaluatedExternalModel$outputVariables": "Output variables.
" + } + }, "MetricDataPoint": { "base": "Model performance metrics data points.
", "refs": { @@ -1013,6 +1133,12 @@ "modelVersionDetailList$member": null } }, + "ModelVersionEvaluation": { + "base": "The model version evalutions.
", + "refs": { + "ListOfModelVersionEvaluations$member": null + } + }, "ModelVersionStatus": { "base": null, "refs": { @@ -1055,6 +1181,18 @@ "GetOutcomesRequest$maxResults": "The maximum number of objects to return for the request.
" } }, + "PredictionExplanations": { + "base": "The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.
", + "refs": { + "ModelVersionEvaluation$predictionExplanations": "The prediction explanations generated for the model version.
" + } + }, + "PredictionTimeRange": { + "base": "The time period for when the predictions were generated.
", + "refs": { + "ListEventPredictionsRequest$predictionTimeRange": "The time period for when the predictions were generated.
" + } + }, "PutDetectorRequest": { "base": null, "refs": { @@ -1163,6 +1301,7 @@ "refs": { "CreateDetectorVersionRequest$ruleExecutionMode": "The rule execution mode for the rules included in the detector version.
You can define and edit the rule mode at the detector version level, when it is in draft status.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.
The default behavior is FIRST_MATCHED.
The execution mode of the rule in the dectector
FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The execution mode of the rule used for evaluating variable values.
", "UpdateDetectorVersionRequest$ruleExecutionMode": "The rule execution mode to add to the detector.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The default behavior is FIRST_MATCHED.
The list of variables for the batch create variable request.
" } }, + "VariableImpactExplanation": { + "base": "The details of the event variable's impact on the prediction score.
", + "refs": { + "listOfVariableImpactExplanations$member": null + } + }, "VariableImportanceMetrics": { "base": "The variable importance metrics details.
", "refs": { @@ -1520,6 +1665,12 @@ "DataValidationMetrics$fileLevelMessages": "The file-specific model training validation messages.
" } }, + "filterString": { + "base": null, + "refs": { + "FilterCondition$value": "A statement containing a resource property and a value to specify filter condition.
" + } + }, "float": { "base": null, "refs": { @@ -1529,7 +1680,8 @@ "MetricDataPoint$tpr": "The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
", "MetricDataPoint$threshold": "The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
", "ModelPredictionMap$value": null, - "TrainingMetrics$auc": "The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.
" + "TrainingMetrics$auc": "The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.
", + "VariableImpactExplanation$logOddsImpact": "The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.
A positive value indicates that the variable drove the risk score up.
A negative value indicates that the variable drove the risk score down.
The detector ID.
", "Detector$detectorId": "The detector ID.
", "Detector$eventTypeName": "The name of the event type.
", + "EvaluatedRule$ruleId": "The rule ID.
", + "EventPredictionSummary$eventId": "The event ID.
", + "EventPredictionSummary$eventTypeName": "The event type.
", + "EventPredictionSummary$detectorId": "The detector ID.
", "GetBatchImportJobsRequest$jobId": "The ID of the batch import job to get.
", "GetBatchPredictionJobsRequest$jobId": "The batch prediction job for which to get the details.
", "GetDeleteEventsByEventTypeStatusRequest$eventTypeName": "Name of event type for which to get the deletion status.
", @@ -1624,6 +1780,12 @@ "GetDetectorVersionResult$detectorId": "The detector ID.
", "GetDetectorsRequest$detectorId": "The detector ID.
", "GetEntityTypesRequest$name": "The name.
", + "GetEventPredictionMetadataRequest$eventId": "The event ID.
", + "GetEventPredictionMetadataRequest$eventTypeName": "The event type associated with the detector specified for the prediction.
", + "GetEventPredictionMetadataRequest$detectorId": "The detector ID.
", + "GetEventPredictionMetadataResult$eventId": "The event ID.
", + "GetEventPredictionMetadataResult$eventTypeName": "The event type associated with the detector specified for this prediction.
", + "GetEventPredictionMetadataResult$detectorId": "The detector ID.
", "GetEventTypesRequest$name": "The name.
", "GetLabelsRequest$name": "The name of the label or labels to get.
", "GetOutcomesRequest$name": "The name of the outcome or outcomes to get.
", @@ -1685,6 +1847,12 @@ "SendEventRequest$entities": "An array of entities.
" } }, + "listOfVariableImpactExplanations": { + "base": null, + "refs": { + "PredictionExplanations$variableImpactExplanations": "The details of the event variable's impact on the prediction score.
" + } + }, "metricDataPointsList": { "base": null, "refs": { @@ -1768,6 +1936,16 @@ "PutExternalModelRequest$modelEndpoint": "The model endpoints name.
" } }, + "sensitiveString": { + "base": null, + "refs": { + "EvaluatedRule$expression": "The rule expression.
", + "EvaluatedRule$expressionWithValues": "The rule expression value.
", + "EventVariableSummary$name": "The event variable name.
", + "EventVariableSummary$value": "The value of the event variable.
", + "EventVariableSummary$source": "The event variable source.
" + } + }, "string": { "base": null, "refs": { @@ -1795,6 +1973,10 @@ "DescribeModelVersionsResult$nextToken": "The next token.
", "Entity$entityType": "The entity type.
", "EntityType$name": "The entity type name.
", + "EvaluatedExternalModel$modelEndpoint": "The endpoint of the external (Amazon Sagemaker) model.
", + "EvaluatedModelVersion$modelId": "The model ID.
", + "EvaluatedModelVersion$modelVersion": "The model version.
", + "EvaluatedModelVersion$modelType": "The model type.
Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS
The event ID.
", "Event$eventTypeName": "The event type.
", "Event$eventTimestamp": "The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
", @@ -1822,6 +2004,9 @@ "GetDetectorsResult$nextToken": "The next page token.
", "GetEntityTypesRequest$nextToken": "The next token for the subsequent request.
", "GetEntityTypesResult$nextToken": "The next page token.
", + "GetEventPredictionMetadataResult$entityId": "The entity ID.
", + "GetEventPredictionMetadataResult$entityType": "The entity type.
", + "GetEventPredictionMetadataResult$detectorVersionStatus": "The status of the detector version.
", "GetEventPredictionRequest$detectorId": "The detector ID.
", "GetEventPredictionRequest$eventId": "The unique ID used to identify the event.
", "GetEventPredictionRequest$eventTypeName": "The event type associated with the detector specified for the prediction.
", @@ -1848,14 +2033,20 @@ "JsonKeyToVariableMap$key": null, "JsonKeyToVariableMap$value": null, "Label$name": "The label name.
", + "ListEventPredictionsRequest$nextToken": "Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
", + "ListEventPredictionsResult$nextToken": "Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
", "ListOfStrings$member": null, "ListTagsForResourceRequest$nextToken": "The next token from the previous results.
", "ListTagsForResourceResult$nextToken": "The next token for subsequent requests.
", "LogOddsMetric$variableName": "The name of the variable.
", "LogOddsMetric$variableType": "The type of variable.
", + "MapOfStrings$key": null, + "MapOfStrings$value": null, "Model$eventTypeName": "The name of the event type.
", "ModelPredictionMap$key": null, "ModelVersionDetail$status": "The status of the model version.
", + "ModelVersionEvaluation$outputVariableName": "The output variable name.
", + "ModelVersionEvaluation$evaluationScore": "The evaluation score generated for the model version.
", "NameList$member": null, "NonEmptyListOfStrings$member": null, "PutExternalModelRequest$invokeModelEndpointRoleArn": "The IAM role used to invoke the model endpoint.
", @@ -1879,6 +2070,8 @@ "VariableEntry$defaultValue": "The default value of the variable.
", "VariableEntry$description": "The description of the variable.
", "VariableEntry$variableType": "The type of the variable. For more information see Variable types.
Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
The event variable name.
", + "VariableImpactExplanation$relativeImpact": "The event variable's relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.
", "labelMapper$key": null } }, @@ -1937,12 +2130,17 @@ "DetectorVersionSummary$lastUpdatedTime": "Timestamp of when the detector version was last updated.
", "EntityType$lastUpdatedTime": "Timestamp of when the entity type was last updated.
", "EntityType$createdTime": "Timestamp of when the entity type was created.
", + "EventPredictionSummary$eventTimestamp": "The timestamp of the event.
", + "EventPredictionSummary$predictionTimestamp": "The timestamp when the prediction was generated.
", "EventType$lastUpdatedTime": "Timestamp of when the event type was last updated.
", "EventType$createdTime": "Timestamp of when the event type was created.
", "ExternalModel$lastUpdatedTime": "Timestamp of when the model was last updated.
", "ExternalModel$createdTime": "Timestamp of when the model was last created.
", "GetDetectorVersionResult$lastUpdatedTime": "The timestamp when the detector version was last updated.
", "GetDetectorVersionResult$createdTime": "The timestamp when the detector version was created.
", + "GetEventPredictionMetadataRequest$predictionTimestamp": "The timestamp that defines when the prediction was generated.
", + "GetEventPredictionMetadataResult$eventTimestamp": "The timestamp for when the prediction was generated for the associated event ID.
", + "GetEventPredictionMetadataResult$predictionTimestamp": "The timestamp that defines when the prediction was generated.
", "IngestedEventStatistics$leastRecentEvent": "The oldest stored event.
", "IngestedEventStatistics$mostRecentEvent": "The newest stored event.
", "IngestedEventStatistics$lastUpdatedTime": "Timestamp of when the stored event was last updated.
", @@ -1956,6 +2154,8 @@ "ModelVersionDetail$createdTime": "The timestamp when the model was created.
", "Outcome$lastUpdatedTime": "The timestamp when the outcome was last updated.
", "Outcome$createdTime": "The timestamp when the outcome was created.
", + "PredictionTimeRange$startTime": "The start time of the time period for when the predictions were generated.
", + "PredictionTimeRange$endTime": "The end time of the time period for when the predictions were generated.
", "RuleDetail$lastUpdatedTime": "Timestamp of the last time the rule was updated.
", "RuleDetail$createdTime": "The timestamp of when the rule was created.
", "Variable$lastUpdatedTime": "The time when variable was last updated.
", @@ -1990,8 +2190,12 @@ "CreateDetectorVersionResult$detectorVersionId": "The ID for the created detector.
", "DeleteDetectorVersionRequest$detectorVersionId": "The ID of the detector version to delete.
", "DetectorVersionSummary$detectorVersionId": "The detector version ID.
", + "EvaluatedRule$ruleVersion": "The rule version.
", + "EventPredictionSummary$detectorVersionId": "The detector version ID.
", "GetDetectorVersionRequest$detectorVersionId": "The detector version ID.
", "GetDetectorVersionResult$detectorVersionId": "The detector version ID.
", + "GetEventPredictionMetadataRequest$detectorVersionId": "The detector version ID.
", + "GetEventPredictionMetadataResult$detectorVersionId": "The detector version ID.
", "GetEventPredictionRequest$detectorVersionId": "The detector version ID.
", "GetRulesRequest$ruleVersion": "The rule version.
", "Rule$ruleVersion": "The rule version.
", diff --git a/models/apis/frauddetector/2019-11-15/paginators-1.json b/models/apis/frauddetector/2019-11-15/paginators-1.json index cf1e320513..83158e2392 100644 --- a/models/apis/frauddetector/2019-11-15/paginators-1.json +++ b/models/apis/frauddetector/2019-11-15/paginators-1.json @@ -60,6 +60,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListEventPredictions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListTagsForResource": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 3e4e33b721..94bd37fbf2 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -8421,6 +8421,12 @@ "type":"string", "min":1 }, + "FailStepMetadata":{ + "type":"structure", + "members":{ + "ErrorMessage":{"shape":"String3072"} + } + }, "FailureReason":{ "type":"string", "max":1024 @@ -12988,7 +12994,8 @@ "Lambda":{"shape":"LambdaStepMetadata"}, "QualityCheck":{"shape":"QualityCheckStepMetadata"}, "ClarifyCheck":{"shape":"ClarifyCheckStepMetadata"}, - "EMR":{"shape":"EMRStepMetadata"} + "EMR":{"shape":"EMRStepMetadata"}, + "Fail":{"shape":"FailStepMetadata"} } }, "PipelineExecutionSummary":{ @@ -12998,7 +13005,8 @@ "StartTime":{"shape":"Timestamp"}, "PipelineExecutionStatus":{"shape":"PipelineExecutionStatus"}, "PipelineExecutionDescription":{"shape":"PipelineExecutionDescription"}, - "PipelineExecutionDisplayName":{"shape":"PipelineExecutionName"} + "PipelineExecutionDisplayName":{"shape":"PipelineExecutionName"}, + "PipelineExecutionFailureReason":{"shape":"String3072"} } }, "PipelineExecutionSummaryList":{ @@ -14941,6 +14949,10 @@ "type":"string", "max":256 }, + "String3072":{ + "type":"string", + "max":3072 + }, "String40":{ "type":"string", "max":40 diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index 61dd0ad5c2..30369c6b2e 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -224,7 +224,7 @@ "StopLabelingJob": "Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.
", "StopMonitoringSchedule": "Stops a previously started monitoring schedule.
", "StopNotebookInstance": "Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.
To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, Amazon SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.
Only when Amazon SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.
Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.
Stops a processing job.
", "StopTrainingJob": "Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.
When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.
Stops a batch transform job.
When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
Specifies configuration for how an endpoint performs asynchronous inference.
", "refs": { - "CreateEndpointConfigInput$AsyncInferenceConfig": "Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync .
Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
", "DescribeEndpointConfigOutput$AsyncInferenceConfig": "Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.
" } }, + "FailStepMetadata": { + "base": "The container for the metadata for Fail step.
", + "refs": { + "PipelineExecutionStepMetadata$Fail": "The configurations and outcomes of a Fail step execution.
" + } + }, "FailureReason": { "base": null, "refs": { @@ -5243,7 +5249,7 @@ "IntegerValue": { "base": null, "refs": { - "PipelineExecutionStep$AttemptCount": "The current attempt of the execution step. For more information, see Retry Policy for Amazon SageMaker Pipelines steps.
" + "PipelineExecutionStep$AttemptCount": "The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
" } }, "InvocationsMaxRetries": { @@ -6951,7 +6957,7 @@ "ModelPackageType": { "base": null, "refs": { - "ListModelPackagesInput$ModelPackageType": "A filter that returns onlyl the model packages of the specified type. This can be one of the following values.
VERSIONED - List only versioned models.
UNVERSIONED - List only unversioined models.
BOTH - List both versioned and unversioned models.
A filter that returns only the model packages of the specified type. This can be one of the following values.
UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
VERSIONED - List only versioned models.
BOTH - List both versioned and unversioned models.
A message describing why the step failed.
" } }, + "String3072": { + "base": null, + "refs": { + "FailStepMetadata$ErrorMessage": "A message that you define and then is processed and rendered by the Fail step when the error occurs.
", + "PipelineExecutionSummary$PipelineExecutionFailureReason": "A message generated by SageMaker Pipelines describing why the pipeline execution failed.
" + } + }, "String40": { "base": null, "refs": { diff --git a/models/apis/securityhub/2018-10-26/api-2.json b/models/apis/securityhub/2018-10-26/api-2.json index aa68fbdbe4..a56ff61145 100644 --- a/models/apis/securityhub/2018-10-26/api-2.json +++ b/models/apis/securityhub/2018-10-26/api-2.json @@ -4442,7 +4442,8 @@ "Vulnerabilities":{"shape":"VulnerabilityList"}, "PatchSummary":{"shape":"PatchSummary"}, "Action":{"shape":"Action"}, - "FindingProviderFields":{"shape":"FindingProviderFields"} + "FindingProviderFields":{"shape":"FindingProviderFields"}, + "Sample":{"shape":"Boolean"} } }, "AwsSecurityFindingFilters":{ @@ -4557,7 +4558,8 @@ "FindingProviderFieldsRelatedFindingsProductArn":{"shape":"StringFilterList"}, "FindingProviderFieldsSeverityLabel":{"shape":"StringFilterList"}, "FindingProviderFieldsSeverityOriginal":{"shape":"StringFilterList"}, - "FindingProviderFieldsTypes":{"shape":"StringFilterList"} + "FindingProviderFieldsTypes":{"shape":"StringFilterList"}, + "Sample":{"shape":"BooleanFilterList"} } }, "AwsSecurityFindingIdentifier":{ @@ -4817,6 +4819,16 @@ "member":{"shape":"BatchUpdateFindingsUnprocessedFinding"} }, "Boolean":{"type":"boolean"}, + "BooleanFilter":{ + "type":"structure", + "members":{ + "Value":{"shape":"Boolean"} + } + }, + "BooleanFilterList":{ + "type":"list", + "member":{"shape":"BooleanFilter"} + }, "CategoryList":{ "type":"list", "member":{"shape":"NonEmptyString"} diff --git a/models/apis/securityhub/2018-10-26/docs-2.json b/models/apis/securityhub/2018-10-26/docs-2.json index 8d08b7fafb..f177545007 100644 --- a/models/apis/securityhub/2018-10-26/docs-2.json +++ b/models/apis/securityhub/2018-10-26/docs-2.json @@ -2973,8 +2973,10 @@ "AwsSecretsManagerSecretDetails$RotationOccurredWithinFrequency": "Whether the rotation occurred within the specified rotation frequency.
", "AwsSecretsManagerSecretDetails$RotationEnabled": "Whether rotation is enabled.
", "AwsSecretsManagerSecretDetails$Deleted": "Whether the secret is deleted.
", + "AwsSecurityFinding$Sample": "Indicates whether the finding is a sample finding.
", "AwsWafRateBasedRuleMatchPredicate$Negated": "If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the predicate settings.
If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the predicate settings.
The value of the boolean.
", "ClassificationResult$AdditionalOccurrences": "Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.
", "DescribeHubResponse$AutoEnableControls": "Whether to automatically enable new controls when they are added to standards that are enabled.
If set to true, then new controls for enabled standards are enabled automatically. If set to false, then new controls are not enabled.
Whether to automatically enable Security Hub for new accounts in the organization.
If set to true, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.
Whether to automatically enable new controls when they are added to standards that are enabled.
By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false.
Boolean filter for querying findings.
", + "refs": { + "BooleanFilterList$member": null + } + }, + "BooleanFilterList": { + "base": null, + "refs": { + "AwsSecurityFindingFilters$Sample": "Indicates whether or not sample findings are included in the filter results.
" + } + }, "CategoryList": { "base": null, "refs": { diff --git a/service/codegurureviewer/waiters.go b/service/codegurureviewer/waiters.go index be5669e771..4a47be6f70 100644 --- a/service/codegurureviewer/waiters.go +++ b/service/codegurureviewer/waiters.go @@ -28,7 +28,7 @@ func (c *CodeGuruReviewer) WaitUntilCodeReviewCompleted(input *DescribeCodeRevie func (c *CodeGuruReviewer) WaitUntilCodeReviewCompletedWithContext(ctx aws.Context, input *DescribeCodeReviewInput, opts ...request.WaiterOption) error { w := request.Waiter{ Name: "WaitUntilCodeReviewCompleted", - MaxAttempts: 60, + MaxAttempts: 180, Delay: request.ConstantWaiterDelay(10 * time.Second), Acceptors: []request.WaiterAcceptor{ { @@ -36,6 +36,11 @@ func (c *CodeGuruReviewer) WaitUntilCodeReviewCompletedWithContext(ctx aws.Conte Matcher: request.PathWaiterMatch, Argument: "CodeReview.State", Expected: "Completed", }, + { + State: request.FailureWaiterState, + Matcher: request.PathWaiterMatch, Argument: "CodeReview.State", + Expected: "Failed", + }, { State: request.RetryWaiterState, Matcher: request.PathWaiterMatch, Argument: "CodeReview.State", @@ -79,7 +84,7 @@ func (c *CodeGuruReviewer) WaitUntilRepositoryAssociationSucceeded(input *Descri func (c *CodeGuruReviewer) WaitUntilRepositoryAssociationSucceededWithContext(ctx aws.Context, input *DescribeRepositoryAssociationInput, opts ...request.WaiterOption) error { w := request.Waiter{ Name: "WaitUntilRepositoryAssociationSucceeded", - MaxAttempts: 20, + MaxAttempts: 30, Delay: request.ConstantWaiterDelay(10 * time.Second), Acceptors: []request.WaiterAcceptor{ { @@ -87,6 +92,11 @@ func (c *CodeGuruReviewer) WaitUntilRepositoryAssociationSucceededWithContext(ct Matcher: request.PathWaiterMatch, Argument: "RepositoryAssociation.State", Expected: "Associated", }, + { + State: request.FailureWaiterState, + Matcher: request.PathWaiterMatch, Argument: "RepositoryAssociation.State", + Expected: "Failed", + }, { State: request.RetryWaiterState, Matcher: request.PathWaiterMatch, Argument: "RepositoryAssociation.State", diff --git a/service/ebs/api.go b/service/ebs/api.go index ec1c130a48..cfa58c17ab 100644 --- a/service/ebs/api.go +++ b/service/ebs/api.go @@ -1363,10 +1363,19 @@ type ListChangedBlocksInput struct { // otherwise, an error occurs. FirstSnapshotId *string `location:"querystring" locationName:"firstSnapshotId" min:"1" type:"string"` - // The number of results to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request + // can return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request + // with the returned NextToken value. The value of NextToken is null when there + // are no more blocks to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"` // The token to request the next page of results. + // + // If you specify NextToken, then StartingBlockIndex is ignored. NextToken *string `location:"querystring" locationName:"pageToken" type:"string"` // The ID of the second snapshot to use for the comparison. @@ -1381,6 +1390,8 @@ type ListChangedBlocksInput struct { // // The list in the response will start from this block index or the next valid // block index in the snapshots. + // + // If you specify NextToken, then StartingBlockIndex is ignored. StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"` } @@ -1525,10 +1536,19 @@ func (s *ListChangedBlocksOutput) SetVolumeSize(v int64) *ListChangedBlocksOutpu type ListSnapshotBlocksInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The number of results to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request + // can return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request + // with the returned NextToken value. The value of NextToken is null when there + // are no more blocks to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"100" type:"integer"` // The token to request the next page of results. + // + // If you specify NextToken, then StartingBlockIndex is ignored. NextToken *string `location:"querystring" locationName:"pageToken" type:"string"` // The ID of the snapshot from which to get block indexes and block tokens. @@ -1538,6 +1558,8 @@ type ListSnapshotBlocksInput struct { // The block index from which the list should start. The list in the response // will start from this block index or the next valid block index in the snapshot. + // + // If you specify NextToken, then StartingBlockIndex is ignored. StartingBlockIndex *int64 `location:"querystring" locationName:"startingBlockIndex" type:"integer"` } diff --git a/service/frauddetector/api.go b/service/frauddetector/api.go index ca625838be..239e5c595e 100644 --- a/service/frauddetector/api.go +++ b/service/frauddetector/api.go @@ -3743,6 +3743,101 @@ func (c *FraudDetector) GetEventPredictionWithContext(ctx aws.Context, input *Ge return out, req.Send() } +const opGetEventPredictionMetadata = "GetEventPredictionMetadata" + +// GetEventPredictionMetadataRequest generates a "aws/request.Request" representing the +// client's request for the GetEventPredictionMetadata operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEventPredictionMetadata for more information on using the GetEventPredictionMetadata +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEventPredictionMetadataRequest method. +// req, resp := client.GetEventPredictionMetadataRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadata +func (c *FraudDetector) GetEventPredictionMetadataRequest(input *GetEventPredictionMetadataInput) (req *request.Request, output *GetEventPredictionMetadataOutput) { + op := &request.Operation{ + Name: opGetEventPredictionMetadata, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetEventPredictionMetadataInput{} + } + + output = &GetEventPredictionMetadataOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEventPredictionMetadata API operation for Amazon Fraud Detector. +// +// Gets details of the past fraud predictions for the specified event ID, event +// type, detector ID, and detector version ID that was generated in the specified +// time period. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Fraud Detector's +// API operation GetEventPredictionMetadata for usage and error information. +// +// Returned Error Types: +// * ValidationException +// An exception indicating a specified value is not allowed. +// +// * ResourceNotFoundException +// An exception indicating the specified resource was not found. +// +// * AccessDeniedException +// An exception indicating Amazon Fraud Detector does not have the needed permissions. +// This can occur if you submit a request, such as PutExternalModel, that specifies +// a role that is not in your account. +// +// * ThrottlingException +// An exception indicating a throttling error. +// +// * InternalServerException +// An exception indicating an internal server error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetEventPredictionMetadata +func (c *FraudDetector) GetEventPredictionMetadata(input *GetEventPredictionMetadataInput) (*GetEventPredictionMetadataOutput, error) { + req, out := c.GetEventPredictionMetadataRequest(input) + return out, req.Send() +} + +// GetEventPredictionMetadataWithContext is the same as GetEventPredictionMetadata with the addition of +// the ability to pass a context and additional request options. +// +// See GetEventPredictionMetadata for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *FraudDetector) GetEventPredictionMetadataWithContext(ctx aws.Context, input *GetEventPredictionMetadataInput, opts ...request.Option) (*GetEventPredictionMetadataOutput, error) { + req, out := c.GetEventPredictionMetadataRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetEventTypes = "GetEventTypes" // GetEventTypesRequest generates a "aws/request.Request" representing the @@ -5027,6 +5122,165 @@ func (c *FraudDetector) GetVariablesPagesWithContext(ctx aws.Context, input *Get return p.Err() } +const opListEventPredictions = "ListEventPredictions" + +// ListEventPredictionsRequest generates a "aws/request.Request" representing the +// client's request for the ListEventPredictions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListEventPredictions for more information on using the ListEventPredictions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListEventPredictionsRequest method. +// req, resp := client.ListEventPredictionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictions +func (c *FraudDetector) ListEventPredictionsRequest(input *ListEventPredictionsInput) (req *request.Request, output *ListEventPredictionsOutput) { + op := &request.Operation{ + Name: opListEventPredictions, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListEventPredictionsInput{} + } + + output = &ListEventPredictionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListEventPredictions API operation for Amazon Fraud Detector. +// +// Gets a list of past predictions. The list can be filtered by detector ID, +// detector version ID, event ID, event type, or by specifying a time period. +// If filter is not specified, the most recent prediction is returned. +// +// For example, the following filter lists all past predictions for xyz event +// type - { "eventType":{ "value": "xyz" }” } +// +// This is a paginated API. If you provide a null maxResults, this action will +// retrieve a maximum of 10 records per page. If you provide a maxResults, the +// value must be between 50 and 100. To get the next page results, provide the +// nextToken from the response as part of your request. A null nextToken fetches +// the records from the beginning. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Fraud Detector's +// API operation ListEventPredictions for usage and error information. +// +// Returned Error Types: +// * ValidationException +// An exception indicating a specified value is not allowed. +// +// * AccessDeniedException +// An exception indicating Amazon Fraud Detector does not have the needed permissions. +// This can occur if you submit a request, such as PutExternalModel, that specifies +// a role that is not in your account. +// +// * ThrottlingException +// An exception indicating a throttling error. +// +// * InternalServerException +// An exception indicating an internal server error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/ListEventPredictions +func (c *FraudDetector) ListEventPredictions(input *ListEventPredictionsInput) (*ListEventPredictionsOutput, error) { + req, out := c.ListEventPredictionsRequest(input) + return out, req.Send() +} + +// ListEventPredictionsWithContext is the same as ListEventPredictions with the addition of +// the ability to pass a context and additional request options. +// +// See ListEventPredictions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *FraudDetector) ListEventPredictionsWithContext(ctx aws.Context, input *ListEventPredictionsInput, opts ...request.Option) (*ListEventPredictionsOutput, error) { + req, out := c.ListEventPredictionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListEventPredictionsPages iterates over the pages of a ListEventPredictions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListEventPredictions method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListEventPredictions operation. +// pageNum := 0 +// err := client.ListEventPredictionsPages(params, +// func(page *frauddetector.ListEventPredictionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FraudDetector) ListEventPredictionsPages(input *ListEventPredictionsInput, fn func(*ListEventPredictionsOutput, bool) bool) error { + return c.ListEventPredictionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListEventPredictionsPagesWithContext same as ListEventPredictionsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *FraudDetector) ListEventPredictionsPagesWithContext(ctx aws.Context, input *ListEventPredictionsInput, fn func(*ListEventPredictionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListEventPredictionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListEventPredictionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListEventPredictionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -10928,34 +11182,30 @@ func (s *EntityType) SetName(v string) *EntityType { return s } -// The event details. -type Event struct { +// The details of the external (Amazon Sagemaker) model evaluated for generating +// predictions. +type EvaluatedExternalModel struct { _ struct{} `type:"structure"` - // The label associated with the event. - CurrentLabel *string `locationName:"currentLabel" type:"string"` - - // The event entities. - Entities []*Entity `locationName:"entities" type:"list"` - - // The event ID. - EventId *string `locationName:"eventId" type:"string"` - - // The timestamp that defines when the event under evaluation occurred. The - // timestamp must be specified using ISO 8601 standard in UTC. - EventTimestamp *string `locationName:"eventTimestamp" type:"string"` + // Input variables use for generating predictions. + // + // InputVariables is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EvaluatedExternalModel's + // String and GoString methods. + InputVariables map[string]*string `locationName:"inputVariables" type:"map" sensitive:"true"` - // The event type. - EventTypeName *string `locationName:"eventTypeName" type:"string"` + // The endpoint of the external (Amazon Sagemaker) model. + ModelEndpoint *string `locationName:"modelEndpoint" type:"string"` - // Names of the event type's variables you defined in Amazon Fraud Detector - // to represent data elements and their corresponding values for the event you - // are sending for evaluation. - EventVariables map[string]*string `locationName:"eventVariables" type:"map"` + // Output variables. + // + // OutputVariables is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EvaluatedExternalModel's + // String and GoString methods. + OutputVariables map[string]*string `locationName:"outputVariables" type:"map" sensitive:"true"` - // The timestamp associated with the label to update. The timestamp must be - // specified using ISO 8601 standard in UTC. - LabelTimestamp *string `locationName:"labelTimestamp" type:"string"` + // Indicates whether event variables were used to generate predictions. + UseEventVariables *bool `locationName:"useEventVariables" type:"boolean"` } // String returns the string representation. @@ -10963,7 +11213,7 @@ type Event struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Event) String() string { +func (s EvaluatedExternalModel) String() string { return awsutil.Prettify(s) } @@ -10972,50 +11222,354 @@ func (s Event) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Event) GoString() string { +func (s EvaluatedExternalModel) GoString() string { return s.String() } -// SetCurrentLabel sets the CurrentLabel field's value. -func (s *Event) SetCurrentLabel(v string) *Event { - s.CurrentLabel = &v +// SetInputVariables sets the InputVariables field's value. +func (s *EvaluatedExternalModel) SetInputVariables(v map[string]*string) *EvaluatedExternalModel { + s.InputVariables = v return s } -// SetEntities sets the Entities field's value. -func (s *Event) SetEntities(v []*Entity) *Event { - s.Entities = v +// SetModelEndpoint sets the ModelEndpoint field's value. +func (s *EvaluatedExternalModel) SetModelEndpoint(v string) *EvaluatedExternalModel { + s.ModelEndpoint = &v return s } -// SetEventId sets the EventId field's value. -func (s *Event) SetEventId(v string) *Event { - s.EventId = &v +// SetOutputVariables sets the OutputVariables field's value. +func (s *EvaluatedExternalModel) SetOutputVariables(v map[string]*string) *EvaluatedExternalModel { + s.OutputVariables = v return s } -// SetEventTimestamp sets the EventTimestamp field's value. -func (s *Event) SetEventTimestamp(v string) *Event { - s.EventTimestamp = &v +// SetUseEventVariables sets the UseEventVariables field's value. +func (s *EvaluatedExternalModel) SetUseEventVariables(v bool) *EvaluatedExternalModel { + s.UseEventVariables = &v return s } -// SetEventTypeName sets the EventTypeName field's value. -func (s *Event) SetEventTypeName(v string) *Event { - s.EventTypeName = &v - return s -} +// The model version evaluated for generating prediction. +type EvaluatedModelVersion struct { + _ struct{} `type:"structure"` -// SetEventVariables sets the EventVariables field's value. -func (s *Event) SetEventVariables(v map[string]*string) *Event { - s.EventVariables = v - return s -} + // Evaluations generated for the model version. + Evaluations []*ModelVersionEvaluation `locationName:"evaluations" type:"list"` -// SetLabelTimestamp sets the LabelTimestamp field's value. -func (s *Event) SetLabelTimestamp(v string) *Event { - s.LabelTimestamp = &v - return s + // The model ID. + ModelId *string `locationName:"modelId" type:"string"` + + // The model type. + // + // Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS + ModelType *string `locationName:"modelType" type:"string"` + + // The model version. + ModelVersion *string `locationName:"modelVersion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluatedModelVersion) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluatedModelVersion) GoString() string { + return s.String() +} + +// SetEvaluations sets the Evaluations field's value. +func (s *EvaluatedModelVersion) SetEvaluations(v []*ModelVersionEvaluation) *EvaluatedModelVersion { + s.Evaluations = v + return s +} + +// SetModelId sets the ModelId field's value. +func (s *EvaluatedModelVersion) SetModelId(v string) *EvaluatedModelVersion { + s.ModelId = &v + return s +} + +// SetModelType sets the ModelType field's value. +func (s *EvaluatedModelVersion) SetModelType(v string) *EvaluatedModelVersion { + s.ModelType = &v + return s +} + +// SetModelVersion sets the ModelVersion field's value. +func (s *EvaluatedModelVersion) SetModelVersion(v string) *EvaluatedModelVersion { + s.ModelVersion = &v + return s +} + +// The details of the rule used for evaluating variable values. +type EvaluatedRule struct { + _ struct{} `type:"structure"` + + // Indicates whether the rule was evaluated. + Evaluated *bool `locationName:"evaluated" type:"boolean"` + + // The rule expression. + // + // Expression is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EvaluatedRule's + // String and GoString methods. + Expression *string `locationName:"expression" type:"string" sensitive:"true"` + + // The rule expression value. + // + // ExpressionWithValues is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EvaluatedRule's + // String and GoString methods. + ExpressionWithValues *string `locationName:"expressionWithValues" type:"string" sensitive:"true"` + + // Indicates whether the rule matched. + Matched *bool `locationName:"matched" type:"boolean"` + + // The rule outcome. + Outcomes []*string `locationName:"outcomes" type:"list"` + + // The rule ID. + RuleId *string `locationName:"ruleId" min:"1" type:"string"` + + // The rule version. + RuleVersion *string `locationName:"ruleVersion" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluatedRule) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluatedRule) GoString() string { + return s.String() +} + +// SetEvaluated sets the Evaluated field's value. +func (s *EvaluatedRule) SetEvaluated(v bool) *EvaluatedRule { + s.Evaluated = &v + return s +} + +// SetExpression sets the Expression field's value. +func (s *EvaluatedRule) SetExpression(v string) *EvaluatedRule { + s.Expression = &v + return s +} + +// SetExpressionWithValues sets the ExpressionWithValues field's value. +func (s *EvaluatedRule) SetExpressionWithValues(v string) *EvaluatedRule { + s.ExpressionWithValues = &v + return s +} + +// SetMatched sets the Matched field's value. +func (s *EvaluatedRule) SetMatched(v bool) *EvaluatedRule { + s.Matched = &v + return s +} + +// SetOutcomes sets the Outcomes field's value. +func (s *EvaluatedRule) SetOutcomes(v []*string) *EvaluatedRule { + s.Outcomes = v + return s +} + +// SetRuleId sets the RuleId field's value. +func (s *EvaluatedRule) SetRuleId(v string) *EvaluatedRule { + s.RuleId = &v + return s +} + +// SetRuleVersion sets the RuleVersion field's value. +func (s *EvaluatedRule) SetRuleVersion(v string) *EvaluatedRule { + s.RuleVersion = &v + return s +} + +// The event details. +type Event struct { + _ struct{} `type:"structure"` + + // The label associated with the event. + CurrentLabel *string `locationName:"currentLabel" type:"string"` + + // The event entities. + Entities []*Entity `locationName:"entities" type:"list"` + + // The event ID. + EventId *string `locationName:"eventId" type:"string"` + + // The timestamp that defines when the event under evaluation occurred. The + // timestamp must be specified using ISO 8601 standard in UTC. + EventTimestamp *string `locationName:"eventTimestamp" type:"string"` + + // The event type. + EventTypeName *string `locationName:"eventTypeName" type:"string"` + + // Names of the event type's variables you defined in Amazon Fraud Detector + // to represent data elements and their corresponding values for the event you + // are sending for evaluation. + EventVariables map[string]*string `locationName:"eventVariables" type:"map"` + + // The timestamp associated with the label to update. The timestamp must be + // specified using ISO 8601 standard in UTC. + LabelTimestamp *string `locationName:"labelTimestamp" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Event) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Event) GoString() string { + return s.String() +} + +// SetCurrentLabel sets the CurrentLabel field's value. +func (s *Event) SetCurrentLabel(v string) *Event { + s.CurrentLabel = &v + return s +} + +// SetEntities sets the Entities field's value. +func (s *Event) SetEntities(v []*Entity) *Event { + s.Entities = v + return s +} + +// SetEventId sets the EventId field's value. +func (s *Event) SetEventId(v string) *Event { + s.EventId = &v + return s +} + +// SetEventTimestamp sets the EventTimestamp field's value. +func (s *Event) SetEventTimestamp(v string) *Event { + s.EventTimestamp = &v + return s +} + +// SetEventTypeName sets the EventTypeName field's value. +func (s *Event) SetEventTypeName(v string) *Event { + s.EventTypeName = &v + return s +} + +// SetEventVariables sets the EventVariables field's value. +func (s *Event) SetEventVariables(v map[string]*string) *Event { + s.EventVariables = v + return s +} + +// SetLabelTimestamp sets the LabelTimestamp field's value. +func (s *Event) SetLabelTimestamp(v string) *Event { + s.LabelTimestamp = &v + return s +} + +// Information about the summary of an event prediction. +type EventPredictionSummary struct { + _ struct{} `type:"structure"` + + // The detector ID. + DetectorId *string `locationName:"detectorId" min:"1" type:"string"` + + // The detector version ID. + DetectorVersionId *string `locationName:"detectorVersionId" min:"1" type:"string"` + + // The event ID. + EventId *string `locationName:"eventId" min:"1" type:"string"` + + // The timestamp of the event. + EventTimestamp *string `locationName:"eventTimestamp" min:"11" type:"string"` + + // The event type. + EventTypeName *string `locationName:"eventTypeName" min:"1" type:"string"` + + // The timestamp when the prediction was generated. + PredictionTimestamp *string `locationName:"predictionTimestamp" min:"11" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventPredictionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventPredictionSummary) GoString() string { + return s.String() +} + +// SetDetectorId sets the DetectorId field's value. +func (s *EventPredictionSummary) SetDetectorId(v string) *EventPredictionSummary { + s.DetectorId = &v + return s +} + +// SetDetectorVersionId sets the DetectorVersionId field's value. +func (s *EventPredictionSummary) SetDetectorVersionId(v string) *EventPredictionSummary { + s.DetectorVersionId = &v + return s +} + +// SetEventId sets the EventId field's value. +func (s *EventPredictionSummary) SetEventId(v string) *EventPredictionSummary { + s.EventId = &v + return s +} + +// SetEventTimestamp sets the EventTimestamp field's value. +func (s *EventPredictionSummary) SetEventTimestamp(v string) *EventPredictionSummary { + s.EventTimestamp = &v + return s +} + +// SetEventTypeName sets the EventTypeName field's value. +func (s *EventPredictionSummary) SetEventTypeName(v string) *EventPredictionSummary { + s.EventTypeName = &v + return s +} + +// SetPredictionTimestamp sets the PredictionTimestamp field's value. +func (s *EventPredictionSummary) SetPredictionTimestamp(v string) *EventPredictionSummary { + s.PredictionTimestamp = &v + return s } // The event type details. @@ -11116,21 +11670,84 @@ func (s *EventType) SetIngestedEventStatistics(v *IngestedEventStatistics) *Even return s } -// SetLabels sets the Labels field's value. -func (s *EventType) SetLabels(v []*string) *EventType { - s.Labels = v +// SetLabels sets the Labels field's value. +func (s *EventType) SetLabels(v []*string) *EventType { + s.Labels = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *EventType) SetLastUpdatedTime(v string) *EventType { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *EventType) SetName(v string) *EventType { + s.Name = &v + return s +} + +// Information about the summary of an event variable that was evaluated for +// generating prediction. +type EventVariableSummary struct { + _ struct{} `type:"structure"` + + // The event variable name. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EventVariableSummary's + // String and GoString methods. + Name *string `locationName:"name" type:"string" sensitive:"true"` + + // The event variable source. + // + // Source is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EventVariableSummary's + // String and GoString methods. + Source *string `locationName:"source" type:"string" sensitive:"true"` + + // The value of the event variable. + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EventVariableSummary's + // String and GoString methods. + Value *string `locationName:"value" type:"string" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventVariableSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventVariableSummary) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *EventVariableSummary) SetName(v string) *EventVariableSummary { + s.Name = &v return s } -// SetLastUpdatedTime sets the LastUpdatedTime field's value. -func (s *EventType) SetLastUpdatedTime(v string) *EventType { - s.LastUpdatedTime = &v +// SetSource sets the Source field's value. +func (s *EventVariableSummary) SetSource(v string) *EventVariableSummary { + s.Source = &v return s } -// SetName sets the Name field's value. -func (s *EventType) SetName(v string) *EventType { - s.Name = &v +// SetValue sets the Value field's value. +func (s *EventVariableSummary) SetValue(v string) *EventVariableSummary { + s.Value = &v return s } @@ -11506,6 +12123,52 @@ func (s *FileValidationMessage) SetType(v string) *FileValidationMessage { return s } +// A conditional statement for filtering a list of past predictions. +type FilterCondition struct { + _ struct{} `type:"structure"` + + // A statement containing a resource property and a value to specify filter + // condition. + Value *string `locationName:"value" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FilterCondition) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FilterCondition) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FilterCondition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FilterCondition"} + if s.Value != nil && len(*s.Value) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Value", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetValue sets the Value field's value. +func (s *FilterCondition) SetValue(v string) *FilterCondition { + s.Value = &v + return s +} + type GetBatchImportJobsInput struct { _ struct{} `type:"structure"` @@ -12492,6 +13155,282 @@ func (s *GetEventPredictionInput) SetExternalModelEndpointDataBlobs(v map[string return s } +type GetEventPredictionMetadataInput struct { + _ struct{} `type:"structure"` + + // The detector ID. + // + // DetectorId is a required field + DetectorId *string `locationName:"detectorId" min:"1" type:"string" required:"true"` + + // The detector version ID. + // + // DetectorVersionId is a required field + DetectorVersionId *string `locationName:"detectorVersionId" min:"1" type:"string" required:"true"` + + // The event ID. + // + // EventId is a required field + EventId *string `locationName:"eventId" min:"1" type:"string" required:"true"` + + // The event type associated with the detector specified for the prediction. + // + // EventTypeName is a required field + EventTypeName *string `locationName:"eventTypeName" min:"1" type:"string" required:"true"` + + // The timestamp that defines when the prediction was generated. + // + // PredictionTimestamp is a required field + PredictionTimestamp *string `locationName:"predictionTimestamp" min:"11" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventPredictionMetadataInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventPredictionMetadataInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEventPredictionMetadataInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEventPredictionMetadataInput"} + if s.DetectorId == nil { + invalidParams.Add(request.NewErrParamRequired("DetectorId")) + } + if s.DetectorId != nil && len(*s.DetectorId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DetectorId", 1)) + } + if s.DetectorVersionId == nil { + invalidParams.Add(request.NewErrParamRequired("DetectorVersionId")) + } + if s.DetectorVersionId != nil && len(*s.DetectorVersionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DetectorVersionId", 1)) + } + if s.EventId == nil { + invalidParams.Add(request.NewErrParamRequired("EventId")) + } + if s.EventId != nil && len(*s.EventId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EventId", 1)) + } + if s.EventTypeName == nil { + invalidParams.Add(request.NewErrParamRequired("EventTypeName")) + } + if s.EventTypeName != nil && len(*s.EventTypeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EventTypeName", 1)) + } + if s.PredictionTimestamp == nil { + invalidParams.Add(request.NewErrParamRequired("PredictionTimestamp")) + } + if s.PredictionTimestamp != nil && len(*s.PredictionTimestamp) < 11 { + invalidParams.Add(request.NewErrParamMinLen("PredictionTimestamp", 11)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDetectorId sets the DetectorId field's value. +func (s *GetEventPredictionMetadataInput) SetDetectorId(v string) *GetEventPredictionMetadataInput { + s.DetectorId = &v + return s +} + +// SetDetectorVersionId sets the DetectorVersionId field's value. +func (s *GetEventPredictionMetadataInput) SetDetectorVersionId(v string) *GetEventPredictionMetadataInput { + s.DetectorVersionId = &v + return s +} + +// SetEventId sets the EventId field's value. +func (s *GetEventPredictionMetadataInput) SetEventId(v string) *GetEventPredictionMetadataInput { + s.EventId = &v + return s +} + +// SetEventTypeName sets the EventTypeName field's value. +func (s *GetEventPredictionMetadataInput) SetEventTypeName(v string) *GetEventPredictionMetadataInput { + s.EventTypeName = &v + return s +} + +// SetPredictionTimestamp sets the PredictionTimestamp field's value. +func (s *GetEventPredictionMetadataInput) SetPredictionTimestamp(v string) *GetEventPredictionMetadataInput { + s.PredictionTimestamp = &v + return s +} + +type GetEventPredictionMetadataOutput struct { + _ struct{} `type:"structure"` + + // The detector ID. + DetectorId *string `locationName:"detectorId" min:"1" type:"string"` + + // The detector version ID. + DetectorVersionId *string `locationName:"detectorVersionId" min:"1" type:"string"` + + // The status of the detector version. + DetectorVersionStatus *string `locationName:"detectorVersionStatus" type:"string"` + + // The entity ID. + EntityId *string `locationName:"entityId" type:"string"` + + // The entity type. + EntityType *string `locationName:"entityType" type:"string"` + + // External (Amazon SageMaker) models that were evaluated for generating predictions. + EvaluatedExternalModels []*EvaluatedExternalModel `locationName:"evaluatedExternalModels" type:"list"` + + // Model versions that were evaluated for generating predictions. + EvaluatedModelVersions []*EvaluatedModelVersion `locationName:"evaluatedModelVersions" type:"list"` + + // The event ID. + EventId *string `locationName:"eventId" min:"1" type:"string"` + + // The timestamp for when the prediction was generated for the associated event + // ID. + EventTimestamp *string `locationName:"eventTimestamp" min:"11" type:"string"` + + // The event type associated with the detector specified for this prediction. + EventTypeName *string `locationName:"eventTypeName" min:"1" type:"string"` + + // A list of event variables that influenced the prediction scores. + EventVariables []*EventVariableSummary `locationName:"eventVariables" type:"list"` + + // The outcomes of the matched rule, based on the rule execution mode. + Outcomes []*string `locationName:"outcomes" type:"list"` + + // The timestamp that defines when the prediction was generated. + PredictionTimestamp *string `locationName:"predictionTimestamp" min:"11" type:"string"` + + // The execution mode of the rule used for evaluating variable values. + RuleExecutionMode *string `locationName:"ruleExecutionMode" type:"string" enum:"RuleExecutionMode"` + + // List of rules associated with the detector version that were used for evaluating + // variable values. + Rules []*EvaluatedRule `locationName:"rules" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventPredictionMetadataOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventPredictionMetadataOutput) GoString() string { + return s.String() +} + +// SetDetectorId sets the DetectorId field's value. +func (s *GetEventPredictionMetadataOutput) SetDetectorId(v string) *GetEventPredictionMetadataOutput { + s.DetectorId = &v + return s +} + +// SetDetectorVersionId sets the DetectorVersionId field's value. +func (s *GetEventPredictionMetadataOutput) SetDetectorVersionId(v string) *GetEventPredictionMetadataOutput { + s.DetectorVersionId = &v + return s +} + +// SetDetectorVersionStatus sets the DetectorVersionStatus field's value. +func (s *GetEventPredictionMetadataOutput) SetDetectorVersionStatus(v string) *GetEventPredictionMetadataOutput { + s.DetectorVersionStatus = &v + return s +} + +// SetEntityId sets the EntityId field's value. +func (s *GetEventPredictionMetadataOutput) SetEntityId(v string) *GetEventPredictionMetadataOutput { + s.EntityId = &v + return s +} + +// SetEntityType sets the EntityType field's value. +func (s *GetEventPredictionMetadataOutput) SetEntityType(v string) *GetEventPredictionMetadataOutput { + s.EntityType = &v + return s +} + +// SetEvaluatedExternalModels sets the EvaluatedExternalModels field's value. +func (s *GetEventPredictionMetadataOutput) SetEvaluatedExternalModels(v []*EvaluatedExternalModel) *GetEventPredictionMetadataOutput { + s.EvaluatedExternalModels = v + return s +} + +// SetEvaluatedModelVersions sets the EvaluatedModelVersions field's value. +func (s *GetEventPredictionMetadataOutput) SetEvaluatedModelVersions(v []*EvaluatedModelVersion) *GetEventPredictionMetadataOutput { + s.EvaluatedModelVersions = v + return s +} + +// SetEventId sets the EventId field's value. +func (s *GetEventPredictionMetadataOutput) SetEventId(v string) *GetEventPredictionMetadataOutput { + s.EventId = &v + return s +} + +// SetEventTimestamp sets the EventTimestamp field's value. +func (s *GetEventPredictionMetadataOutput) SetEventTimestamp(v string) *GetEventPredictionMetadataOutput { + s.EventTimestamp = &v + return s +} + +// SetEventTypeName sets the EventTypeName field's value. +func (s *GetEventPredictionMetadataOutput) SetEventTypeName(v string) *GetEventPredictionMetadataOutput { + s.EventTypeName = &v + return s +} + +// SetEventVariables sets the EventVariables field's value. +func (s *GetEventPredictionMetadataOutput) SetEventVariables(v []*EventVariableSummary) *GetEventPredictionMetadataOutput { + s.EventVariables = v + return s +} + +// SetOutcomes sets the Outcomes field's value. +func (s *GetEventPredictionMetadataOutput) SetOutcomes(v []*string) *GetEventPredictionMetadataOutput { + s.Outcomes = v + return s +} + +// SetPredictionTimestamp sets the PredictionTimestamp field's value. +func (s *GetEventPredictionMetadataOutput) SetPredictionTimestamp(v string) *GetEventPredictionMetadataOutput { + s.PredictionTimestamp = &v + return s +} + +// SetRuleExecutionMode sets the RuleExecutionMode field's value. +func (s *GetEventPredictionMetadataOutput) SetRuleExecutionMode(v string) *GetEventPredictionMetadataOutput { + s.RuleExecutionMode = &v + return s +} + +// SetRules sets the Rules field's value. +func (s *GetEventPredictionMetadataOutput) SetRules(v []*EvaluatedRule) *GetEventPredictionMetadataOutput { + s.Rules = v + return s +} + type GetEventPredictionOutput struct { _ struct{} `type:"structure"` @@ -13983,6 +14922,173 @@ func (s *LabelSchema) SetUnlabeledEventsTreatment(v string) *LabelSchema { return s } +type ListEventPredictionsInput struct { + _ struct{} `type:"structure"` + + // The detector ID. + DetectorId *FilterCondition `locationName:"detectorId" type:"structure"` + + // The detector version ID. + DetectorVersionId *FilterCondition `locationName:"detectorVersionId" type:"structure"` + + // The event ID. + EventId *FilterCondition `locationName:"eventId" type:"structure"` + + // The event type associated with the detector. + EventType *FilterCondition `locationName:"eventType" type:"structure"` + + // The maximum number of predictions to return for the request. + MaxResults *int64 `locationName:"maxResults" min:"50" type:"integer"` + + // Identifies the next page of results to return. Use the token to make the + // call again to retrieve the next page. Keep all other arguments unchanged. + // Each pagination token expires after 24 hours. + NextToken *string `locationName:"nextToken" type:"string"` + + // The time period for when the predictions were generated. + PredictionTimeRange *PredictionTimeRange `locationName:"predictionTimeRange" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventPredictionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventPredictionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEventPredictionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEventPredictionsInput"} + if s.MaxResults != nil && *s.MaxResults < 50 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 50)) + } + if s.DetectorId != nil { + if err := s.DetectorId.Validate(); err != nil { + invalidParams.AddNested("DetectorId", err.(request.ErrInvalidParams)) + } + } + if s.DetectorVersionId != nil { + if err := s.DetectorVersionId.Validate(); err != nil { + invalidParams.AddNested("DetectorVersionId", err.(request.ErrInvalidParams)) + } + } + if s.EventId != nil { + if err := s.EventId.Validate(); err != nil { + invalidParams.AddNested("EventId", err.(request.ErrInvalidParams)) + } + } + if s.EventType != nil { + if err := s.EventType.Validate(); err != nil { + invalidParams.AddNested("EventType", err.(request.ErrInvalidParams)) + } + } + if s.PredictionTimeRange != nil { + if err := s.PredictionTimeRange.Validate(); err != nil { + invalidParams.AddNested("PredictionTimeRange", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDetectorId sets the DetectorId field's value. +func (s *ListEventPredictionsInput) SetDetectorId(v *FilterCondition) *ListEventPredictionsInput { + s.DetectorId = v + return s +} + +// SetDetectorVersionId sets the DetectorVersionId field's value. +func (s *ListEventPredictionsInput) SetDetectorVersionId(v *FilterCondition) *ListEventPredictionsInput { + s.DetectorVersionId = v + return s +} + +// SetEventId sets the EventId field's value. +func (s *ListEventPredictionsInput) SetEventId(v *FilterCondition) *ListEventPredictionsInput { + s.EventId = v + return s +} + +// SetEventType sets the EventType field's value. +func (s *ListEventPredictionsInput) SetEventType(v *FilterCondition) *ListEventPredictionsInput { + s.EventType = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEventPredictionsInput) SetMaxResults(v int64) *ListEventPredictionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventPredictionsInput) SetNextToken(v string) *ListEventPredictionsInput { + s.NextToken = &v + return s +} + +// SetPredictionTimeRange sets the PredictionTimeRange field's value. +func (s *ListEventPredictionsInput) SetPredictionTimeRange(v *PredictionTimeRange) *ListEventPredictionsInput { + s.PredictionTimeRange = v + return s +} + +type ListEventPredictionsOutput struct { + _ struct{} `type:"structure"` + + // The summary of the past predictions. + EventPredictionSummaries []*EventPredictionSummary `locationName:"eventPredictionSummaries" type:"list"` + + // Identifies the next page of results to return. Use the token to make the + // call again to retrieve the next page. Keep all other arguments unchanged. + // Each pagination token expires after 24 hours. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventPredictionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventPredictionsOutput) GoString() string { + return s.String() +} + +// SetEventPredictionSummaries sets the EventPredictionSummaries field's value. +func (s *ListEventPredictionsOutput) SetEventPredictionSummaries(v []*EventPredictionSummary) *ListEventPredictionsOutput { + s.EventPredictionSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventPredictionsOutput) SetNextToken(v string) *ListEventPredictionsOutput { + s.NextToken = &v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure"` @@ -14788,6 +15894,56 @@ func (s *ModelVersionDetail) SetTrainingResult(v *TrainingResult) *ModelVersionD return s } +// The model version evalutions. +type ModelVersionEvaluation struct { + _ struct{} `type:"structure"` + + // The evaluation score generated for the model version. + EvaluationScore *string `locationName:"evaluationScore" type:"string"` + + // The output variable name. + OutputVariableName *string `locationName:"outputVariableName" type:"string"` + + // The prediction explanations generated for the model version. + PredictionExplanations *PredictionExplanations `locationName:"predictionExplanations" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModelVersionEvaluation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ModelVersionEvaluation) GoString() string { + return s.String() +} + +// SetEvaluationScore sets the EvaluationScore field's value. +func (s *ModelVersionEvaluation) SetEvaluationScore(v string) *ModelVersionEvaluation { + s.EvaluationScore = &v + return s +} + +// SetOutputVariableName sets the OutputVariableName field's value. +func (s *ModelVersionEvaluation) SetOutputVariableName(v string) *ModelVersionEvaluation { + s.OutputVariableName = &v + return s +} + +// SetPredictionExplanations sets the PredictionExplanations field's value. +func (s *ModelVersionEvaluation) SetPredictionExplanations(v *PredictionExplanations) *ModelVersionEvaluation { + s.PredictionExplanations = v + return s +} + // The outcome. type Outcome struct { _ struct{} `type:"structure"` @@ -14856,6 +16012,106 @@ func (s *Outcome) SetName(v string) *Outcome { return s } +// The prediction explanations that provide insight into how each event variable +// impacted the model version's fraud prediction score. +type PredictionExplanations struct { + _ struct{} `type:"structure"` + + // The details of the event variable's impact on the prediction score. + VariableImpactExplanations []*VariableImpactExplanation `locationName:"variableImpactExplanations" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PredictionExplanations) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PredictionExplanations) GoString() string { + return s.String() +} + +// SetVariableImpactExplanations sets the VariableImpactExplanations field's value. +func (s *PredictionExplanations) SetVariableImpactExplanations(v []*VariableImpactExplanation) *PredictionExplanations { + s.VariableImpactExplanations = v + return s +} + +// The time period for when the predictions were generated. +type PredictionTimeRange struct { + _ struct{} `type:"structure"` + + // The end time of the time period for when the predictions were generated. + // + // EndTime is a required field + EndTime *string `locationName:"endTime" min:"11" type:"string" required:"true"` + + // The start time of the time period for when the predictions were generated. + // + // StartTime is a required field + StartTime *string `locationName:"startTime" min:"11" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PredictionTimeRange) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PredictionTimeRange) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PredictionTimeRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PredictionTimeRange"} + if s.EndTime == nil { + invalidParams.Add(request.NewErrParamRequired("EndTime")) + } + if s.EndTime != nil && len(*s.EndTime) < 11 { + invalidParams.Add(request.NewErrParamMinLen("EndTime", 11)) + } + if s.StartTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartTime")) + } + if s.StartTime != nil && len(*s.StartTime) < 11 { + invalidParams.Add(request.NewErrParamMinLen("StartTime", 11)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndTime sets the EndTime field's value. +func (s *PredictionTimeRange) SetEndTime(v string) *PredictionTimeRange { + s.EndTime = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *PredictionTimeRange) SetStartTime(v string) *PredictionTimeRange { + s.StartTime = &v + return s +} + type PutDetectorInput struct { _ struct{} `type:"structure"` @@ -18205,6 +19461,64 @@ func (s *VariableEntry) SetVariableType(v string) *VariableEntry { return s } +// The details of the event variable's impact on the prediction score. +type VariableImpactExplanation struct { + _ struct{} `type:"structure"` + + // The event variable name. + EventVariableName *string `locationName:"eventVariableName" type:"string"` + + // The raw, uninterpreted value represented as log-odds of the fraud. These + // values are usually between -10 to +10, but range from - infinity to + infinity. + // + // * A positive value indicates that the variable drove the risk score up. + // + // * A negative value indicates that the variable drove the risk score down. + LogOddsImpact *float64 `locationName:"logOddsImpact" type:"float"` + + // The event variable's relative impact in terms of magnitude on the prediction + // scores. The relative impact values consist of a numerical rating (0-5, 5 + // being the highest) and direction (increased/decreased) impact of the fraud + // risk. + RelativeImpact *string `locationName:"relativeImpact" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VariableImpactExplanation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VariableImpactExplanation) GoString() string { + return s.String() +} + +// SetEventVariableName sets the EventVariableName field's value. +func (s *VariableImpactExplanation) SetEventVariableName(v string) *VariableImpactExplanation { + s.EventVariableName = &v + return s +} + +// SetLogOddsImpact sets the LogOddsImpact field's value. +func (s *VariableImpactExplanation) SetLogOddsImpact(v float64) *VariableImpactExplanation { + s.LogOddsImpact = &v + return s +} + +// SetRelativeImpact sets the RelativeImpact field's value. +func (s *VariableImpactExplanation) SetRelativeImpact(v string) *VariableImpactExplanation { + s.RelativeImpact = &v + return s +} + // The variable importance metrics details. type VariableImportanceMetrics struct { _ struct{} `type:"structure"` diff --git a/service/frauddetector/frauddetectoriface/interface.go b/service/frauddetector/frauddetectoriface/interface.go index 9654a3897b..227b265974 100644 --- a/service/frauddetector/frauddetectoriface/interface.go +++ b/service/frauddetector/frauddetectoriface/interface.go @@ -219,6 +219,10 @@ type FraudDetectorAPI interface { GetEventPredictionWithContext(aws.Context, *frauddetector.GetEventPredictionInput, ...request.Option) (*frauddetector.GetEventPredictionOutput, error) GetEventPredictionRequest(*frauddetector.GetEventPredictionInput) (*request.Request, *frauddetector.GetEventPredictionOutput) + GetEventPredictionMetadata(*frauddetector.GetEventPredictionMetadataInput) (*frauddetector.GetEventPredictionMetadataOutput, error) + GetEventPredictionMetadataWithContext(aws.Context, *frauddetector.GetEventPredictionMetadataInput, ...request.Option) (*frauddetector.GetEventPredictionMetadataOutput, error) + GetEventPredictionMetadataRequest(*frauddetector.GetEventPredictionMetadataInput) (*request.Request, *frauddetector.GetEventPredictionMetadataOutput) + GetEventTypes(*frauddetector.GetEventTypesInput) (*frauddetector.GetEventTypesOutput, error) GetEventTypesWithContext(aws.Context, *frauddetector.GetEventTypesInput, ...request.Option) (*frauddetector.GetEventTypesOutput, error) GetEventTypesRequest(*frauddetector.GetEventTypesInput) (*request.Request, *frauddetector.GetEventTypesOutput) @@ -276,6 +280,13 @@ type FraudDetectorAPI interface { GetVariablesPages(*frauddetector.GetVariablesInput, func(*frauddetector.GetVariablesOutput, bool) bool) error GetVariablesPagesWithContext(aws.Context, *frauddetector.GetVariablesInput, func(*frauddetector.GetVariablesOutput, bool) bool, ...request.Option) error + ListEventPredictions(*frauddetector.ListEventPredictionsInput) (*frauddetector.ListEventPredictionsOutput, error) + ListEventPredictionsWithContext(aws.Context, *frauddetector.ListEventPredictionsInput, ...request.Option) (*frauddetector.ListEventPredictionsOutput, error) + ListEventPredictionsRequest(*frauddetector.ListEventPredictionsInput) (*request.Request, *frauddetector.ListEventPredictionsOutput) + + ListEventPredictionsPages(*frauddetector.ListEventPredictionsInput, func(*frauddetector.ListEventPredictionsOutput, bool) bool) error + ListEventPredictionsPagesWithContext(aws.Context, *frauddetector.ListEventPredictionsInput, func(*frauddetector.ListEventPredictionsOutput, bool) bool, ...request.Option) error + ListTagsForResource(*frauddetector.ListTagsForResourceInput) (*frauddetector.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *frauddetector.ListTagsForResourceInput, ...request.Option) (*frauddetector.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*frauddetector.ListTagsForResourceInput) (*request.Request, *frauddetector.ListTagsForResourceOutput) diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index ece2f2e89d..8317150b0c 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -21631,16 +21631,16 @@ func (c *SageMaker) StopPipelineExecutionRequest(input *StopPipelineExecutionInp // // A pipeline execution won't stop while a callback step is running. When you // call StopPipelineExecution on a pipeline execution with a running callback -// step, Amazon SageMaker Pipelines sends an additional Amazon SQS message to -// the specified SQS queue. The body of the SQS message contains a "Status" -// field which is set to "Stopping". +// step, SageMaker Pipelines sends an additional Amazon SQS message to the specified +// SQS queue. The body of the SQS message contains a "Status" field which is +// set to "Stopping". // // You should add logic to your Amazon SQS message consumer to take any needed // action (for example, resource cleanup) upon receipt of the message followed // by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure. // -// Only when Amazon SageMaker Pipelines receives one of these calls will it -// stop the pipeline execution. +// Only when SageMaker Pipelines receives one of these calls will it stop the +// pipeline execution. // // Lambda Step // @@ -32517,7 +32517,7 @@ type CreateEndpointConfigInput struct { // Specifies configuration for how an endpoint performs asynchronous inference. // This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync - // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html). + // (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html). AsyncInferenceConfig *AsyncInferenceConfig `type:"structure"` DataCaptureConfig *DataCaptureConfig `type:"structure"` @@ -55389,6 +55389,39 @@ func (s *Explainability) SetReport(v *MetricsSource) *Explainability { return s } +// The container for the metadata for Fail step. +type FailStepMetadata struct { + _ struct{} `type:"structure"` + + // A message that you define and then is processed and rendered by the Fail + // step when the error occurs. + ErrorMessage *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailStepMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailStepMetadata) GoString() string { + return s.String() +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *FailStepMetadata) SetErrorMessage(v string) *FailStepMetadata { + s.ErrorMessage = &v + return s +} + // A list of features. You must include FeatureName and FeatureType. Valid feature // FeatureTypes are Integral, Fractional and String. type FeatureDefinition struct { @@ -66921,12 +66954,13 @@ type ListModelPackagesInput struct { // group. ModelPackageGroupName *string `min:"1" type:"string"` - // A filter that returns onlyl the model packages of the specified type. This + // A filter that returns only the model packages of the specified type. This // can be one of the following values. // - // * VERSIONED - List only versioned models. + // * UNVERSIONED - List only unversioined models. This is the default value + // if no ModelPackageType is specified. // - // * UNVERSIONED - List only unversioined models. + // * VERSIONED - List only versioned models. // // * BOTH - List both versioned and unversioned models. ModelPackageType *string `type:"string" enum:"ModelPackageType"` @@ -77422,7 +77456,7 @@ type PipelineExecutionStep struct { _ struct{} `type:"structure"` // The current attempt of the execution step. For more information, see Retry - // Policy for Amazon SageMaker Pipelines steps (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html). + // Policy for SageMaker Pipelines steps (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html). AttemptCount *int64 `type:"integer"` // If this pipeline execution step was cached, details on the cache hit. @@ -77568,6 +77602,9 @@ type PipelineExecutionStepMetadata struct { // The configurations and outcomes of an EMR step execution. EMR *EMRStepMetadata `type:"structure"` + // The configurations and outcomes of a Fail step execution. + Fail *FailStepMetadata `type:"structure"` + // The Amazon Resource Name (ARN) of the Lambda function that was run by this // step execution and a list of output parameters. Lambda *LambdaStepMetadata `type:"structure"` @@ -77660,6 +77697,12 @@ func (s *PipelineExecutionStepMetadata) SetEMR(v *EMRStepMetadata) *PipelineExec return s } +// SetFail sets the Fail field's value. +func (s *PipelineExecutionStepMetadata) SetFail(v *FailStepMetadata) *PipelineExecutionStepMetadata { + s.Fail = v + return s +} + // SetLambda sets the Lambda field's value. func (s *PipelineExecutionStepMetadata) SetLambda(v *LambdaStepMetadata) *PipelineExecutionStepMetadata { s.Lambda = v @@ -77721,6 +77764,10 @@ type PipelineExecutionSummary struct { // The display name of the pipeline execution. PipelineExecutionDisplayName *string `min:"1" type:"string"` + // A message generated by SageMaker Pipelines describing why the pipeline execution + // failed. + PipelineExecutionFailureReason *string `type:"string"` + // The status of the pipeline execution. PipelineExecutionStatus *string `type:"string" enum:"PipelineExecutionStatus"` @@ -77764,6 +77811,12 @@ func (s *PipelineExecutionSummary) SetPipelineExecutionDisplayName(v string) *Pi return s } +// SetPipelineExecutionFailureReason sets the PipelineExecutionFailureReason field's value. +func (s *PipelineExecutionSummary) SetPipelineExecutionFailureReason(v string) *PipelineExecutionSummary { + s.PipelineExecutionFailureReason = &v + return s +} + // SetPipelineExecutionStatus sets the PipelineExecutionStatus field's value. func (s *PipelineExecutionSummary) SetPipelineExecutionStatus(v string) *PipelineExecutionSummary { s.PipelineExecutionStatus = &v diff --git a/service/securityhub/api.go b/service/securityhub/api.go index 8fb20b2ffd..5e89170668 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -28195,6 +28195,9 @@ type AwsSecurityFinding struct { // Resources is a required field Resources []*Resource `type:"list" required:"true"` + // Indicates whether the finding is a sample finding. + Sample *bool `type:"boolean"` + // The schema version that a finding is formatted for. // // SchemaVersion is a required field @@ -28530,6 +28533,12 @@ func (s *AwsSecurityFinding) SetResources(v []*Resource) *AwsSecurityFinding { return s } +// SetSample sets the Sample field's value. +func (s *AwsSecurityFinding) SetSample(v bool) *AwsSecurityFinding { + s.Sample = &v + return s +} + // SetSchemaVersion sets the SchemaVersion field's value. func (s *AwsSecurityFinding) SetSchemaVersion(v string) *AwsSecurityFinding { s.SchemaVersion = &v @@ -28891,6 +28900,9 @@ type AwsSecurityFindingFilters struct { // Specifies the type of the resource that details are provided for. ResourceType []*StringFilter `type:"list"` + // Indicates whether or not sample findings are included in the filter results. + Sample []*BooleanFilter `type:"list"` + // The label of a finding's severity. SeverityLabel []*StringFilter `type:"list"` @@ -29459,6 +29471,12 @@ func (s *AwsSecurityFindingFilters) SetResourceType(v []*StringFilter) *AwsSecur return s } +// SetSample sets the Sample field's value. +func (s *AwsSecurityFindingFilters) SetSample(v []*BooleanFilter) *AwsSecurityFindingFilters { + s.Sample = v + return s +} + // SetSeverityLabel sets the SeverityLabel field's value. func (s *AwsSecurityFindingFilters) SetSeverityLabel(v []*StringFilter) *AwsSecurityFindingFilters { s.SeverityLabel = v @@ -31125,6 +31143,38 @@ func (s *BatchUpdateFindingsUnprocessedFinding) SetFindingIdentifier(v *AwsSecur return s } +// Boolean filter for querying findings. +type BooleanFilter struct { + _ struct{} `type:"structure"` + + // The value of the boolean. + Value *bool `type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BooleanFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BooleanFilter) GoString() string { + return s.String() +} + +// SetValue sets the Value field's value. +func (s *BooleanFilter) SetValue(v bool) *BooleanFilter { + s.Value = &v + return s +} + // An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated // value (CSV) file, or tab-separated value (TSV) file. type Cell struct {