github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ebs/2019-11-02/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2019-11-02",
     5      "endpointPrefix":"ebs",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceAbbreviation":"Amazon EBS",
     9      "serviceFullName":"Amazon Elastic Block Store",
    10      "serviceId":"EBS",
    11      "signatureVersion":"v4",
    12      "uid":"ebs-2019-11-02"
    13    },
    14    "operations":{
    15      "CompleteSnapshot":{
    16        "name":"CompleteSnapshot",
    17        "http":{
    18          "method":"POST",
    19          "requestUri":"/snapshots/completion/{snapshotId}",
    20          "responseCode":202
    21        },
    22        "input":{"shape":"CompleteSnapshotRequest"},
    23        "output":{"shape":"CompleteSnapshotResponse"},
    24        "errors":[
    25          {"shape":"AccessDeniedException"},
    26          {"shape":"ValidationException"},
    27          {"shape":"ResourceNotFoundException"},
    28          {"shape":"RequestThrottledException"},
    29          {"shape":"ServiceQuotaExceededException"},
    30          {"shape":"InternalServerException"}
    31        ]
    32      },
    33      "GetSnapshotBlock":{
    34        "name":"GetSnapshotBlock",
    35        "http":{
    36          "method":"GET",
    37          "requestUri":"/snapshots/{snapshotId}/blocks/{blockIndex}"
    38        },
    39        "input":{"shape":"GetSnapshotBlockRequest"},
    40        "output":{"shape":"GetSnapshotBlockResponse"},
    41        "errors":[
    42          {"shape":"AccessDeniedException"},
    43          {"shape":"ValidationException"},
    44          {"shape":"ResourceNotFoundException"},
    45          {"shape":"RequestThrottledException"},
    46          {"shape":"ServiceQuotaExceededException"},
    47          {"shape":"InternalServerException"}
    48        ]
    49      },
    50      "ListChangedBlocks":{
    51        "name":"ListChangedBlocks",
    52        "http":{
    53          "method":"GET",
    54          "requestUri":"/snapshots/{secondSnapshotId}/changedblocks"
    55        },
    56        "input":{"shape":"ListChangedBlocksRequest"},
    57        "output":{"shape":"ListChangedBlocksResponse"},
    58        "errors":[
    59          {"shape":"AccessDeniedException"},
    60          {"shape":"ValidationException"},
    61          {"shape":"ResourceNotFoundException"},
    62          {"shape":"RequestThrottledException"},
    63          {"shape":"ServiceQuotaExceededException"},
    64          {"shape":"InternalServerException"}
    65        ]
    66      },
    67      "ListSnapshotBlocks":{
    68        "name":"ListSnapshotBlocks",
    69        "http":{
    70          "method":"GET",
    71          "requestUri":"/snapshots/{snapshotId}/blocks"
    72        },
    73        "input":{"shape":"ListSnapshotBlocksRequest"},
    74        "output":{"shape":"ListSnapshotBlocksResponse"},
    75        "errors":[
    76          {"shape":"AccessDeniedException"},
    77          {"shape":"ValidationException"},
    78          {"shape":"ResourceNotFoundException"},
    79          {"shape":"RequestThrottledException"},
    80          {"shape":"ServiceQuotaExceededException"},
    81          {"shape":"InternalServerException"}
    82        ]
    83      },
    84      "PutSnapshotBlock":{
    85        "name":"PutSnapshotBlock",
    86        "http":{
    87          "method":"PUT",
    88          "requestUri":"/snapshots/{snapshotId}/blocks/{blockIndex}",
    89          "responseCode":201
    90        },
    91        "input":{"shape":"PutSnapshotBlockRequest"},
    92        "output":{"shape":"PutSnapshotBlockResponse"},
    93        "errors":[
    94          {"shape":"AccessDeniedException"},
    95          {"shape":"ValidationException"},
    96          {"shape":"ResourceNotFoundException"},
    97          {"shape":"RequestThrottledException"},
    98          {"shape":"ServiceQuotaExceededException"},
    99          {"shape":"InternalServerException"}
   100        ],
   101        "authtype":"v4-unsigned-body"
   102      },
   103      "StartSnapshot":{
   104        "name":"StartSnapshot",
   105        "http":{
   106          "method":"POST",
   107          "requestUri":"/snapshots",
   108          "responseCode":201
   109        },
   110        "input":{"shape":"StartSnapshotRequest"},
   111        "output":{"shape":"StartSnapshotResponse"},
   112        "errors":[
   113          {"shape":"AccessDeniedException"},
   114          {"shape":"ValidationException"},
   115          {"shape":"RequestThrottledException"},
   116          {"shape":"ResourceNotFoundException"},
   117          {"shape":"ServiceQuotaExceededException"},
   118          {"shape":"InternalServerException"},
   119          {"shape":"ConcurrentLimitExceededException"},
   120          {"shape":"ConflictException"}
   121        ]
   122      }
   123    },
   124    "shapes":{
   125      "AccessDeniedException":{
   126        "type":"structure",
   127        "required":["Reason"],
   128        "members":{
   129          "Message":{"shape":"ErrorMessage"},
   130          "Reason":{"shape":"AccessDeniedExceptionReason"}
   131        },
   132        "error":{"httpStatusCode":403},
   133        "exception":true
   134      },
   135      "AccessDeniedExceptionReason":{
   136        "type":"string",
   137        "enum":[
   138          "UNAUTHORIZED_ACCOUNT",
   139          "DEPENDENCY_ACCESS_DENIED"
   140        ]
   141      },
   142      "Block":{
   143        "type":"structure",
   144        "members":{
   145          "BlockIndex":{"shape":"BlockIndex"},
   146          "BlockToken":{"shape":"BlockToken"}
   147        }
   148      },
   149      "BlockData":{
   150        "type":"blob",
   151        "sensitive":true,
   152        "streaming":true
   153      },
   154      "BlockIndex":{
   155        "type":"integer",
   156        "min":0
   157      },
   158      "BlockSize":{"type":"integer"},
   159      "BlockToken":{
   160        "type":"string",
   161        "max":256,
   162        "pattern":"^[A-Za-z0-9+/=]+$"
   163      },
   164      "Blocks":{
   165        "type":"list",
   166        "member":{"shape":"Block"},
   167        "sensitive":true
   168      },
   169      "Boolean":{"type":"boolean"},
   170      "ChangedBlock":{
   171        "type":"structure",
   172        "members":{
   173          "BlockIndex":{"shape":"BlockIndex"},
   174          "FirstBlockToken":{"shape":"BlockToken"},
   175          "SecondBlockToken":{"shape":"BlockToken"}
   176        },
   177        "sensitive":true
   178      },
   179      "ChangedBlocks":{
   180        "type":"list",
   181        "member":{"shape":"ChangedBlock"}
   182      },
   183      "ChangedBlocksCount":{
   184        "type":"integer",
   185        "min":0
   186      },
   187      "Checksum":{
   188        "type":"string",
   189        "max":64,
   190        "pattern":"^[A-Za-z0-9+/=]+$"
   191      },
   192      "ChecksumAggregationMethod":{
   193        "type":"string",
   194        "enum":["LINEAR"],
   195        "max":32,
   196        "pattern":"^[A-Za-z0-9]+$"
   197      },
   198      "ChecksumAlgorithm":{
   199        "type":"string",
   200        "enum":["SHA256"],
   201        "max":32,
   202        "pattern":"^[A-Za-z0-9]+$"
   203      },
   204      "CompleteSnapshotRequest":{
   205        "type":"structure",
   206        "required":[
   207          "SnapshotId",
   208          "ChangedBlocksCount"
   209        ],
   210        "members":{
   211          "SnapshotId":{
   212            "shape":"SnapshotId",
   213            "location":"uri",
   214            "locationName":"snapshotId"
   215          },
   216          "ChangedBlocksCount":{
   217            "shape":"ChangedBlocksCount",
   218            "location":"header",
   219            "locationName":"x-amz-ChangedBlocksCount"
   220          },
   221          "Checksum":{
   222            "shape":"Checksum",
   223            "location":"header",
   224            "locationName":"x-amz-Checksum"
   225          },
   226          "ChecksumAlgorithm":{
   227            "shape":"ChecksumAlgorithm",
   228            "location":"header",
   229            "locationName":"x-amz-Checksum-Algorithm"
   230          },
   231          "ChecksumAggregationMethod":{
   232            "shape":"ChecksumAggregationMethod",
   233            "location":"header",
   234            "locationName":"x-amz-Checksum-Aggregation-Method"
   235          }
   236        }
   237      },
   238      "CompleteSnapshotResponse":{
   239        "type":"structure",
   240        "members":{
   241          "Status":{"shape":"Status"}
   242        }
   243      },
   244      "ConcurrentLimitExceededException":{
   245        "type":"structure",
   246        "members":{
   247          "Message":{"shape":"ErrorMessage"}
   248        },
   249        "error":{"httpStatusCode":400},
   250        "exception":true
   251      },
   252      "ConflictException":{
   253        "type":"structure",
   254        "members":{
   255          "Message":{"shape":"ErrorMessage"}
   256        },
   257        "error":{"httpStatusCode":503},
   258        "exception":true
   259      },
   260      "DataLength":{"type":"integer"},
   261      "Description":{
   262        "type":"string",
   263        "max":255,
   264        "pattern":"^[\\S\\s]+$"
   265      },
   266      "ErrorMessage":{
   267        "type":"string",
   268        "max":256
   269      },
   270      "GetSnapshotBlockRequest":{
   271        "type":"structure",
   272        "required":[
   273          "SnapshotId",
   274          "BlockIndex",
   275          "BlockToken"
   276        ],
   277        "members":{
   278          "SnapshotId":{
   279            "shape":"SnapshotId",
   280            "location":"uri",
   281            "locationName":"snapshotId"
   282          },
   283          "BlockIndex":{
   284            "shape":"BlockIndex",
   285            "location":"uri",
   286            "locationName":"blockIndex"
   287          },
   288          "BlockToken":{
   289            "shape":"BlockToken",
   290            "location":"querystring",
   291            "locationName":"blockToken"
   292          }
   293        }
   294      },
   295      "GetSnapshotBlockResponse":{
   296        "type":"structure",
   297        "members":{
   298          "DataLength":{
   299            "shape":"DataLength",
   300            "location":"header",
   301            "locationName":"x-amz-Data-Length"
   302          },
   303          "BlockData":{"shape":"BlockData"},
   304          "Checksum":{
   305            "shape":"Checksum",
   306            "location":"header",
   307            "locationName":"x-amz-Checksum"
   308          },
   309          "ChecksumAlgorithm":{
   310            "shape":"ChecksumAlgorithm",
   311            "location":"header",
   312            "locationName":"x-amz-Checksum-Algorithm"
   313          }
   314        },
   315        "payload":"BlockData"
   316      },
   317      "IdempotencyToken":{
   318        "type":"string",
   319        "max":255,
   320        "pattern":"^[\\S]+$"
   321      },
   322      "InternalServerException":{
   323        "type":"structure",
   324        "members":{
   325          "Message":{"shape":"ErrorMessage"}
   326        },
   327        "error":{"httpStatusCode":500},
   328        "exception":true,
   329        "fault":true
   330      },
   331      "KmsKeyArn":{
   332        "type":"string",
   333        "max":2048,
   334        "min":1,
   335        "pattern":"arn:aws[a-z\\-]*:kms:.*:[0-9]{12}:key/.*",
   336        "sensitive":true
   337      },
   338      "ListChangedBlocksRequest":{
   339        "type":"structure",
   340        "required":["SecondSnapshotId"],
   341        "members":{
   342          "FirstSnapshotId":{
   343            "shape":"SnapshotId",
   344            "location":"querystring",
   345            "locationName":"firstSnapshotId"
   346          },
   347          "SecondSnapshotId":{
   348            "shape":"SnapshotId",
   349            "location":"uri",
   350            "locationName":"secondSnapshotId"
   351          },
   352          "NextToken":{
   353            "shape":"PageToken",
   354            "location":"querystring",
   355            "locationName":"pageToken"
   356          },
   357          "MaxResults":{
   358            "shape":"MaxResults",
   359            "location":"querystring",
   360            "locationName":"maxResults"
   361          },
   362          "StartingBlockIndex":{
   363            "shape":"BlockIndex",
   364            "location":"querystring",
   365            "locationName":"startingBlockIndex"
   366          }
   367        }
   368      },
   369      "ListChangedBlocksResponse":{
   370        "type":"structure",
   371        "members":{
   372          "ChangedBlocks":{"shape":"ChangedBlocks"},
   373          "ExpiryTime":{"shape":"TimeStamp"},
   374          "VolumeSize":{"shape":"VolumeSize"},
   375          "BlockSize":{"shape":"BlockSize"},
   376          "NextToken":{"shape":"PageToken"}
   377        }
   378      },
   379      "ListSnapshotBlocksRequest":{
   380        "type":"structure",
   381        "required":["SnapshotId"],
   382        "members":{
   383          "SnapshotId":{
   384            "shape":"SnapshotId",
   385            "location":"uri",
   386            "locationName":"snapshotId"
   387          },
   388          "NextToken":{
   389            "shape":"PageToken",
   390            "location":"querystring",
   391            "locationName":"pageToken"
   392          },
   393          "MaxResults":{
   394            "shape":"MaxResults",
   395            "location":"querystring",
   396            "locationName":"maxResults"
   397          },
   398          "StartingBlockIndex":{
   399            "shape":"BlockIndex",
   400            "location":"querystring",
   401            "locationName":"startingBlockIndex"
   402          }
   403        }
   404      },
   405      "ListSnapshotBlocksResponse":{
   406        "type":"structure",
   407        "members":{
   408          "Blocks":{"shape":"Blocks"},
   409          "ExpiryTime":{"shape":"TimeStamp"},
   410          "VolumeSize":{"shape":"VolumeSize"},
   411          "BlockSize":{"shape":"BlockSize"},
   412          "NextToken":{"shape":"PageToken"}
   413        }
   414      },
   415      "MaxResults":{
   416        "type":"integer",
   417        "max":10000,
   418        "min":100
   419      },
   420      "OwnerId":{
   421        "type":"string",
   422        "max":24,
   423        "min":1,
   424        "pattern":"\\S+"
   425      },
   426      "PageToken":{
   427        "type":"string",
   428        "max":256,
   429        "pattern":"^[A-Za-z0-9+/=]+$"
   430      },
   431      "Progress":{
   432        "type":"integer",
   433        "max":100,
   434        "min":0
   435      },
   436      "PutSnapshotBlockRequest":{
   437        "type":"structure",
   438        "required":[
   439          "SnapshotId",
   440          "BlockIndex",
   441          "BlockData",
   442          "DataLength",
   443          "Checksum",
   444          "ChecksumAlgorithm"
   445        ],
   446        "members":{
   447          "SnapshotId":{
   448            "shape":"SnapshotId",
   449            "location":"uri",
   450            "locationName":"snapshotId"
   451          },
   452          "BlockIndex":{
   453            "shape":"BlockIndex",
   454            "location":"uri",
   455            "locationName":"blockIndex"
   456          },
   457          "BlockData":{"shape":"BlockData"},
   458          "DataLength":{
   459            "shape":"DataLength",
   460            "location":"header",
   461            "locationName":"x-amz-Data-Length"
   462          },
   463          "Progress":{
   464            "shape":"Progress",
   465            "location":"header",
   466            "locationName":"x-amz-Progress"
   467          },
   468          "Checksum":{
   469            "shape":"Checksum",
   470            "location":"header",
   471            "locationName":"x-amz-Checksum"
   472          },
   473          "ChecksumAlgorithm":{
   474            "shape":"ChecksumAlgorithm",
   475            "location":"header",
   476            "locationName":"x-amz-Checksum-Algorithm"
   477          }
   478        },
   479        "payload":"BlockData"
   480      },
   481      "PutSnapshotBlockResponse":{
   482        "type":"structure",
   483        "members":{
   484          "Checksum":{
   485            "shape":"Checksum",
   486            "location":"header",
   487            "locationName":"x-amz-Checksum"
   488          },
   489          "ChecksumAlgorithm":{
   490            "shape":"ChecksumAlgorithm",
   491            "location":"header",
   492            "locationName":"x-amz-Checksum-Algorithm"
   493          }
   494        }
   495      },
   496      "RequestThrottledException":{
   497        "type":"structure",
   498        "members":{
   499          "Message":{"shape":"ErrorMessage"},
   500          "Reason":{"shape":"RequestThrottledExceptionReason"}
   501        },
   502        "error":{"httpStatusCode":400},
   503        "exception":true
   504      },
   505      "RequestThrottledExceptionReason":{
   506        "type":"string",
   507        "enum":[
   508          "ACCOUNT_THROTTLED",
   509          "DEPENDENCY_REQUEST_THROTTLED"
   510        ]
   511      },
   512      "ResourceNotFoundException":{
   513        "type":"structure",
   514        "members":{
   515          "Message":{"shape":"ErrorMessage"},
   516          "Reason":{"shape":"ResourceNotFoundExceptionReason"}
   517        },
   518        "error":{"httpStatusCode":404},
   519        "exception":true
   520      },
   521      "ResourceNotFoundExceptionReason":{
   522        "type":"string",
   523        "enum":[
   524          "SNAPSHOT_NOT_FOUND",
   525          "DEPENDENCY_RESOURCE_NOT_FOUND"
   526        ]
   527      },
   528      "ServiceQuotaExceededException":{
   529        "type":"structure",
   530        "members":{
   531          "Message":{"shape":"ErrorMessage"},
   532          "Reason":{"shape":"ServiceQuotaExceededExceptionReason"}
   533        },
   534        "error":{"httpStatusCode":402},
   535        "exception":true
   536      },
   537      "ServiceQuotaExceededExceptionReason":{
   538        "type":"string",
   539        "enum":["DEPENDENCY_SERVICE_QUOTA_EXCEEDED"]
   540      },
   541      "SnapshotId":{
   542        "type":"string",
   543        "max":64,
   544        "min":1,
   545        "pattern":"^snap-[0-9a-f]+$"
   546      },
   547      "StartSnapshotRequest":{
   548        "type":"structure",
   549        "required":["VolumeSize"],
   550        "members":{
   551          "VolumeSize":{"shape":"VolumeSize"},
   552          "ParentSnapshotId":{"shape":"SnapshotId"},
   553          "Tags":{"shape":"Tags"},
   554          "Description":{"shape":"Description"},
   555          "ClientToken":{
   556            "shape":"IdempotencyToken",
   557            "idempotencyToken":true
   558          },
   559          "Encrypted":{"shape":"Boolean"},
   560          "KmsKeyArn":{"shape":"KmsKeyArn"},
   561          "Timeout":{"shape":"Timeout"}
   562        }
   563      },
   564      "StartSnapshotResponse":{
   565        "type":"structure",
   566        "members":{
   567          "Description":{"shape":"Description"},
   568          "SnapshotId":{"shape":"SnapshotId"},
   569          "OwnerId":{"shape":"OwnerId"},
   570          "Status":{"shape":"Status"},
   571          "StartTime":{"shape":"TimeStamp"},
   572          "VolumeSize":{"shape":"VolumeSize"},
   573          "BlockSize":{"shape":"BlockSize"},
   574          "Tags":{"shape":"Tags"},
   575          "ParentSnapshotId":{"shape":"SnapshotId"},
   576          "KmsKeyArn":{"shape":"KmsKeyArn"}
   577        }
   578      },
   579      "Status":{
   580        "type":"string",
   581        "enum":[
   582          "completed",
   583          "pending",
   584          "error"
   585        ],
   586        "max":32
   587      },
   588      "Tag":{
   589        "type":"structure",
   590        "members":{
   591          "Key":{"shape":"TagKey"},
   592          "Value":{"shape":"TagValue"}
   593        }
   594      },
   595      "TagKey":{
   596        "type":"string",
   597        "max":127,
   598        "pattern":"^[\\S\\s]+$"
   599      },
   600      "TagValue":{
   601        "type":"string",
   602        "max":255,
   603        "pattern":"^[\\S\\s]+$"
   604      },
   605      "Tags":{
   606        "type":"list",
   607        "member":{"shape":"Tag"}
   608      },
   609      "TimeStamp":{"type":"timestamp"},
   610      "Timeout":{
   611        "type":"integer",
   612        "max":60,
   613        "min":10
   614      },
   615      "ValidationException":{
   616        "type":"structure",
   617        "members":{
   618          "Message":{"shape":"ErrorMessage"},
   619          "Reason":{"shape":"ValidationExceptionReason"}
   620        },
   621        "error":{"httpStatusCode":400},
   622        "exception":true
   623      },
   624      "ValidationExceptionReason":{
   625        "type":"string",
   626        "enum":[
   627          "INVALID_CUSTOMER_KEY",
   628          "INVALID_PAGE_TOKEN",
   629          "INVALID_BLOCK_TOKEN",
   630          "INVALID_SNAPSHOT_ID",
   631          "UNRELATED_SNAPSHOTS",
   632          "INVALID_BLOCK",
   633          "INVALID_CONTENT_ENCODING",
   634          "INVALID_TAG",
   635          "INVALID_DEPENDENCY_REQUEST",
   636          "INVALID_PARAMETER_VALUE",
   637          "INVALID_VOLUME_SIZE"
   638        ]
   639      },
   640      "VolumeSize":{
   641        "type":"long",
   642        "min":1
   643      }
   644    }
   645  }