github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/redshift-data/2019-12-20/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2019-12-20",
     5      "endpointPrefix":"redshift-data",
     6      "jsonVersion":"1.1",
     7      "protocol":"json",
     8      "serviceFullName":"Redshift Data API Service",
     9      "serviceId":"Redshift Data",
    10      "signatureVersion":"v4",
    11      "signingName":"redshift-data",
    12      "targetPrefix":"RedshiftData",
    13      "uid":"redshift-data-2019-12-20"
    14    },
    15    "operations":{
    16      "BatchExecuteStatement":{
    17        "name":"BatchExecuteStatement",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/"
    21        },
    22        "input":{"shape":"BatchExecuteStatementInput"},
    23        "output":{"shape":"BatchExecuteStatementOutput"},
    24        "errors":[
    25          {"shape":"ValidationException"},
    26          {"shape":"ActiveStatementsExceededException"},
    27          {"shape":"BatchExecuteStatementException"}
    28        ]
    29      },
    30      "CancelStatement":{
    31        "name":"CancelStatement",
    32        "http":{
    33          "method":"POST",
    34          "requestUri":"/"
    35        },
    36        "input":{"shape":"CancelStatementRequest"},
    37        "output":{"shape":"CancelStatementResponse"},
    38        "errors":[
    39          {"shape":"ValidationException"},
    40          {"shape":"ResourceNotFoundException"},
    41          {"shape":"InternalServerException"}
    42        ]
    43      },
    44      "DescribeStatement":{
    45        "name":"DescribeStatement",
    46        "http":{
    47          "method":"POST",
    48          "requestUri":"/"
    49        },
    50        "input":{"shape":"DescribeStatementRequest"},
    51        "output":{"shape":"DescribeStatementResponse"},
    52        "errors":[
    53          {"shape":"ValidationException"},
    54          {"shape":"ResourceNotFoundException"},
    55          {"shape":"InternalServerException"}
    56        ]
    57      },
    58      "DescribeTable":{
    59        "name":"DescribeTable",
    60        "http":{
    61          "method":"POST",
    62          "requestUri":"/"
    63        },
    64        "input":{"shape":"DescribeTableRequest"},
    65        "output":{"shape":"DescribeTableResponse"},
    66        "errors":[
    67          {"shape":"ValidationException"},
    68          {"shape":"InternalServerException"}
    69        ]
    70      },
    71      "ExecuteStatement":{
    72        "name":"ExecuteStatement",
    73        "http":{
    74          "method":"POST",
    75          "requestUri":"/"
    76        },
    77        "input":{"shape":"ExecuteStatementInput"},
    78        "output":{"shape":"ExecuteStatementOutput"},
    79        "errors":[
    80          {"shape":"ValidationException"},
    81          {"shape":"ExecuteStatementException"},
    82          {"shape":"ActiveStatementsExceededException"}
    83        ]
    84      },
    85      "GetStatementResult":{
    86        "name":"GetStatementResult",
    87        "http":{
    88          "method":"POST",
    89          "requestUri":"/"
    90        },
    91        "input":{"shape":"GetStatementResultRequest"},
    92        "output":{"shape":"GetStatementResultResponse"},
    93        "errors":[
    94          {"shape":"ValidationException"},
    95          {"shape":"ResourceNotFoundException"},
    96          {"shape":"InternalServerException"}
    97        ]
    98      },
    99      "ListDatabases":{
   100        "name":"ListDatabases",
   101        "http":{
   102          "method":"POST",
   103          "requestUri":"/"
   104        },
   105        "input":{"shape":"ListDatabasesRequest"},
   106        "output":{"shape":"ListDatabasesResponse"},
   107        "errors":[
   108          {"shape":"ValidationException"},
   109          {"shape":"InternalServerException"}
   110        ]
   111      },
   112      "ListSchemas":{
   113        "name":"ListSchemas",
   114        "http":{
   115          "method":"POST",
   116          "requestUri":"/"
   117        },
   118        "input":{"shape":"ListSchemasRequest"},
   119        "output":{"shape":"ListSchemasResponse"},
   120        "errors":[
   121          {"shape":"ValidationException"},
   122          {"shape":"InternalServerException"}
   123        ]
   124      },
   125      "ListStatements":{
   126        "name":"ListStatements",
   127        "http":{
   128          "method":"POST",
   129          "requestUri":"/"
   130        },
   131        "input":{"shape":"ListStatementsRequest"},
   132        "output":{"shape":"ListStatementsResponse"},
   133        "errors":[
   134          {"shape":"ValidationException"},
   135          {"shape":"InternalServerException"}
   136        ]
   137      },
   138      "ListTables":{
   139        "name":"ListTables",
   140        "http":{
   141          "method":"POST",
   142          "requestUri":"/"
   143        },
   144        "input":{"shape":"ListTablesRequest"},
   145        "output":{"shape":"ListTablesResponse"},
   146        "errors":[
   147          {"shape":"ValidationException"},
   148          {"shape":"InternalServerException"}
   149        ]
   150      }
   151    },
   152    "shapes":{
   153      "ActiveStatementsExceededException":{
   154        "type":"structure",
   155        "members":{
   156          "Message":{"shape":"String"}
   157        },
   158        "exception":true
   159      },
   160      "BatchExecuteStatementException":{
   161        "type":"structure",
   162        "required":[
   163          "Message",
   164          "StatementId"
   165        ],
   166        "members":{
   167          "Message":{"shape":"String"},
   168          "StatementId":{"shape":"String"}
   169        },
   170        "exception":true,
   171        "fault":true
   172      },
   173      "BatchExecuteStatementInput":{
   174        "type":"structure",
   175        "required":[
   176          "ClusterIdentifier",
   177          "Database",
   178          "Sqls"
   179        ],
   180        "members":{
   181          "ClusterIdentifier":{"shape":"Location"},
   182          "Database":{"shape":"String"},
   183          "DbUser":{"shape":"String"},
   184          "SecretArn":{"shape":"SecretArn"},
   185          "Sqls":{"shape":"SqlList"},
   186          "StatementName":{"shape":"StatementNameString"},
   187          "WithEvent":{"shape":"Boolean"}
   188        }
   189      },
   190      "BatchExecuteStatementOutput":{
   191        "type":"structure",
   192        "members":{
   193          "ClusterIdentifier":{"shape":"Location"},
   194          "CreatedAt":{"shape":"Timestamp"},
   195          "Database":{"shape":"String"},
   196          "DbUser":{"shape":"String"},
   197          "Id":{"shape":"StatementId"},
   198          "SecretArn":{"shape":"SecretArn"}
   199        }
   200      },
   201      "Blob":{"type":"blob"},
   202      "Boolean":{
   203        "type":"boolean",
   204        "box":true
   205      },
   206      "BoxedBoolean":{
   207        "type":"boolean",
   208        "box":true
   209      },
   210      "BoxedDouble":{
   211        "type":"double",
   212        "box":true
   213      },
   214      "BoxedLong":{
   215        "type":"long",
   216        "box":true
   217      },
   218      "CancelStatementRequest":{
   219        "type":"structure",
   220        "required":["Id"],
   221        "members":{
   222          "Id":{"shape":"StatementId"}
   223        }
   224      },
   225      "CancelStatementResponse":{
   226        "type":"structure",
   227        "members":{
   228          "Status":{"shape":"Boolean"}
   229        }
   230      },
   231      "ColumnList":{
   232        "type":"list",
   233        "member":{"shape":"ColumnMetadata"}
   234      },
   235      "ColumnMetadata":{
   236        "type":"structure",
   237        "members":{
   238          "columnDefault":{"shape":"String"},
   239          "isCaseSensitive":{"shape":"bool"},
   240          "isCurrency":{"shape":"bool"},
   241          "isSigned":{"shape":"bool"},
   242          "label":{"shape":"String"},
   243          "length":{"shape":"Integer"},
   244          "name":{"shape":"String"},
   245          "nullable":{"shape":"Integer"},
   246          "precision":{"shape":"Integer"},
   247          "scale":{"shape":"Integer"},
   248          "schemaName":{"shape":"String"},
   249          "tableName":{"shape":"String"},
   250          "typeName":{"shape":"String"}
   251        }
   252      },
   253      "ColumnMetadataList":{
   254        "type":"list",
   255        "member":{"shape":"ColumnMetadata"}
   256      },
   257      "DatabaseList":{
   258        "type":"list",
   259        "member":{"shape":"String"}
   260      },
   261      "DescribeStatementRequest":{
   262        "type":"structure",
   263        "required":["Id"],
   264        "members":{
   265          "Id":{"shape":"StatementId"}
   266        }
   267      },
   268      "DescribeStatementResponse":{
   269        "type":"structure",
   270        "required":["Id"],
   271        "members":{
   272          "ClusterIdentifier":{"shape":"String"},
   273          "CreatedAt":{"shape":"Timestamp"},
   274          "Database":{"shape":"String"},
   275          "DbUser":{"shape":"String"},
   276          "Duration":{"shape":"Long"},
   277          "Error":{"shape":"String"},
   278          "HasResultSet":{"shape":"Boolean"},
   279          "Id":{"shape":"StatementId"},
   280          "QueryParameters":{"shape":"SqlParametersList"},
   281          "QueryString":{"shape":"StatementString"},
   282          "RedshiftPid":{"shape":"Long"},
   283          "RedshiftQueryId":{"shape":"Long"},
   284          "ResultRows":{"shape":"Long"},
   285          "ResultSize":{"shape":"Long"},
   286          "SecretArn":{"shape":"SecretArn"},
   287          "Status":{"shape":"StatusString"},
   288          "SubStatements":{"shape":"SubStatementList"},
   289          "UpdatedAt":{"shape":"Timestamp"}
   290        }
   291      },
   292      "DescribeTableRequest":{
   293        "type":"structure",
   294        "required":[
   295          "ClusterIdentifier",
   296          "Database"
   297        ],
   298        "members":{
   299          "ClusterIdentifier":{"shape":"Location"},
   300          "ConnectedDatabase":{"shape":"String"},
   301          "Database":{"shape":"String"},
   302          "DbUser":{"shape":"String"},
   303          "MaxResults":{"shape":"PageSize"},
   304          "NextToken":{"shape":"String"},
   305          "Schema":{"shape":"String"},
   306          "SecretArn":{"shape":"SecretArn"},
   307          "Table":{"shape":"String"}
   308        }
   309      },
   310      "DescribeTableResponse":{
   311        "type":"structure",
   312        "members":{
   313          "ColumnList":{"shape":"ColumnList"},
   314          "NextToken":{"shape":"String"},
   315          "TableName":{"shape":"String"}
   316        }
   317      },
   318      "ExecuteStatementException":{
   319        "type":"structure",
   320        "required":[
   321          "Message",
   322          "StatementId"
   323        ],
   324        "members":{
   325          "Message":{"shape":"String"},
   326          "StatementId":{"shape":"String"}
   327        },
   328        "exception":true,
   329        "fault":true
   330      },
   331      "ExecuteStatementInput":{
   332        "type":"structure",
   333        "required":[
   334          "ClusterIdentifier",
   335          "Database",
   336          "Sql"
   337        ],
   338        "members":{
   339          "ClusterIdentifier":{"shape":"Location"},
   340          "Database":{"shape":"String"},
   341          "DbUser":{"shape":"String"},
   342          "Parameters":{"shape":"SqlParametersList"},
   343          "SecretArn":{"shape":"SecretArn"},
   344          "Sql":{"shape":"StatementString"},
   345          "StatementName":{"shape":"StatementNameString"},
   346          "WithEvent":{"shape":"Boolean"}
   347        }
   348      },
   349      "ExecuteStatementOutput":{
   350        "type":"structure",
   351        "members":{
   352          "ClusterIdentifier":{"shape":"Location"},
   353          "CreatedAt":{"shape":"Timestamp"},
   354          "Database":{"shape":"String"},
   355          "DbUser":{"shape":"String"},
   356          "Id":{"shape":"StatementId"},
   357          "SecretArn":{"shape":"SecretArn"}
   358        }
   359      },
   360      "Field":{
   361        "type":"structure",
   362        "members":{
   363          "blobValue":{"shape":"Blob"},
   364          "booleanValue":{"shape":"BoxedBoolean"},
   365          "doubleValue":{"shape":"BoxedDouble"},
   366          "isNull":{"shape":"BoxedBoolean"},
   367          "longValue":{"shape":"BoxedLong"},
   368          "stringValue":{"shape":"String"}
   369        },
   370        "union":true
   371      },
   372      "FieldList":{
   373        "type":"list",
   374        "member":{"shape":"Field"}
   375      },
   376      "GetStatementResultRequest":{
   377        "type":"structure",
   378        "required":["Id"],
   379        "members":{
   380          "Id":{"shape":"StatementId"},
   381          "NextToken":{"shape":"String"}
   382        }
   383      },
   384      "GetStatementResultResponse":{
   385        "type":"structure",
   386        "required":["Records"],
   387        "members":{
   388          "ColumnMetadata":{"shape":"ColumnMetadataList"},
   389          "NextToken":{"shape":"String"},
   390          "Records":{"shape":"SqlRecords"},
   391          "TotalNumRows":{"shape":"Long"}
   392        }
   393      },
   394      "Integer":{"type":"integer"},
   395      "InternalServerException":{
   396        "type":"structure",
   397        "required":["Message"],
   398        "members":{
   399          "Message":{"shape":"String"}
   400        },
   401        "exception":true,
   402        "fault":true
   403      },
   404      "ListDatabasesRequest":{
   405        "type":"structure",
   406        "required":[
   407          "ClusterIdentifier",
   408          "Database"
   409        ],
   410        "members":{
   411          "ClusterIdentifier":{"shape":"Location"},
   412          "Database":{"shape":"String"},
   413          "DbUser":{"shape":"String"},
   414          "MaxResults":{"shape":"PageSize"},
   415          "NextToken":{"shape":"String"},
   416          "SecretArn":{"shape":"SecretArn"}
   417        }
   418      },
   419      "ListDatabasesResponse":{
   420        "type":"structure",
   421        "members":{
   422          "Databases":{"shape":"DatabaseList"},
   423          "NextToken":{"shape":"String"}
   424        }
   425      },
   426      "ListSchemasRequest":{
   427        "type":"structure",
   428        "required":[
   429          "ClusterIdentifier",
   430          "Database"
   431        ],
   432        "members":{
   433          "ClusterIdentifier":{"shape":"Location"},
   434          "ConnectedDatabase":{"shape":"String"},
   435          "Database":{"shape":"String"},
   436          "DbUser":{"shape":"String"},
   437          "MaxResults":{"shape":"PageSize"},
   438          "NextToken":{"shape":"String"},
   439          "SchemaPattern":{"shape":"String"},
   440          "SecretArn":{"shape":"SecretArn"}
   441        }
   442      },
   443      "ListSchemasResponse":{
   444        "type":"structure",
   445        "members":{
   446          "NextToken":{"shape":"String"},
   447          "Schemas":{"shape":"SchemaList"}
   448        }
   449      },
   450      "ListStatementsLimit":{
   451        "type":"integer",
   452        "max":100,
   453        "min":0
   454      },
   455      "ListStatementsRequest":{
   456        "type":"structure",
   457        "members":{
   458          "MaxResults":{"shape":"ListStatementsLimit"},
   459          "NextToken":{"shape":"String"},
   460          "RoleLevel":{"shape":"Boolean"},
   461          "StatementName":{"shape":"StatementNameString"},
   462          "Status":{"shape":"StatusString"}
   463        }
   464      },
   465      "ListStatementsResponse":{
   466        "type":"structure",
   467        "required":["Statements"],
   468        "members":{
   469          "NextToken":{"shape":"String"},
   470          "Statements":{"shape":"StatementList"}
   471        }
   472      },
   473      "ListTablesRequest":{
   474        "type":"structure",
   475        "required":[
   476          "ClusterIdentifier",
   477          "Database"
   478        ],
   479        "members":{
   480          "ClusterIdentifier":{"shape":"Location"},
   481          "ConnectedDatabase":{"shape":"String"},
   482          "Database":{"shape":"String"},
   483          "DbUser":{"shape":"String"},
   484          "MaxResults":{"shape":"PageSize"},
   485          "NextToken":{"shape":"String"},
   486          "SchemaPattern":{"shape":"String"},
   487          "SecretArn":{"shape":"SecretArn"},
   488          "TablePattern":{"shape":"String"}
   489        }
   490      },
   491      "ListTablesResponse":{
   492        "type":"structure",
   493        "members":{
   494          "NextToken":{"shape":"String"},
   495          "Tables":{"shape":"TableList"}
   496        }
   497      },
   498      "Location":{"type":"string"},
   499      "Long":{"type":"long"},
   500      "PageSize":{
   501        "type":"integer",
   502        "max":1000,
   503        "min":0
   504      },
   505      "ParameterName":{
   506        "type":"string",
   507        "pattern":"^[0-9a-zA-Z_]+$"
   508      },
   509      "ParameterValue":{
   510        "type":"string",
   511        "min":1
   512      },
   513      "ResourceNotFoundException":{
   514        "type":"structure",
   515        "required":[
   516          "Message",
   517          "ResourceId"
   518        ],
   519        "members":{
   520          "Message":{"shape":"String"},
   521          "ResourceId":{"shape":"String"}
   522        },
   523        "exception":true
   524      },
   525      "SchemaList":{
   526        "type":"list",
   527        "member":{"shape":"String"}
   528      },
   529      "SecretArn":{"type":"string"},
   530      "SqlList":{
   531        "type":"list",
   532        "member":{"shape":"StatementString"},
   533        "max":40,
   534        "min":1
   535      },
   536      "SqlParameter":{
   537        "type":"structure",
   538        "required":[
   539          "name",
   540          "value"
   541        ],
   542        "members":{
   543          "name":{"shape":"ParameterName"},
   544          "value":{"shape":"ParameterValue"}
   545        }
   546      },
   547      "SqlParametersList":{
   548        "type":"list",
   549        "member":{"shape":"SqlParameter"},
   550        "min":1
   551      },
   552      "SqlRecords":{
   553        "type":"list",
   554        "member":{"shape":"FieldList"}
   555      },
   556      "StatementData":{
   557        "type":"structure",
   558        "required":["Id"],
   559        "members":{
   560          "CreatedAt":{"shape":"Timestamp"},
   561          "Id":{"shape":"StatementId"},
   562          "IsBatchStatement":{"shape":"Boolean"},
   563          "QueryParameters":{"shape":"SqlParametersList"},
   564          "QueryString":{"shape":"StatementString"},
   565          "QueryStrings":{"shape":"StatementStringList"},
   566          "SecretArn":{"shape":"SecretArn"},
   567          "StatementName":{"shape":"StatementNameString"},
   568          "Status":{"shape":"StatusString"},
   569          "UpdatedAt":{"shape":"Timestamp"}
   570        }
   571      },
   572      "StatementId":{
   573        "type":"string",
   574        "pattern":"^[a-z0-9]{8}(-[a-z0-9]{4}){3}-[a-z0-9]{12}(:\\d+)?$"
   575      },
   576      "StatementList":{
   577        "type":"list",
   578        "member":{"shape":"StatementData"}
   579      },
   580      "StatementNameString":{
   581        "type":"string",
   582        "max":500,
   583        "min":0
   584      },
   585      "StatementStatusString":{
   586        "type":"string",
   587        "enum":[
   588          "SUBMITTED",
   589          "PICKED",
   590          "STARTED",
   591          "FINISHED",
   592          "ABORTED",
   593          "FAILED"
   594        ]
   595      },
   596      "StatementString":{"type":"string"},
   597      "StatementStringList":{
   598        "type":"list",
   599        "member":{"shape":"StatementString"}
   600      },
   601      "StatusString":{
   602        "type":"string",
   603        "enum":[
   604          "SUBMITTED",
   605          "PICKED",
   606          "STARTED",
   607          "FINISHED",
   608          "ABORTED",
   609          "FAILED",
   610          "ALL"
   611        ]
   612      },
   613      "String":{"type":"string"},
   614      "SubStatementData":{
   615        "type":"structure",
   616        "required":["Id"],
   617        "members":{
   618          "CreatedAt":{"shape":"Timestamp"},
   619          "Duration":{"shape":"Long"},
   620          "Error":{"shape":"String"},
   621          "HasResultSet":{"shape":"Boolean"},
   622          "Id":{"shape":"StatementId"},
   623          "QueryString":{"shape":"StatementString"},
   624          "RedshiftQueryId":{"shape":"Long"},
   625          "ResultRows":{"shape":"Long"},
   626          "ResultSize":{"shape":"Long"},
   627          "Status":{"shape":"StatementStatusString"},
   628          "UpdatedAt":{"shape":"Timestamp"}
   629        }
   630      },
   631      "SubStatementList":{
   632        "type":"list",
   633        "member":{"shape":"SubStatementData"}
   634      },
   635      "TableList":{
   636        "type":"list",
   637        "member":{"shape":"TableMember"}
   638      },
   639      "TableMember":{
   640        "type":"structure",
   641        "members":{
   642          "name":{"shape":"String"},
   643          "schema":{"shape":"String"},
   644          "type":{"shape":"String"}
   645        }
   646      },
   647      "Timestamp":{"type":"timestamp"},
   648      "ValidationException":{
   649        "type":"structure",
   650        "members":{
   651          "Message":{"shape":"String"}
   652        },
   653        "exception":true
   654      },
   655      "bool":{"type":"boolean"}
   656    }
   657  }