|
575 | 575 | }, |
576 | 576 | "activeFromTimestamp": { |
577 | 577 | "shape": "TimestampEpoch", |
| 578 | + "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>", |
578 | 579 | "box": true |
579 | 580 | }, |
580 | 581 | "updatesChangesetId": { |
|
668 | 669 | "members": { |
669 | 670 | "clientToken": { |
670 | 671 | "shape": "ClientToken", |
671 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 672 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
672 | 673 | "idempotencyToken": true |
673 | 674 | }, |
674 | 675 | "datasetId": { |
|
683 | 684 | }, |
684 | 685 | "sourceParams": { |
685 | 686 | "shape": "SourceParams", |
686 | | - "documentation": "<p>Options that define the location of the data being ingested.</p>" |
| 687 | + "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>" |
687 | 688 | }, |
688 | 689 | "formatParams": { |
689 | 690 | "shape": "FormatParams", |
690 | | - "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>" |
| 691 | + "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>" |
691 | 692 | } |
692 | 693 | }, |
693 | 694 | "documentation": "The request for a CreateChangeset operation." |
|
715 | 716 | "members": { |
716 | 717 | "clientToken": { |
717 | 718 | "shape": "ClientToken", |
718 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 719 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
719 | 720 | "idempotencyToken": true |
720 | 721 | }, |
721 | 722 | "datasetId": { |
|
772 | 773 | "members": { |
773 | 774 | "clientToken": { |
774 | 775 | "shape": "ClientToken", |
775 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 776 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
776 | 777 | "idempotencyToken": true |
777 | 778 | }, |
778 | 779 | "datasetTitle": { |
|
850 | 851 | "members": { |
851 | 852 | "destinationType": { |
852 | 853 | "shape": "DataViewDestinationType", |
853 | | - "documentation": "<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> - Glue table destination type.</p> </li> </ul>" |
| 854 | + "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>" |
854 | 855 | }, |
855 | 856 | "s3DestinationExportFileFormat": { |
856 | | - "shape": "ExportFileFormat" |
| 857 | + "shape": "ExportFileFormat", |
| 858 | + "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>" |
857 | 859 | }, |
858 | 860 | "s3DestinationExportFileFormatOptions": { |
859 | | - "shape": "S3DestinationFormatOptions" |
| 861 | + "shape": "S3DestinationFormatOptions", |
| 862 | + "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>" |
860 | 863 | } |
861 | 864 | }, |
862 | 865 | "documentation": "<p>Structure for the Dataview destination type parameters.</p>" |
|
1078 | 1081 | "members": { |
1079 | 1082 | "clientToken": { |
1080 | 1083 | "shape": "ClientToken", |
1081 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 1084 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
1082 | 1085 | "idempotencyToken": true, |
1083 | 1086 | "location": "querystring", |
1084 | 1087 | "locationName": "clientToken" |
|
1214 | 1217 | }, |
1215 | 1218 | "activeFromTimestamp": { |
1216 | 1219 | "shape": "TimestampEpoch", |
| 1220 | + "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>", |
1217 | 1221 | "box": true |
1218 | 1222 | }, |
1219 | 1223 | "updatesChangesetId": { |
|
1594 | 1598 | "documentation": "<p>List of resource permissions.</p>" |
1595 | 1599 | } |
1596 | 1600 | }, |
1597 | | - "documentation": "<p>Permission group parameters for Dataset permissions.</p>" |
| 1601 | + "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>" |
1598 | 1602 | }, |
1599 | 1603 | "PhoneNumber": { |
1600 | 1604 | "type": "string", |
|
1611 | 1615 | "documentation": "<p>Permission for a resource.</p>" |
1612 | 1616 | } |
1613 | 1617 | }, |
1614 | | - "documentation": "<p>Resource permission for a Dataset.</p>" |
| 1618 | + "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>" |
1615 | 1619 | }, |
1616 | 1620 | "ResourcePermissionsList": { |
1617 | 1621 | "type": "list", |
|
1720 | 1724 | "members": { |
1721 | 1725 | "clientToken": { |
1722 | 1726 | "shape": "ClientToken", |
1723 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 1727 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
1724 | 1728 | "idempotencyToken": true |
1725 | 1729 | }, |
1726 | 1730 | "datasetId": { |
|
1737 | 1741 | }, |
1738 | 1742 | "sourceParams": { |
1739 | 1743 | "shape": "SourceParams", |
1740 | | - "documentation": "<p>Options that define the location of the data being ingested.</p>" |
| 1744 | + "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>" |
1741 | 1745 | }, |
1742 | 1746 | "formatParams": { |
1743 | 1747 | "shape": "FormatParams", |
1744 | | - "documentation": "<p>Options that define the structure of the source file(s).</p>" |
| 1748 | + "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>" |
1745 | 1749 | } |
1746 | 1750 | }, |
1747 | 1751 | "documentation": "Request to update an existing changeset." |
|
1770 | 1774 | "members": { |
1771 | 1775 | "clientToken": { |
1772 | 1776 | "shape": "ClientToken", |
1773 | | - "documentation": "<p>A token used to ensure idempotency.</p>", |
| 1777 | + "documentation": "<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", |
1774 | 1778 | "idempotencyToken": true |
1775 | 1779 | }, |
1776 | 1780 | "datasetId": { |
|
0 commit comments