{ "version":"2.0", "metadata":{ "apiVersion":"2020-07-13", "endpointPrefix":"finspace-api", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"FinSpace Data", "serviceFullName":"FinSpace Public API", "serviceId":"finspace data", "signatureVersion":"v4", "signingName":"finspace-api", "uid":"finspace-2020-07-13" }, "operations":{ "CreateChangeset":{ "name":"CreateChangeset", "http":{ "method":"POST", "requestUri":"/datasets/{datasetId}/changesets" }, "input":{"shape":"CreateChangesetRequest"}, "output":{"shape":"CreateChangesetResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"
Creates a new changeset in a FinSpace dataset.
" }, "GetProgrammaticAccessCredentials":{ "name":"GetProgrammaticAccessCredentials", "http":{ "method":"GET", "requestUri":"/credentials/programmatic" }, "input":{"shape":"GetProgrammaticAccessCredentialsRequest"}, "output":{"shape":"GetProgrammaticAccessCredentialsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"Request programmatic credentials to use with Habanero SDK.
" }, "GetWorkingLocation":{ "name":"GetWorkingLocation", "http":{ "method":"POST", "requestUri":"/workingLocationV1" }, "input":{"shape":"GetWorkingLocationRequest"}, "output":{"shape":"GetWorkingLocationResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], "documentation":"A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{"httpStatusCode":403}, "exception":true }, "ChangeType":{ "type":"string", "enum":[ "REPLACE", "APPEND", "MODIFY" ] }, "ChangesetInfo":{ "type":"structure", "members":{ "id":{ "shape":"IdType", "documentation":"Unique identifier for a changeset.
" }, "changesetArn":{ "shape":"arn", "documentation":"The ARN identifier of the changeset.
" }, "datasetId":{ "shape":"IdType", "documentation":"The unique identifier for the FinSpace dataset in which the changeset is created.
" }, "changeType":{ "shape":"ChangeType", "documentation":"Change type indicates how a changeset is applied to a dataset.
REPLACE
- Changeset is considered as a replacement to all prior loaded changesets.
APPEND
- Changeset is considered as an addition to the end of all prior loaded changesets.
MODIFY
- Changeset is considered as a replacement to a specific prior ingested changeset.
Type of the data source from which the files to create the changeset are sourced.
S3
- Amazon S3.
Source path from which the files to create the changeset are sourced.
" }, "formatType":{ "shape":"FormatType", "documentation":"Format type of the input files loaded into the changeset.
" }, "formatParams":{ "shape":"stringMap", "documentation":"Structure of the source file(s).
" }, "createTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp at which the changeset was created in FinSpace.
" }, "status":{ "shape":"ChangesetStatus", "documentation":"The status of changeset creation operation.
" }, "errorInfo":{ "shape":"ErrorInfo", "documentation":"The structure with error messages.
" }, "changesetLabels":{ "shape":"stringMap", "documentation":"Tags associated with the changeset.
" }, "updatesChangesetId":{ "shape":"stringValue", "documentation":"Unique identifier of the changeset that is updated.
" }, "updatedByChangesetId":{ "shape":"stringValue", "documentation":"Unique identifier of the changeset that is updated a changeset.
" } }, "documentation":"A changeset is unit of data in a dataset.
" }, "ChangesetStatus":{ "type":"string", "enum":[ "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED" ] }, "CreateChangesetRequest":{ "type":"structure", "required":[ "datasetId", "changeType", "sourceType", "sourceParams" ], "members":{ "datasetId":{ "shape":"IdType", "documentation":"The unique identifier for the FinSpace dataset in which the changeset will be created.
", "location":"uri", "locationName":"datasetId" }, "changeType":{ "shape":"ChangeType", "documentation":"Option to indicate how a changeset will be applied to a dataset.
REPLACE
- Changeset will be considered as a replacement to all prior loaded changesets.
APPEND
- Changeset will be considered as an addition to the end of all prior loaded changesets.
Type of the data source from which the files to create the changeset will be sourced.
S3
- Amazon S3.
Source path from which the files to create the changeset will be sourced.
" }, "formatType":{ "shape":"FormatType", "documentation":"Format type of the input files being loaded into the changeset.
" }, "formatParams":{ "shape":"stringMap", "documentation":"Options that define the structure of the source file(s).
" }, "tags":{ "shape":"stringMap", "documentation":"Metadata tags to apply to this changeset.
" } } }, "CreateChangesetResponse":{ "type":"structure", "members":{ "changeset":{ "shape":"ChangesetInfo", "documentation":"Returns the changeset details.
" } } }, "Credentials":{ "type":"structure", "members":{ "accessKeyId":{ "shape":"stringValueLength1to255", "documentation":"The access key identifier.
" }, "secretAccessKey":{ "shape":"stringValueMaxLength1000", "documentation":"The access key.
" }, "sessionToken":{ "shape":"stringValueMaxLength1000", "documentation":"The session token.
" } }, "documentation":"Set short term API credentials.
" }, "ErrorCategory":{ "type":"string", "enum":[ "The_inputs_to_this_request_are_invalid", "Service_limits_have_been_exceeded", "Missing_required_permission_to_perform_this_request", "One_or_more_inputs_to_this_request_were_not_found", "The_system_temporarily_lacks_sufficient_resources_to_process_the_request", "An_internal_error_has_occurred", "Cancelled", "A_user_recoverable_error_has_occurred" ] }, "ErrorInfo":{ "type":"structure", "members":{ "errorMessage":{ "shape":"stringValueMaxLength1000", "documentation":"The text of the error message.
" }, "errorCategory":{ "shape":"ErrorCategory", "documentation":"The category of the error.
VALIDATION
-The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED
- Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED
- Missing required permission to perform this request.
RESOURCE_NOT_FOUND
- One or more inputs to this request were not found.
THROTTLING
- The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION
- An internal service error has occurred.
CANCELLED
- A user recoverable error has occurred.
Error message.
" }, "FormatType":{ "type":"string", "enum":[ "CSV", "JSON", "PARQUET", "XML" ] }, "GetProgrammaticAccessCredentialsRequest":{ "type":"structure", "required":["environmentId"], "members":{ "durationInMinutes":{ "shape":"SessionDuration", "documentation":"The time duration in which the credentials remain valid.
", "location":"querystring", "locationName":"durationInMinutes" }, "environmentId":{ "shape":"IdType", "documentation":"The habanero environment identifier.
", "location":"querystring", "locationName":"environmentId" } } }, "GetProgrammaticAccessCredentialsResponse":{ "type":"structure", "members":{ "credentials":{ "shape":"Credentials", "documentation":"Returns the programmatic credentials.
" }, "durationInMinutes":{ "shape":"SessionDuration", "documentation":"Returns the duration in which the credentials will remain valid.
" } } }, "GetWorkingLocationRequest":{ "type":"structure", "members":{ "locationType":{ "shape":"locationType", "documentation":"Specify the type of the working location.
SAGEMAKER
- Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.
INGESTION
- Use the Amazon S3 location as a staging location to copy your data content and then use the location with the changeset creation operation.
Returns the Amazon S3 URI for the working location.
" }, "s3Path":{ "shape":"stringValueLength1to1024", "documentation":"Returns the Amazon S3 Path for the working location.
" }, "s3Bucket":{ "shape":"stringValueLength1to63", "documentation":"Returns the Amazon S3 bucket name for the working location.
" } } }, "IdType":{ "type":"string", "max":26, "min":1 }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The request processing has failed because of an unknown error, exception or failure.
", "error":{"httpStatusCode":500}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"One or more resources can't be found.
", "error":{"httpStatusCode":404}, "exception":true }, "SessionDuration":{ "type":"long", "max":720, "min":60 }, "SourceType":{ "type":"string", "enum":["S3"] }, "ThrottlingException":{ "type":"structure", "members":{ }, "documentation":"The request was denied due to request throttling.
", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"timestamp"}, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", "error":{"httpStatusCode":400}, "exception":true }, "arn":{ "type":"string", "max":2048, "min":20 }, "errorMessage":{"type":"string"}, "locationType":{ "type":"string", "enum":[ "INGESTION", "SAGEMAKER" ] }, "stringMap":{ "type":"map", "key":{"shape":"stringMapKey"}, "value":{"shape":"stringMapValue"} }, "stringMapKey":{"type":"string"}, "stringMapValue":{"type":"string"}, "stringValue":{"type":"string"}, "stringValueLength1to1024":{ "type":"string", "max":1024, "min":1, "pattern":".*\\S.*" }, "stringValueLength1to255":{ "type":"string", "max":255, "min":1 }, "stringValueLength1to63":{ "type":"string", "max":63, "min":1, "pattern":".*\\S.*" }, "stringValueMaxLength1000":{ "type":"string", "max":1000 } }, "documentation":"The FinSpace APIs let you take actions inside the FinSpace environment.
" }