UNPKG

universal-s3

Version:

Universal S3 SDK for JavaScript, available for Node.js backends

1,252 lines 29.7 kB
{ "version": "2.0", "metadata": { "apiVersion": "2018-05-22", "endpointPrefix": "personalize", "jsonVersion": "1.1", "protocol": "json", "serviceFullName": "Amazon Personalize", "serviceId": "Personalize", "signatureVersion": "v4", "signingName": "personalize", "targetPrefix": "AmazonPersonalize", "uid": "personalize-2018-05-22" }, "operations": { "CreateCampaign": { "input": { "type": "structure", "required": [ "name", "solutionVersionArn", "minProvisionedTPS" ], "members": { "name": {}, "solutionVersionArn": {}, "minProvisionedTPS": { "type": "integer" } } }, "output": { "type": "structure", "members": { "campaignArn": {} } }, "idempotent": true }, "CreateDataset": { "input": { "type": "structure", "required": [ "name", "schemaArn", "datasetGroupArn", "datasetType" ], "members": { "name": {}, "schemaArn": {}, "datasetGroupArn": {}, "datasetType": {} } }, "output": { "type": "structure", "members": { "datasetArn": {} } }, "idempotent": true }, "CreateDatasetGroup": { "input": { "type": "structure", "required": [ "name" ], "members": { "name": {}, "roleArn": {}, "kmsKeyArn": {} } }, "output": { "type": "structure", "members": { "datasetGroupArn": {} } } }, "CreateDatasetImportJob": { "input": { "type": "structure", "required": [ "jobName", "datasetArn", "dataSource", "roleArn" ], "members": { "jobName": {}, "datasetArn": {}, "dataSource": { "shape": "Se" }, "roleArn": {} } }, "output": { "type": "structure", "members": { "datasetImportJobArn": {} } } }, "CreateEventTracker": { "input": { "type": "structure", "required": [ "name", "datasetGroupArn" ], "members": { "name": {}, "datasetGroupArn": {} } }, "output": { "type": "structure", "members": { "eventTrackerArn": {}, "trackingId": {} } }, "idempotent": true }, "CreateSchema": { "input": { "type": "structure", "required": [ "name", "schema" ], "members": { "name": {}, "schema": {} } }, "output": { "type": "structure", "members": { "schemaArn": {} } }, "idempotent": true }, "CreateSolution": { "input": { "type": "structure", "required": [ "name", "datasetGroupArn" ], "members": { "name": {}, "performHPO": { "type": "boolean" }, "performAutoML": { "type": "boolean" }, "recipeArn": {}, "datasetGroupArn": {}, "eventType": {}, "solutionConfig": { "shape": "Sr" } } }, "output": { "type": "structure", "members": { "solutionArn": {} } } }, "CreateSolutionVersion": { "input": { "type": "structure", "required": [ "solutionArn" ], "members": { "solutionArn": {}, "trainingMode": {} } }, "output": { "type": "structure", "members": { "solutionVersionArn": {} } } }, "DeleteCampaign": { "input": { "type": "structure", "required": [ "campaignArn" ], "members": { "campaignArn": {} } }, "idempotent": true }, "DeleteDataset": { "input": { "type": "structure", "required": [ "datasetArn" ], "members": { "datasetArn": {} } }, "idempotent": true }, "DeleteDatasetGroup": { "input": { "type": "structure", "required": [ "datasetGroupArn" ], "members": { "datasetGroupArn": {} } }, "idempotent": true }, "DeleteEventTracker": { "input": { "type": "structure", "required": [ "eventTrackerArn" ], "members": { "eventTrackerArn": {} } }, "idempotent": true }, "DeleteSchema": { "input": { "type": "structure", "required": [ "schemaArn" ], "members": { "schemaArn": {} } }, "idempotent": true }, "DeleteSolution": { "input": { "type": "structure", "required": [ "solutionArn" ], "members": { "solutionArn": {} } }, "idempotent": true }, "DescribeAlgorithm": { "input": { "type": "structure", "required": [ "algorithmArn" ], "members": { "algorithmArn": {} } }, "output": { "type": "structure", "members": { "algorithm": { "type": "structure", "members": { "name": {}, "algorithmArn": {}, "algorithmImage": { "type": "structure", "required": [ "dockerURI" ], "members": { "name": {}, "dockerURI": {} } }, "defaultHyperParameters": { "shape": "S1e" }, "defaultHyperParameterRanges": { "type": "structure", "members": { "integerHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "minValue": { "type": "integer" }, "maxValue": { "type": "integer" }, "isTunable": { "type": "boolean" } } } }, "continuousHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "minValue": { "type": "double" }, "maxValue": { "type": "double" }, "isTunable": { "type": "boolean" } } } }, "categoricalHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "values": { "shape": "S1c" }, "isTunable": { "type": "boolean" } } } } } }, "defaultResourceConfig": { "type": "map", "key": {}, "value": {} }, "trainingInputMode": {}, "roleArn": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "DescribeCampaign": { "input": { "type": "structure", "required": [ "campaignArn" ], "members": { "campaignArn": {} } }, "output": { "type": "structure", "members": { "campaign": { "type": "structure", "members": { "name": {}, "campaignArn": {}, "solutionVersionArn": {}, "minProvisionedTPS": { "type": "integer" }, "status": {}, "failureReason": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "latestCampaignUpdate": { "type": "structure", "members": { "solutionVersionArn": {}, "minProvisionedTPS": { "type": "integer" }, "status": {}, "failureReason": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } } } }, "idempotent": true }, "DescribeDataset": { "input": { "type": "structure", "required": [ "datasetArn" ], "members": { "datasetArn": {} } }, "output": { "type": "structure", "members": { "dataset": { "type": "structure", "members": { "name": {}, "datasetArn": {}, "datasetGroupArn": {}, "datasetType": {}, "schemaArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "DescribeDatasetGroup": { "input": { "type": "structure", "required": [ "datasetGroupArn" ], "members": { "datasetGroupArn": {} } }, "output": { "type": "structure", "members": { "datasetGroup": { "type": "structure", "members": { "name": {}, "datasetGroupArn": {}, "status": {}, "roleArn": {}, "kmsKeyArn": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } } }, "idempotent": true }, "DescribeDatasetImportJob": { "input": { "type": "structure", "required": [ "datasetImportJobArn" ], "members": { "datasetImportJobArn": {} } }, "output": { "type": "structure", "members": { "datasetImportJob": { "type": "structure", "members": { "jobName": {}, "datasetImportJobArn": {}, "datasetArn": {}, "dataSource": { "shape": "Se" }, "roleArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } } }, "idempotent": true }, "DescribeEventTracker": { "input": { "type": "structure", "required": [ "eventTrackerArn" ], "members": { "eventTrackerArn": {} } }, "output": { "type": "structure", "members": { "eventTracker": { "type": "structure", "members": { "name": {}, "eventTrackerArn": {}, "accountId": {}, "trackingId": {}, "datasetGroupArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "DescribeFeatureTransformation": { "input": { "type": "structure", "required": [ "featureTransformationArn" ], "members": { "featureTransformationArn": {} } }, "output": { "type": "structure", "members": { "featureTransformation": { "type": "structure", "members": { "name": {}, "featureTransformationArn": {}, "defaultParameters": { "type": "map", "key": {}, "value": {} }, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "status": {} } } } }, "idempotent": true }, "DescribeRecipe": { "input": { "type": "structure", "required": [ "recipeArn" ], "members": { "recipeArn": {} } }, "output": { "type": "structure", "members": { "recipe": { "type": "structure", "members": { "name": {}, "recipeArn": {}, "algorithmArn": {}, "featureTransformationArn": {}, "status": {}, "description": {}, "creationDateTime": { "type": "timestamp" }, "recipeType": {}, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "DescribeSchema": { "input": { "type": "structure", "required": [ "schemaArn" ], "members": { "schemaArn": {} } }, "output": { "type": "structure", "members": { "schema": { "type": "structure", "members": { "name": {}, "schemaArn": {}, "schema": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "DescribeSolution": { "input": { "type": "structure", "required": [ "solutionArn" ], "members": { "solutionArn": {} } }, "output": { "type": "structure", "members": { "solution": { "type": "structure", "members": { "name": {}, "solutionArn": {}, "performHPO": { "type": "boolean" }, "performAutoML": { "type": "boolean" }, "recipeArn": {}, "datasetGroupArn": {}, "eventType": {}, "solutionConfig": { "shape": "Sr" }, "autoMLResult": { "type": "structure", "members": { "bestRecipeArn": {} } }, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "latestSolutionVersion": { "shape": "S39" } } } } }, "idempotent": true }, "DescribeSolutionVersion": { "input": { "type": "structure", "required": [ "solutionVersionArn" ], "members": { "solutionVersionArn": {} } }, "output": { "type": "structure", "members": { "solutionVersion": { "type": "structure", "members": { "solutionVersionArn": {}, "solutionArn": {}, "performHPO": { "type": "boolean" }, "performAutoML": { "type": "boolean" }, "recipeArn": {}, "eventType": {}, "datasetGroupArn": {}, "solutionConfig": { "shape": "Sr" }, "trainingHours": { "type": "double" }, "trainingMode": {}, "status": {}, "failureReason": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } } }, "idempotent": true }, "GetSolutionMetrics": { "input": { "type": "structure", "required": [ "solutionVersionArn" ], "members": { "solutionVersionArn": {} } }, "output": { "type": "structure", "members": { "solutionVersionArn": {}, "metrics": { "type": "map", "key": {}, "value": { "type": "double" } } } } }, "ListCampaigns": { "input": { "type": "structure", "members": { "solutionArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "campaigns": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "campaignArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } }, "nextToken": {} } }, "idempotent": true }, "ListDatasetGroups": { "input": { "type": "structure", "members": { "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "datasetGroups": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "datasetGroupArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } }, "nextToken": {} } }, "idempotent": true }, "ListDatasetImportJobs": { "input": { "type": "structure", "members": { "datasetArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "datasetImportJobs": { "type": "list", "member": { "type": "structure", "members": { "datasetImportJobArn": {}, "jobName": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } }, "nextToken": {} } }, "idempotent": true }, "ListDatasets": { "input": { "type": "structure", "members": { "datasetGroupArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "datasets": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "datasetArn": {}, "datasetType": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } }, "nextToken": {} } }, "idempotent": true }, "ListEventTrackers": { "input": { "type": "structure", "members": { "datasetGroupArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "eventTrackers": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "eventTrackerArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } }, "nextToken": {} } }, "idempotent": true }, "ListRecipes": { "input": { "type": "structure", "members": { "recipeProvider": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "recipes": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "recipeArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } }, "nextToken": {} } }, "idempotent": true }, "ListSchemas": { "input": { "type": "structure", "members": { "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "schemas": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "schemaArn": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } }, "nextToken": {} } }, "idempotent": true }, "ListSolutionVersions": { "input": { "type": "structure", "members": { "solutionArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "solutionVersions": { "type": "list", "member": { "shape": "S39" } }, "nextToken": {} } }, "idempotent": true }, "ListSolutions": { "input": { "type": "structure", "members": { "datasetGroupArn": {}, "nextToken": {}, "maxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "solutions": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "solutionArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" } } } }, "nextToken": {} } }, "idempotent": true }, "UpdateCampaign": { "input": { "type": "structure", "required": [ "campaignArn" ], "members": { "campaignArn": {}, "solutionVersionArn": {}, "minProvisionedTPS": { "type": "integer" } } }, "output": { "type": "structure", "members": { "campaignArn": {} } }, "idempotent": true } }, "shapes": { "Se": { "type": "structure", "members": { "dataLocation": {} } }, "Sr": { "type": "structure", "members": { "eventValueThreshold": {}, "hpoConfig": { "type": "structure", "members": { "hpoObjective": { "type": "structure", "members": { "type": {}, "metricName": {}, "metricRegex": {} } }, "hpoResourceConfig": { "type": "structure", "members": { "maxNumberOfTrainingJobs": {}, "maxParallelTrainingJobs": {} } }, "algorithmHyperParameterRanges": { "type": "structure", "members": { "integerHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "minValue": { "type": "integer" }, "maxValue": { "type": "integer" } } } }, "continuousHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "minValue": { "type": "double" }, "maxValue": { "type": "double" } } } }, "categoricalHyperParameterRanges": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "values": { "shape": "S1c" } } } } } } } }, "algorithmHyperParameters": { "shape": "S1e" }, "featureTransformationParameters": { "type": "map", "key": {}, "value": {} }, "autoMLConfig": { "type": "structure", "members": { "metricName": {}, "recipeList": { "type": "list", "member": {} } } } } }, "S1c": { "type": "list", "member": {} }, "S1e": { "type": "map", "key": {}, "value": {} }, "S39": { "type": "structure", "members": { "solutionVersionArn": {}, "status": {}, "creationDateTime": { "type": "timestamp" }, "lastUpdatedDateTime": { "type": "timestamp" }, "failureReason": {} } } } }