Skip to content

Commit 77146d9

Browse files
author
AWS
committed
FinSpace Public API Update: Documentation updates for FinSpace.
1 parent 6372433 commit 77146d9

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

‎.changes/next-release/feature-FinSpacePublicAPI-65007ef.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "FinSpace Public API",
4+
"contributor": "",
5+
"description": "Documentation updates for FinSpace."
6+
}

‎services/finspacedata/src/main/resources/codegen-resources/service-2.json

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@
366366
},
367367
"activeFromTimestamp":{
368368
"shape":"TimestampEpoch",
369+
"documentation":"<p>Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
369370
"box":true
370371
},
371372
"updatesChangesetId":{
@@ -464,7 +465,7 @@
464465
"members":{
465466
"clientToken":{
466467
"shape":"ClientToken",
467-
"documentation":"<p>A token used to ensure idempotency.</p>",
468+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
468469
"idempotencyToken":true
469470
},
470471
"datasetId":{
@@ -479,11 +480,11 @@
479480
},
480481
"sourceParams":{
481482
"shape":"SourceParams",
482-
"documentation":"<p>Options that define the location of the data being ingested.</p>"
483+
"documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>"
483484
},
484485
"formatParams":{
485486
"shape":"FormatParams",
486-
"documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p> For example, you could specify the following for <code>formatParams</code>: <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p>"
487+
"documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
487488
}
488489
},
489490
"documentation":"The request for a CreateChangeset operation."
@@ -511,7 +512,7 @@
511512
"members":{
512513
"clientToken":{
513514
"shape":"ClientToken",
514-
"documentation":"<p>A token used to ensure idempotency.</p>",
515+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
515516
"idempotencyToken":true
516517
},
517518
"datasetId":{
@@ -568,7 +569,7 @@
568569
"members":{
569570
"clientToken":{
570571
"shape":"ClientToken",
571-
"documentation":"<p>A token used to ensure idempotency.</p>",
572+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
572573
"idempotencyToken":true
573574
},
574575
"datasetTitle":{
@@ -644,10 +645,16 @@
644645
"members":{
645646
"destinationType":{
646647
"shape":"DataViewDestinationType",
647-
"documentation":"<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> - Glue table destination type.</p> </li> </ul>"
648+
"documentation":"<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> - Glue table destination type.</p> </li> <li> <p> <code>S3</code> - S3 destination type.</p> </li> </ul>"
649+
},
650+
"s3DestinationExportFileFormat":{
651+
"shape":"ExportFileFormat",
652+
"documentation":"<p>Data view export file format.</p> <ul> <li> <p> <code>PARQUET</code> - Parquet export file format.</p> </li> <li> <p> <code>DELIMITED_TEXT</code> - Delimited text export file format.</p> </li> </ul>"
648653
},
649-
"s3DestinationExportFileFormat":{"shape":"ExportFileFormat"},
650-
"s3DestinationExportFileFormatOptions":{"shape":"S3DestinationFormatOptions"}
654+
"s3DestinationExportFileFormatOptions":{
655+
"shape":"S3DestinationFormatOptions",
656+
"documentation":"<p>Format Options for S3 Destination type.</p> <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code> </p> <p> <code> { \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }</code> </p>"
657+
}
651658
},
652659
"documentation":"<p>Structure for the Dataview destination type parameters.</p>"
653660
},
@@ -862,7 +869,7 @@
862869
"members":{
863870
"clientToken":{
864871
"shape":"ClientToken",
865-
"documentation":"<p>A token used to ensure idempotency.</p>",
872+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
866873
"idempotencyToken":true,
867874
"location":"querystring",
868875
"locationName":"clientToken"
@@ -994,6 +1001,7 @@
9941001
},
9951002
"activeFromTimestamp":{
9961003
"shape":"TimestampEpoch",
1004+
"documentation":"<p>Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>",
9971005
"box":true
9981006
},
9991007
"updatesChangesetId":{
@@ -1382,7 +1390,7 @@
13821390
"documentation":"<p>List of resource permissions.</p>"
13831391
}
13841392
},
1385-
"documentation":"<p>Permission group parameters for Dataset permissions.</p>"
1393+
"documentation":"<p>Permission group parameters for Dataset permissions.</p> <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p> <p> <code> { \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\", \"datasetPermissions\": [ {\"permission\": \"ViewDatasetDetails\"}, {\"permission\": \"AddDatasetData\"}, {\"permission\": \"EditDatasetMetadata\"}, {\"permission\": \"DeleteDataset\"} ] } </code> </p>"
13861394
},
13871395
"PhoneNumber":{
13881396
"type":"string",
@@ -1408,7 +1416,7 @@
14081416
"documentation":"<p>Permission for a resource.</p>"
14091417
}
14101418
},
1411-
"documentation":"<p>Resource permission for a Dataset.</p>"
1419+
"documentation":"<p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p> <p>The following is a list of valid dataset permissions that you can apply: </p> <ul> <li> <p> <code>ViewDatasetDetails</code> </p> </li> <li> <p> <code>ReadDatasetDetails</code> </p> </li> <li> <p> <code>AddDatasetData</code> </p> </li> <li> <p> <code>CreateSnapshot</code> </p> </li> <li> <p> <code>EditDatasetMetadata</code> </p> </li> <li> <p> <code>DeleteDataset</code> </p> </li> </ul> <p>For more information on the ataset permissions, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions\">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>"
14121420
},
14131421
"ResourcePermissionsList":{
14141422
"type":"list",
@@ -1513,7 +1521,7 @@
15131521
"members":{
15141522
"clientToken":{
15151523
"shape":"ClientToken",
1516-
"documentation":"<p>A token used to ensure idempotency.</p>",
1524+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
15171525
"idempotencyToken":true
15181526
},
15191527
"datasetId":{
@@ -1530,11 +1538,11 @@
15301538
},
15311539
"sourceParams":{
15321540
"shape":"SourceParams",
1533-
"documentation":"<p>Options that define the location of the data being ingested.</p>"
1541+
"documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>"
15341542
},
15351543
"formatParams":{
15361544
"shape":"FormatParams",
1537-
"documentation":"<p>Options that define the structure of the source file(s).</p>"
1545+
"documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
15381546
}
15391547
},
15401548
"documentation":"Request to update an existing changeset."
@@ -1563,7 +1571,7 @@
15631571
"members":{
15641572
"clientToken":{
15651573
"shape":"ClientToken",
1566-
"documentation":"<p>A token used to ensure idempotency.</p>",
1574+
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
15671575
"idempotencyToken":true
15681576
},
15691577
"datasetId":{

0 commit comments

Comments
 (0)