github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/streams.dynamodb/2012-08-10/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2012-08-10",
     5      "endpointPrefix":"streams.dynamodb",
     6      "jsonVersion":"1.0",
     7      "protocol":"json",
     8      "serviceFullName":"Amazon DynamoDB Streams",
     9      "serviceId":"DynamoDB Streams",
    10      "signatureVersion":"v4",
    11      "signingName":"dynamodb",
    12      "targetPrefix":"DynamoDBStreams_20120810",
    13      "uid":"streams-dynamodb-2012-08-10"
    14    },
    15    "operations":{
    16      "DescribeStream":{
    17        "name":"DescribeStream",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/"
    21        },
    22        "input":{"shape":"DescribeStreamInput"},
    23        "output":{"shape":"DescribeStreamOutput"},
    24        "errors":[
    25          {"shape":"ResourceNotFoundException"},
    26          {"shape":"InternalServerError"}
    27        ]
    28      },
    29      "GetRecords":{
    30        "name":"GetRecords",
    31        "http":{
    32          "method":"POST",
    33          "requestUri":"/"
    34        },
    35        "input":{"shape":"GetRecordsInput"},
    36        "output":{"shape":"GetRecordsOutput"},
    37        "errors":[
    38          {"shape":"ResourceNotFoundException"},
    39          {"shape":"LimitExceededException"},
    40          {"shape":"InternalServerError"},
    41          {"shape":"ExpiredIteratorException"},
    42          {"shape":"TrimmedDataAccessException"}
    43        ]
    44      },
    45      "GetShardIterator":{
    46        "name":"GetShardIterator",
    47        "http":{
    48          "method":"POST",
    49          "requestUri":"/"
    50        },
    51        "input":{"shape":"GetShardIteratorInput"},
    52        "output":{"shape":"GetShardIteratorOutput"},
    53        "errors":[
    54          {"shape":"ResourceNotFoundException"},
    55          {"shape":"InternalServerError"},
    56          {"shape":"TrimmedDataAccessException"}
    57        ]
    58      },
    59      "ListStreams":{
    60        "name":"ListStreams",
    61        "http":{
    62          "method":"POST",
    63          "requestUri":"/"
    64        },
    65        "input":{"shape":"ListStreamsInput"},
    66        "output":{"shape":"ListStreamsOutput"},
    67        "errors":[
    68          {"shape":"ResourceNotFoundException"},
    69          {"shape":"InternalServerError"}
    70        ]
    71      }
    72    },
    73    "shapes":{
    74      "AttributeMap":{
    75        "type":"map",
    76        "key":{"shape":"AttributeName"},
    77        "value":{"shape":"AttributeValue"}
    78      },
    79      "AttributeName":{
    80        "type":"string",
    81        "max":65535
    82      },
    83      "AttributeValue":{
    84        "type":"structure",
    85        "members":{
    86          "S":{"shape":"StringAttributeValue"},
    87          "N":{"shape":"NumberAttributeValue"},
    88          "B":{"shape":"BinaryAttributeValue"},
    89          "SS":{"shape":"StringSetAttributeValue"},
    90          "NS":{"shape":"NumberSetAttributeValue"},
    91          "BS":{"shape":"BinarySetAttributeValue"},
    92          "M":{"shape":"MapAttributeValue"},
    93          "L":{"shape":"ListAttributeValue"},
    94          "NULL":{"shape":"NullAttributeValue"},
    95          "BOOL":{"shape":"BooleanAttributeValue"}
    96        }
    97      },
    98      "BinaryAttributeValue":{"type":"blob"},
    99      "BinarySetAttributeValue":{
   100        "type":"list",
   101        "member":{"shape":"BinaryAttributeValue"}
   102      },
   103      "BooleanAttributeValue":{"type":"boolean"},
   104      "Date":{"type":"timestamp"},
   105      "DescribeStreamInput":{
   106        "type":"structure",
   107        "required":["StreamArn"],
   108        "members":{
   109          "StreamArn":{"shape":"StreamArn"},
   110          "Limit":{"shape":"PositiveIntegerObject"},
   111          "ExclusiveStartShardId":{"shape":"ShardId"}
   112        }
   113      },
   114      "DescribeStreamOutput":{
   115        "type":"structure",
   116        "members":{
   117          "StreamDescription":{"shape":"StreamDescription"}
   118        }
   119      },
   120      "ErrorMessage":{"type":"string"},
   121      "ExpiredIteratorException":{
   122        "type":"structure",
   123        "members":{
   124          "message":{"shape":"ErrorMessage"}
   125        },
   126        "exception":true
   127      },
   128      "GetRecordsInput":{
   129        "type":"structure",
   130        "required":["ShardIterator"],
   131        "members":{
   132          "ShardIterator":{"shape":"ShardIterator"},
   133          "Limit":{"shape":"PositiveIntegerObject"}
   134        }
   135      },
   136      "GetRecordsOutput":{
   137        "type":"structure",
   138        "members":{
   139          "Records":{"shape":"RecordList"},
   140          "NextShardIterator":{"shape":"ShardIterator"}
   141        }
   142      },
   143      "GetShardIteratorInput":{
   144        "type":"structure",
   145        "required":[
   146          "StreamArn",
   147          "ShardId",
   148          "ShardIteratorType"
   149        ],
   150        "members":{
   151          "StreamArn":{"shape":"StreamArn"},
   152          "ShardId":{"shape":"ShardId"},
   153          "ShardIteratorType":{"shape":"ShardIteratorType"},
   154          "SequenceNumber":{"shape":"SequenceNumber"}
   155        }
   156      },
   157      "GetShardIteratorOutput":{
   158        "type":"structure",
   159        "members":{
   160          "ShardIterator":{"shape":"ShardIterator"}
   161        }
   162      },
   163      "Identity":{
   164        "type":"structure",
   165        "members":{
   166          "PrincipalId":{"shape":"String"},
   167          "Type":{"shape":"String"}
   168        }
   169      },
   170      "InternalServerError":{
   171        "type":"structure",
   172        "members":{
   173          "message":{"shape":"ErrorMessage"}
   174        },
   175        "exception":true,
   176        "fault":true
   177      },
   178      "KeySchema":{
   179        "type":"list",
   180        "member":{"shape":"KeySchemaElement"},
   181        "max":2,
   182        "min":1
   183      },
   184      "KeySchemaAttributeName":{
   185        "type":"string",
   186        "max":255,
   187        "min":1
   188      },
   189      "KeySchemaElement":{
   190        "type":"structure",
   191        "required":[
   192          "AttributeName",
   193          "KeyType"
   194        ],
   195        "members":{
   196          "AttributeName":{"shape":"KeySchemaAttributeName"},
   197          "KeyType":{"shape":"KeyType"}
   198        }
   199      },
   200      "KeyType":{
   201        "type":"string",
   202        "enum":[
   203          "HASH",
   204          "RANGE"
   205        ]
   206      },
   207      "LimitExceededException":{
   208        "type":"structure",
   209        "members":{
   210          "message":{"shape":"ErrorMessage"}
   211        },
   212        "exception":true
   213      },
   214      "ListAttributeValue":{
   215        "type":"list",
   216        "member":{"shape":"AttributeValue"}
   217      },
   218      "ListStreamsInput":{
   219        "type":"structure",
   220        "members":{
   221          "TableName":{"shape":"TableName"},
   222          "Limit":{"shape":"PositiveIntegerObject"},
   223          "ExclusiveStartStreamArn":{"shape":"StreamArn"}
   224        }
   225      },
   226      "ListStreamsOutput":{
   227        "type":"structure",
   228        "members":{
   229          "Streams":{"shape":"StreamList"},
   230          "LastEvaluatedStreamArn":{"shape":"StreamArn"}
   231        }
   232      },
   233      "MapAttributeValue":{
   234        "type":"map",
   235        "key":{"shape":"AttributeName"},
   236        "value":{"shape":"AttributeValue"}
   237      },
   238      "NullAttributeValue":{"type":"boolean"},
   239      "NumberAttributeValue":{"type":"string"},
   240      "NumberSetAttributeValue":{
   241        "type":"list",
   242        "member":{"shape":"NumberAttributeValue"}
   243      },
   244      "OperationType":{
   245        "type":"string",
   246        "enum":[
   247          "INSERT",
   248          "MODIFY",
   249          "REMOVE"
   250        ]
   251      },
   252      "PositiveIntegerObject":{
   253        "type":"integer",
   254        "min":1
   255      },
   256      "PositiveLongObject":{
   257        "type":"long",
   258        "min":1
   259      },
   260      "Record":{
   261        "type":"structure",
   262        "members":{
   263          "eventID":{"shape":"String"},
   264          "eventName":{"shape":"OperationType"},
   265          "eventVersion":{"shape":"String"},
   266          "eventSource":{"shape":"String"},
   267          "awsRegion":{"shape":"String"},
   268          "dynamodb":{"shape":"StreamRecord"},
   269          "userIdentity":{"shape":"Identity"}
   270        }
   271      },
   272      "RecordList":{
   273        "type":"list",
   274        "member":{"shape":"Record"}
   275      },
   276      "ResourceNotFoundException":{
   277        "type":"structure",
   278        "members":{
   279          "message":{"shape":"ErrorMessage"}
   280        },
   281        "exception":true
   282      },
   283      "SequenceNumber":{
   284        "type":"string",
   285        "max":40,
   286        "min":21
   287      },
   288      "SequenceNumberRange":{
   289        "type":"structure",
   290        "members":{
   291          "StartingSequenceNumber":{"shape":"SequenceNumber"},
   292          "EndingSequenceNumber":{"shape":"SequenceNumber"}
   293        }
   294      },
   295      "Shard":{
   296        "type":"structure",
   297        "members":{
   298          "ShardId":{"shape":"ShardId"},
   299          "SequenceNumberRange":{"shape":"SequenceNumberRange"},
   300          "ParentShardId":{"shape":"ShardId"}
   301        }
   302      },
   303      "ShardDescriptionList":{
   304        "type":"list",
   305        "member":{"shape":"Shard"}
   306      },
   307      "ShardId":{
   308        "type":"string",
   309        "max":65,
   310        "min":28
   311      },
   312      "ShardIterator":{
   313        "type":"string",
   314        "max":2048,
   315        "min":1
   316      },
   317      "ShardIteratorType":{
   318        "type":"string",
   319        "enum":[
   320          "TRIM_HORIZON",
   321          "LATEST",
   322          "AT_SEQUENCE_NUMBER",
   323          "AFTER_SEQUENCE_NUMBER"
   324        ]
   325      },
   326      "Stream":{
   327        "type":"structure",
   328        "members":{
   329          "StreamArn":{"shape":"StreamArn"},
   330          "TableName":{"shape":"TableName"},
   331          "StreamLabel":{"shape":"String"}
   332        }
   333      },
   334      "StreamArn":{
   335        "type":"string",
   336        "max":1024,
   337        "min":37
   338      },
   339      "StreamDescription":{
   340        "type":"structure",
   341        "members":{
   342          "StreamArn":{"shape":"StreamArn"},
   343          "StreamLabel":{"shape":"String"},
   344          "StreamStatus":{"shape":"StreamStatus"},
   345          "StreamViewType":{"shape":"StreamViewType"},
   346          "CreationRequestDateTime":{"shape":"Date"},
   347          "TableName":{"shape":"TableName"},
   348          "KeySchema":{"shape":"KeySchema"},
   349          "Shards":{"shape":"ShardDescriptionList"},
   350          "LastEvaluatedShardId":{"shape":"ShardId"}
   351        }
   352      },
   353      "StreamList":{
   354        "type":"list",
   355        "member":{"shape":"Stream"}
   356      },
   357      "StreamRecord":{
   358        "type":"structure",
   359        "members":{
   360          "ApproximateCreationDateTime":{"shape":"Date"},
   361          "Keys":{"shape":"AttributeMap"},
   362          "NewImage":{"shape":"AttributeMap"},
   363          "OldImage":{"shape":"AttributeMap"},
   364          "SequenceNumber":{"shape":"SequenceNumber"},
   365          "SizeBytes":{"shape":"PositiveLongObject"},
   366          "StreamViewType":{"shape":"StreamViewType"}
   367        }
   368      },
   369      "StreamStatus":{
   370        "type":"string",
   371        "enum":[
   372          "ENABLING",
   373          "ENABLED",
   374          "DISABLING",
   375          "DISABLED"
   376        ]
   377      },
   378      "StreamViewType":{
   379        "type":"string",
   380        "enum":[
   381          "NEW_IMAGE",
   382          "OLD_IMAGE",
   383          "NEW_AND_OLD_IMAGES",
   384          "KEYS_ONLY"
   385        ]
   386      },
   387      "String":{"type":"string"},
   388      "StringAttributeValue":{"type":"string"},
   389      "StringSetAttributeValue":{
   390        "type":"list",
   391        "member":{"shape":"StringAttributeValue"}
   392      },
   393      "TableName":{
   394        "type":"string",
   395        "max":255,
   396        "min":3,
   397        "pattern":"[a-zA-Z0-9_.-]+"
   398      },
   399      "TrimmedDataAccessException":{
   400        "type":"structure",
   401        "members":{
   402          "message":{"shape":"ErrorMessage"}
   403        },
   404        "exception":true
   405      }
   406    }
   407  }