FinSpace Public API 2020-07-13
- Client: Aws\FinSpaceData\FinSpaceDataClient
- Service ID: finspace-data
- Version: 2020-07-13
This page describes the parameters and results for the operations of the FinSpace Public API (2020-07-13), and shows how to use the Aws\FinSpaceData\FinSpaceDataClient object to call the described operations. This documentation is specific to the 2020-07-13 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateChangeset ( array $params = [] )
Creates a new changeset in a FinSpace dataset.
- GetProgrammaticAccessCredentials ( array $params = [] )
Request programmatic credentials to use with Habanero SDK.
- GetWorkingLocation ( array $params = [] )
A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.
Operations
CreateChangeset
$result = $client->createChangeset([/* ... */]); $promise = $client->createChangesetAsync([/* ... */]);
Creates a new changeset in a FinSpace dataset.
Parameter Syntax
$result = $client->createChangeset([
'changeType' => 'REPLACE|APPEND|MODIFY', // REQUIRED
'datasetId' => '<string>', // REQUIRED
'formatParams' => ['<string>', ...],
'formatType' => 'CSV|JSON|PARQUET|XML',
'sourceParams' => ['<string>', ...], // REQUIRED
'sourceType' => 'S3', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- changeType
-
- Required: Yes
- Type: string
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.
- datasetId
-
- Required: Yes
- Type: string
The unique identifier for the FinSpace dataset in which the changeset will be created.
- formatParams
-
- Type: Associative array of custom strings keys (stringMapKey) to strings
Options that define the structure of the source file(s).
- formatType
-
- Type: string
Format type of the input files being loaded into the changeset.
- sourceParams
-
- Required: Yes
- Type: Associative array of custom strings keys (stringMapKey) to strings
Source path from which the files to create the changeset will be sourced.
- sourceType
-
- Required: Yes
- Type: string
Type of the data source from which the files to create the changeset will be sourced.
-
S3- Amazon S3.
- tags
-
- Type: Associative array of custom strings keys (stringMapKey) to strings
Metadata tags to apply to this changeset.
Result Syntax
[
'changeset' => [
'changeType' => 'REPLACE|APPEND|MODIFY',
'changesetArn' => '<string>',
'changesetLabels' => ['<string>', ...],
'createTimestamp' => <DateTime>,
'datasetId' => '<string>',
'errorInfo' => [
'errorCategory' => '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',
'errorMessage' => '<string>',
],
'formatParams' => ['<string>', ...],
'formatType' => 'CSV|JSON|PARQUET|XML',
'id' => '<string>',
'sourceParams' => ['<string>', ...],
'sourceType' => 'S3',
'status' => 'PENDING|FAILED|SUCCESS|RUNNING|STOP_REQUESTED',
'updatedByChangesetId' => '<string>',
'updatesChangesetId' => '<string>',
],
]
Result Details
Members
- changeset
-
- Type: ChangesetInfo structure
Returns the changeset details.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
GetProgrammaticAccessCredentials
$result = $client->getProgrammaticAccessCredentials([/* ... */]); $promise = $client->getProgrammaticAccessCredentialsAsync([/* ... */]);
Request programmatic credentials to use with Habanero SDK.
Parameter Syntax
$result = $client->getProgrammaticAccessCredentials([
'durationInMinutes' => <integer>,
'environmentId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'credentials' => [
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>',
'sessionToken' => '<string>',
],
'durationInMinutes' => <integer>,
]
Result Details
Members
- credentials
-
- Type: Credentials structure
Returns the programmatic credentials.
- durationInMinutes
-
- Type: long (int|float)
Returns the duration in which the credentials will remain valid.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
GetWorkingLocation
$result = $client->getWorkingLocation([/* ... */]); $promise = $client->getWorkingLocationAsync([/* ... */]);
A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.
Parameter Syntax
$result = $client->getWorkingLocation([
'locationType' => 'INGESTION|SAGEMAKER',
]);
Parameter Details
Members
- locationType
-
- Type: string
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.
Result Syntax
[
's3Bucket' => '<string>',
's3Path' => '<string>',
's3Uri' => '<string>',
]
Result Details
Members
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
Shapes
AccessDeniedException
ChangesetInfo
Description
A changeset is unit of data in a dataset.
Members
- changeType
-
- Type: string
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.
- changesetArn
-
- Type: string
The ARN identifier of the changeset.
- changesetLabels
-
- Type: Associative array of custom strings keys (stringMapKey) to strings
Tags associated with the changeset.
- createTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp at which the changeset was created in FinSpace.
- datasetId
-
- Type: string
The unique identifier for the FinSpace dataset in which the changeset is created.
- errorInfo
-
- Type: ErrorInfo structure
The structure with error messages.
- formatParams
-
- Type: Associative array of custom strings keys (stringMapKey) to strings
Structure of the source file(s).
- formatType
-
- Type: string
Format type of the input files loaded into the changeset.
- id
-
- Type: string
Unique identifier for a changeset.
- sourceParams
-
- Type: Associative array of custom strings keys (stringMapKey) to strings
Source path from which the files to create the changeset are sourced.
- sourceType
-
- Type: string
Type of the data source from which the files to create the changeset are sourced.
-
S3- Amazon S3.
- status
-
- Type: string
The status of changeset creation operation.
- updatedByChangesetId
-
- Type: string
Unique identifier of the changeset that is updated a changeset.
- updatesChangesetId
-
- Type: string
Unique identifier of the changeset that is updated.
Credentials
Description
Set short term API credentials.
Members
ErrorInfo
Description
Error message.
Members
- errorCategory
-
- Type: string
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.
- errorMessage
-
- Type: string
The text of the error message.
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
ResourceNotFoundException
ThrottlingException
Description
The request was denied due to request throttling.