github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/finspace-data/2020-07-13/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p> The FinSpace APIs let you take actions inside the FinSpace environment. </p>",
     4    "operations": {
     5      "CreateChangeset": "<p>Creates a new changeset in a FinSpace dataset.</p>",
     6      "GetProgrammaticAccessCredentials": "<p>Request programmatic credentials to use with Habanero SDK.</p>",
     7      "GetWorkingLocation": "<p>A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.</p>"
     8    },
     9    "shapes": {
    10      "AccessDeniedException": {
    11        "base": "<p>You do not have sufficient access to perform this action.</p>",
    12        "refs": {
    13        }
    14      },
    15      "ChangeType": {
    16        "base": null,
    17        "refs": {
    18          "ChangesetInfo$changeType": "<p>Change type indicates how a changeset is applied to a dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested changeset.</p> </li> </ul>",
    19          "CreateChangesetRequest$changeType": "<p>Option to indicate how a changeset will be applied to a dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset will be considered as a replacement to all prior loaded changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset will be considered as an addition to the end of all prior loaded changesets.</p> </li> </ul>"
    20        }
    21      },
    22      "ChangesetInfo": {
    23        "base": "<p>A changeset is unit of data in a dataset.</p>",
    24        "refs": {
    25          "CreateChangesetResponse$changeset": "<p>Returns the changeset details.</p>"
    26        }
    27      },
    28      "ChangesetStatus": {
    29        "base": null,
    30        "refs": {
    31          "ChangesetInfo$status": "<p>The status of changeset creation operation.</p>"
    32        }
    33      },
    34      "CreateChangesetRequest": {
    35        "base": null,
    36        "refs": {
    37        }
    38      },
    39      "CreateChangesetResponse": {
    40        "base": null,
    41        "refs": {
    42        }
    43      },
    44      "Credentials": {
    45        "base": "<p>Set short term API credentials.</p>",
    46        "refs": {
    47          "GetProgrammaticAccessCredentialsResponse$credentials": "<p>Returns the programmatic credentials.</p>"
    48        }
    49      },
    50      "ErrorCategory": {
    51        "base": null,
    52        "refs": {
    53          "ErrorInfo$errorCategory": "<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> -The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> - Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> - A user recoverable error has occurred.</p> </li> </ul>"
    54        }
    55      },
    56      "ErrorInfo": {
    57        "base": "<p>Error message.</p>",
    58        "refs": {
    59          "ChangesetInfo$errorInfo": "<p>The structure with error messages.</p>"
    60        }
    61      },
    62      "FormatType": {
    63        "base": null,
    64        "refs": {
    65          "ChangesetInfo$formatType": "<p>Format type of the input files loaded into the changeset.</p>",
    66          "CreateChangesetRequest$formatType": "<p>Format type of the input files being loaded into the changeset.</p>"
    67        }
    68      },
    69      "GetProgrammaticAccessCredentialsRequest": {
    70        "base": null,
    71        "refs": {
    72        }
    73      },
    74      "GetProgrammaticAccessCredentialsResponse": {
    75        "base": null,
    76        "refs": {
    77        }
    78      },
    79      "GetWorkingLocationRequest": {
    80        "base": null,
    81        "refs": {
    82        }
    83      },
    84      "GetWorkingLocationResponse": {
    85        "base": null,
    86        "refs": {
    87        }
    88      },
    89      "IdType": {
    90        "base": null,
    91        "refs": {
    92          "ChangesetInfo$id": "<p>Unique identifier for a changeset.</p>",
    93          "ChangesetInfo$datasetId": "<p>The unique identifier for the FinSpace dataset in which the changeset is created.</p>",
    94          "CreateChangesetRequest$datasetId": "<p>The unique identifier for the FinSpace dataset in which the changeset will be created.</p>",
    95          "GetProgrammaticAccessCredentialsRequest$environmentId": "<p>The habanero environment identifier.</p>"
    96        }
    97      },
    98      "InternalServerException": {
    99        "base": "<p>The request processing has failed because of an unknown error, exception or failure.</p>",
   100        "refs": {
   101        }
   102      },
   103      "ResourceNotFoundException": {
   104        "base": "<p>One or more resources can't be found.</p>",
   105        "refs": {
   106        }
   107      },
   108      "SessionDuration": {
   109        "base": null,
   110        "refs": {
   111          "GetProgrammaticAccessCredentialsRequest$durationInMinutes": "<p>The time duration in which the credentials remain valid. </p>",
   112          "GetProgrammaticAccessCredentialsResponse$durationInMinutes": "<p>Returns the duration in which the credentials will remain valid.</p>"
   113        }
   114      },
   115      "SourceType": {
   116        "base": null,
   117        "refs": {
   118          "ChangesetInfo$sourceType": "<p>Type of the data source from which the files to create the changeset are sourced.</p> <ul> <li> <p> <code>S3</code> - Amazon S3.</p> </li> </ul>",
   119          "CreateChangesetRequest$sourceType": "<p>Type of the data source from which the files to create the changeset will be sourced.</p> <ul> <li> <p> <code>S3</code> - Amazon S3.</p> </li> </ul>"
   120        }
   121      },
   122      "ThrottlingException": {
   123        "base": "<p>The request was denied due to request throttling.</p>",
   124        "refs": {
   125        }
   126      },
   127      "Timestamp": {
   128        "base": null,
   129        "refs": {
   130          "ChangesetInfo$createTimestamp": "<p>The timestamp at which the changeset was created in FinSpace.</p>"
   131        }
   132      },
   133      "ValidationException": {
   134        "base": "<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
   135        "refs": {
   136        }
   137      },
   138      "arn": {
   139        "base": null,
   140        "refs": {
   141          "ChangesetInfo$changesetArn": "<p>The ARN identifier of the changeset.</p>"
   142        }
   143      },
   144      "errorMessage": {
   145        "base": null,
   146        "refs": {
   147          "AccessDeniedException$message": null,
   148          "InternalServerException$message": null,
   149          "ResourceNotFoundException$message": null,
   150          "ValidationException$message": null
   151        }
   152      },
   153      "locationType": {
   154        "base": null,
   155        "refs": {
   156          "GetWorkingLocationRequest$locationType": "<p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the changeset creation operation.</p> </li> </ul>"
   157        }
   158      },
   159      "stringMap": {
   160        "base": null,
   161        "refs": {
   162          "ChangesetInfo$sourceParams": "<p>Source path from which the files to create the changeset are sourced.</p>",
   163          "ChangesetInfo$formatParams": "<p>Structure of the source file(s).</p>",
   164          "ChangesetInfo$changesetLabels": "<p>Tags associated with the changeset.</p>",
   165          "CreateChangesetRequest$sourceParams": "<p>Source path from which the files to create the changeset will be sourced.</p>",
   166          "CreateChangesetRequest$formatParams": "<p>Options that define the structure of the source file(s).</p>",
   167          "CreateChangesetRequest$tags": "<p>Metadata tags to apply to this changeset.</p>"
   168        }
   169      },
   170      "stringMapKey": {
   171        "base": null,
   172        "refs": {
   173          "stringMap$key": null
   174        }
   175      },
   176      "stringMapValue": {
   177        "base": null,
   178        "refs": {
   179          "stringMap$value": null
   180        }
   181      },
   182      "stringValue": {
   183        "base": null,
   184        "refs": {
   185          "ChangesetInfo$updatesChangesetId": "<p>Unique identifier of the changeset that is updated.</p>",
   186          "ChangesetInfo$updatedByChangesetId": "<p>Unique identifier of the changeset that is updated a changeset.</p>"
   187        }
   188      },
   189      "stringValueLength1to1024": {
   190        "base": null,
   191        "refs": {
   192          "GetWorkingLocationResponse$s3Uri": "<p>Returns the Amazon S3 URI for the working location.</p>",
   193          "GetWorkingLocationResponse$s3Path": "<p>Returns the Amazon S3 Path for the working location.</p>"
   194        }
   195      },
   196      "stringValueLength1to255": {
   197        "base": null,
   198        "refs": {
   199          "Credentials$accessKeyId": "<p>The access key identifier.</p>"
   200        }
   201      },
   202      "stringValueLength1to63": {
   203        "base": null,
   204        "refs": {
   205          "GetWorkingLocationResponse$s3Bucket": "<p>Returns the Amazon S3 bucket name for the working location.</p>"
   206        }
   207      },
   208      "stringValueMaxLength1000": {
   209        "base": null,
   210        "refs": {
   211          "Credentials$secretAccessKey": "<p>The access key.</p>",
   212          "Credentials$sessionToken": "<p>The session token.</p>",
   213          "ErrorInfo$errorMessage": "<p>The text of the error message.</p>"
   214        }
   215      }
   216    }
   217  }