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

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2020-07-13",
     5      "endpointPrefix":"finspace-api",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceAbbreviation":"FinSpace Data",
     9      "serviceFullName":"FinSpace Public API",
    10      "serviceId":"finspace data",
    11      "signatureVersion":"v4",
    12      "signingName":"finspace-api",
    13      "uid":"finspace-2020-07-13"
    14    },
    15    "operations":{
    16      "CreateChangeset":{
    17        "name":"CreateChangeset",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/datasets/{datasetId}/changesets"
    21        },
    22        "input":{"shape":"CreateChangesetRequest"},
    23        "output":{"shape":"CreateChangesetResponse"},
    24        "errors":[
    25          {"shape":"ResourceNotFoundException"},
    26          {"shape":"InternalServerException"},
    27          {"shape":"ValidationException"},
    28          {"shape":"ThrottlingException"},
    29          {"shape":"AccessDeniedException"}
    30        ]
    31      },
    32      "GetProgrammaticAccessCredentials":{
    33        "name":"GetProgrammaticAccessCredentials",
    34        "http":{
    35          "method":"GET",
    36          "requestUri":"/credentials/programmatic"
    37        },
    38        "input":{"shape":"GetProgrammaticAccessCredentialsRequest"},
    39        "output":{"shape":"GetProgrammaticAccessCredentialsResponse"},
    40        "errors":[
    41          {"shape":"InternalServerException"},
    42          {"shape":"ThrottlingException"},
    43          {"shape":"AccessDeniedException"}
    44        ]
    45      },
    46      "GetWorkingLocation":{
    47        "name":"GetWorkingLocation",
    48        "http":{
    49          "method":"POST",
    50          "requestUri":"/workingLocationV1"
    51        },
    52        "input":{"shape":"GetWorkingLocationRequest"},
    53        "output":{"shape":"GetWorkingLocationResponse"},
    54        "errors":[
    55          {"shape":"InternalServerException"},
    56          {"shape":"AccessDeniedException"},
    57          {"shape":"ThrottlingException"},
    58          {"shape":"ValidationException"}
    59        ]
    60      }
    61    },
    62    "shapes":{
    63      "AccessDeniedException":{
    64        "type":"structure",
    65        "members":{
    66          "message":{"shape":"errorMessage"}
    67        },
    68        "error":{"httpStatusCode":403},
    69        "exception":true
    70      },
    71      "ChangeType":{
    72        "type":"string",
    73        "enum":[
    74          "REPLACE",
    75          "APPEND",
    76          "MODIFY"
    77        ]
    78      },
    79      "ChangesetInfo":{
    80        "type":"structure",
    81        "members":{
    82          "id":{"shape":"IdType"},
    83          "changesetArn":{"shape":"arn"},
    84          "datasetId":{"shape":"IdType"},
    85          "changeType":{"shape":"ChangeType"},
    86          "sourceType":{"shape":"SourceType"},
    87          "sourceParams":{"shape":"stringMap"},
    88          "formatType":{"shape":"FormatType"},
    89          "formatParams":{"shape":"stringMap"},
    90          "createTimestamp":{"shape":"Timestamp"},
    91          "status":{"shape":"ChangesetStatus"},
    92          "errorInfo":{"shape":"ErrorInfo"},
    93          "changesetLabels":{"shape":"stringMap"},
    94          "updatesChangesetId":{"shape":"stringValue"},
    95          "updatedByChangesetId":{"shape":"stringValue"}
    96        }
    97      },
    98      "ChangesetStatus":{
    99        "type":"string",
   100        "enum":[
   101          "PENDING",
   102          "FAILED",
   103          "SUCCESS",
   104          "RUNNING",
   105          "STOP_REQUESTED"
   106        ]
   107      },
   108      "CreateChangesetRequest":{
   109        "type":"structure",
   110        "required":[
   111          "datasetId",
   112          "changeType",
   113          "sourceType",
   114          "sourceParams"
   115        ],
   116        "members":{
   117          "datasetId":{
   118            "shape":"IdType",
   119            "location":"uri",
   120            "locationName":"datasetId"
   121          },
   122          "changeType":{"shape":"ChangeType"},
   123          "sourceType":{"shape":"SourceType"},
   124          "sourceParams":{"shape":"stringMap"},
   125          "formatType":{"shape":"FormatType"},
   126          "formatParams":{"shape":"stringMap"},
   127          "tags":{"shape":"stringMap"}
   128        }
   129      },
   130      "CreateChangesetResponse":{
   131        "type":"structure",
   132        "members":{
   133          "changeset":{"shape":"ChangesetInfo"}
   134        }
   135      },
   136      "Credentials":{
   137        "type":"structure",
   138        "members":{
   139          "accessKeyId":{"shape":"stringValueLength1to255"},
   140          "secretAccessKey":{"shape":"stringValueMaxLength1000"},
   141          "sessionToken":{"shape":"stringValueMaxLength1000"}
   142        }
   143      },
   144      "ErrorCategory":{
   145        "type":"string",
   146        "enum":[
   147          "The_inputs_to_this_request_are_invalid",
   148          "Service_limits_have_been_exceeded",
   149          "Missing_required_permission_to_perform_this_request",
   150          "One_or_more_inputs_to_this_request_were_not_found",
   151          "The_system_temporarily_lacks_sufficient_resources_to_process_the_request",
   152          "An_internal_error_has_occurred",
   153          "Cancelled",
   154          "A_user_recoverable_error_has_occurred"
   155        ]
   156      },
   157      "ErrorInfo":{
   158        "type":"structure",
   159        "members":{
   160          "errorMessage":{"shape":"stringValueMaxLength1000"},
   161          "errorCategory":{"shape":"ErrorCategory"}
   162        }
   163      },
   164      "FormatType":{
   165        "type":"string",
   166        "enum":[
   167          "CSV",
   168          "JSON",
   169          "PARQUET",
   170          "XML"
   171        ]
   172      },
   173      "GetProgrammaticAccessCredentialsRequest":{
   174        "type":"structure",
   175        "required":["environmentId"],
   176        "members":{
   177          "durationInMinutes":{
   178            "shape":"SessionDuration",
   179            "location":"querystring",
   180            "locationName":"durationInMinutes"
   181          },
   182          "environmentId":{
   183            "shape":"IdType",
   184            "location":"querystring",
   185            "locationName":"environmentId"
   186          }
   187        }
   188      },
   189      "GetProgrammaticAccessCredentialsResponse":{
   190        "type":"structure",
   191        "members":{
   192          "credentials":{"shape":"Credentials"},
   193          "durationInMinutes":{"shape":"SessionDuration"}
   194        }
   195      },
   196      "GetWorkingLocationRequest":{
   197        "type":"structure",
   198        "members":{
   199          "locationType":{"shape":"locationType"}
   200        }
   201      },
   202      "GetWorkingLocationResponse":{
   203        "type":"structure",
   204        "members":{
   205          "s3Uri":{"shape":"stringValueLength1to1024"},
   206          "s3Path":{"shape":"stringValueLength1to1024"},
   207          "s3Bucket":{"shape":"stringValueLength1to63"}
   208        }
   209      },
   210      "IdType":{
   211        "type":"string",
   212        "max":26,
   213        "min":1
   214      },
   215      "InternalServerException":{
   216        "type":"structure",
   217        "members":{
   218          "message":{"shape":"errorMessage"}
   219        },
   220        "error":{"httpStatusCode":500},
   221        "exception":true
   222      },
   223      "ResourceNotFoundException":{
   224        "type":"structure",
   225        "members":{
   226          "message":{"shape":"errorMessage"}
   227        },
   228        "error":{"httpStatusCode":404},
   229        "exception":true
   230      },
   231      "SessionDuration":{
   232        "type":"long",
   233        "max":720,
   234        "min":60
   235      },
   236      "SourceType":{
   237        "type":"string",
   238        "enum":["S3"]
   239      },
   240      "ThrottlingException":{
   241        "type":"structure",
   242        "members":{
   243        },
   244        "error":{"httpStatusCode":429},
   245        "exception":true
   246      },
   247      "Timestamp":{"type":"timestamp"},
   248      "ValidationException":{
   249        "type":"structure",
   250        "members":{
   251          "message":{"shape":"errorMessage"}
   252        },
   253        "error":{"httpStatusCode":400},
   254        "exception":true
   255      },
   256      "arn":{
   257        "type":"string",
   258        "max":2048,
   259        "min":20
   260      },
   261      "errorMessage":{"type":"string"},
   262      "locationType":{
   263        "type":"string",
   264        "enum":[
   265          "INGESTION",
   266          "SAGEMAKER"
   267        ]
   268      },
   269      "stringMap":{
   270        "type":"map",
   271        "key":{"shape":"stringMapKey"},
   272        "value":{"shape":"stringMapValue"}
   273      },
   274      "stringMapKey":{"type":"string"},
   275      "stringMapValue":{"type":"string"},
   276      "stringValue":{"type":"string"},
   277      "stringValueLength1to1024":{
   278        "type":"string",
   279        "max":1024,
   280        "min":1,
   281        "pattern":".*\\S.*"
   282      },
   283      "stringValueLength1to255":{
   284        "type":"string",
   285        "max":255,
   286        "min":1
   287      },
   288      "stringValueLength1to63":{
   289        "type":"string",
   290        "max":63,
   291        "min":1,
   292        "pattern":".*\\S.*"
   293      },
   294      "stringValueMaxLength1000":{
   295        "type":"string",
   296        "max":1000
   297      }
   298    }
   299  }