ben
/
be-ytb


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
							{
  "version": "2.0",
  "metadata": {
    "apiVersion": "2022-11-28",
    "endpointPrefix": "docdb-elastic",
    "jsonVersion": "1.1",
    "protocol": "rest-json",
    "serviceAbbreviation": "DocDB Elastic",
    "serviceFullName": "Amazon DocumentDB Elastic Clusters",
    "serviceId": "DocDB Elastic",
    "signatureVersion": "v4",
    "signingName": "docdb-elastic",
    "uid": "docdb-elastic-2022-11-28"
  },
  "operations": {
    "CopyClusterSnapshot": {
      "http": {
        "requestUri": "/cluster-snapshot/{snapshotArn}/copy",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "snapshotArn",
          "targetSnapshotName"
        ],
        "members": {
          "copyTags": {
            "type": "boolean"
          },
          "kmsKeyId": {},
          "snapshotArn": {
            "location": "uri",
            "locationName": "snapshotArn"
          },
          "tags": {
            "shape": "S4"
          },
          "targetSnapshotName": {}
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "snapshot"
        ],
        "members": {
          "snapshot": {
            "shape": "S9"
          }
        }
      },
      "idempotent": true
    },
    "CreateCluster": {
      "http": {
        "requestUri": "/cluster",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "adminUserName",
          "adminUserPassword",
          "authType",
          "clusterName",
          "shardCapacity",
          "shardCount"
        ],
        "members": {
          "adminUserName": {},
          "adminUserPassword": {
            "shape": "Se"
          },
          "authType": {},
          "backupRetentionPeriod": {
            "type": "integer"
          },
          "clientToken": {
            "idempotencyToken": true
          },
          "clusterName": {},
          "kmsKeyId": {},
          "preferredBackupWindow": {},
          "preferredMaintenanceWindow": {},
          "shardCapacity": {
            "type": "integer"
          },
          "shardCount": {
            "type": "integer"
          },
          "shardInstanceCount": {
            "type": "integer"
          },
          "subnetIds": {
            "shape": "Sc"
          },
          "tags": {
            "shape": "S4"
          },
          "vpcSecurityGroupIds": {
            "shape": "Sc"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    },
    "CreateClusterSnapshot": {
      "http": {
        "requestUri": "/cluster-snapshot",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn",
          "snapshotName"
        ],
        "members": {
          "clusterArn": {},
          "snapshotName": {},
          "tags": {
            "shape": "S4"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "snapshot"
        ],
        "members": {
          "snapshot": {
            "shape": "S9"
          }
        }
      },
      "idempotent": true
    },
    "DeleteCluster": {
      "http": {
        "method": "DELETE",
        "requestUri": "/cluster/{clusterArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn"
        ],
        "members": {
          "clusterArn": {
            "location": "uri",
            "locationName": "clusterArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    },
    "DeleteClusterSnapshot": {
      "http": {
        "method": "DELETE",
        "requestUri": "/cluster-snapshot/{snapshotArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "snapshotArn"
        ],
        "members": {
          "snapshotArn": {
            "location": "uri",
            "locationName": "snapshotArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "snapshot"
        ],
        "members": {
          "snapshot": {
            "shape": "S9"
          }
        }
      },
      "idempotent": true
    },
    "GetCluster": {
      "http": {
        "method": "GET",
        "requestUri": "/cluster/{clusterArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn"
        ],
        "members": {
          "clusterArn": {
            "location": "uri",
            "locationName": "clusterArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      }
    },
    "GetClusterSnapshot": {
      "http": {
        "method": "GET",
        "requestUri": "/cluster-snapshot/{snapshotArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "snapshotArn"
        ],
        "members": {
          "snapshotArn": {
            "location": "uri",
            "locationName": "snapshotArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "snapshot"
        ],
        "members": {
          "snapshot": {
            "shape": "S9"
          }
        }
      }
    },
    "ListClusterSnapshots": {
      "http": {
        "method": "GET",
        "requestUri": "/cluster-snapshots",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "members": {
          "clusterArn": {
            "location": "querystring",
            "locationName": "clusterArn"
          },
          "maxResults": {
            "location": "querystring",
            "locationName": "maxResults",
            "type": "integer"
          },
          "nextToken": {
            "location": "querystring",
            "locationName": "nextToken"
          },
          "snapshotType": {
            "location": "querystring",
            "locationName": "snapshotType"
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {
          "nextToken": {},
          "snapshots": {
            "type": "list",
            "member": {
              "type": "structure",
              "required": [
                "clusterArn",
                "snapshotArn",
                "snapshotCreationTime",
                "snapshotName",
                "status"
              ],
              "members": {
                "clusterArn": {},
                "snapshotArn": {},
                "snapshotCreationTime": {},
                "snapshotName": {},
                "status": {}
              }
            }
          }
        }
      }
    },
    "ListClusters": {
      "http": {
        "method": "GET",
        "requestUri": "/clusters",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "members": {
          "maxResults": {
            "location": "querystring",
            "locationName": "maxResults",
            "type": "integer"
          },
          "nextToken": {
            "location": "querystring",
            "locationName": "nextToken"
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {
          "clusters": {
            "type": "list",
            "member": {
              "type": "structure",
              "required": [
                "clusterArn",
                "clusterName",
                "status"
              ],
              "members": {
                "clusterArn": {},
                "clusterName": {},
                "status": {}
              }
            }
          },
          "nextToken": {}
        }
      }
    },
    "ListTagsForResource": {
      "http": {
        "method": "GET",
        "requestUri": "/tags/{resourceArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "resourceArn"
        ],
        "members": {
          "resourceArn": {
            "location": "uri",
            "locationName": "resourceArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {
          "tags": {
            "shape": "S4"
          }
        }
      }
    },
    "RestoreClusterFromSnapshot": {
      "http": {
        "requestUri": "/cluster-snapshot/{snapshotArn}/restore",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterName",
          "snapshotArn"
        ],
        "members": {
          "clusterName": {},
          "kmsKeyId": {},
          "shardCapacity": {
            "type": "integer"
          },
          "shardInstanceCount": {
            "type": "integer"
          },
          "snapshotArn": {
            "location": "uri",
            "locationName": "snapshotArn"
          },
          "subnetIds": {
            "shape": "Sc"
          },
          "tags": {
            "shape": "S4"
          },
          "vpcSecurityGroupIds": {
            "shape": "Sc"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    },
    "StartCluster": {
      "http": {
        "requestUri": "/cluster/{clusterArn}/start",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn"
        ],
        "members": {
          "clusterArn": {
            "location": "uri",
            "locationName": "clusterArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    },
    "StopCluster": {
      "http": {
        "requestUri": "/cluster/{clusterArn}/stop",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn"
        ],
        "members": {
          "clusterArn": {
            "location": "uri",
            "locationName": "clusterArn"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    },
    "TagResource": {
      "http": {
        "requestUri": "/tags/{resourceArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "resourceArn",
          "tags"
        ],
        "members": {
          "resourceArn": {
            "location": "uri",
            "locationName": "resourceArn"
          },
          "tags": {
            "shape": "S4"
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {}
      }
    },
    "UntagResource": {
      "http": {
        "method": "DELETE",
        "requestUri": "/tags/{resourceArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "resourceArn",
          "tagKeys"
        ],
        "members": {
          "resourceArn": {
            "location": "uri",
            "locationName": "resourceArn"
          },
          "tagKeys": {
            "location": "querystring",
            "locationName": "tagKeys",
            "type": "list",
            "member": {}
          }
        }
      },
      "output": {
        "type": "structure",
        "members": {}
      },
      "idempotent": true
    },
    "UpdateCluster": {
      "http": {
        "method": "PUT",
        "requestUri": "/cluster/{clusterArn}",
        "responseCode": 200
      },
      "input": {
        "type": "structure",
        "required": [
          "clusterArn"
        ],
        "members": {
          "adminUserPassword": {
            "shape": "Se"
          },
          "authType": {},
          "backupRetentionPeriod": {
            "type": "integer"
          },
          "clientToken": {
            "idempotencyToken": true
          },
          "clusterArn": {
            "location": "uri",
            "locationName": "clusterArn"
          },
          "preferredBackupWindow": {},
          "preferredMaintenanceWindow": {},
          "shardCapacity": {
            "type": "integer"
          },
          "shardCount": {
            "type": "integer"
          },
          "shardInstanceCount": {
            "type": "integer"
          },
          "subnetIds": {
            "shape": "Sc"
          },
          "vpcSecurityGroupIds": {
            "shape": "Sc"
          }
        }
      },
      "output": {
        "type": "structure",
        "required": [
          "cluster"
        ],
        "members": {
          "cluster": {
            "shape": "Si"
          }
        }
      },
      "idempotent": true
    }
  },
  "shapes": {
    "S4": {
      "type": "map",
      "key": {},
      "value": {}
    },
    "S9": {
      "type": "structure",
      "required": [
        "adminUserName",
        "clusterArn",
        "clusterCreationTime",
        "kmsKeyId",
        "snapshotArn",
        "snapshotCreationTime",
        "snapshotName",
        "status",
        "subnetIds",
        "vpcSecurityGroupIds"
      ],
      "members": {
        "adminUserName": {},
        "clusterArn": {},
        "clusterCreationTime": {},
        "kmsKeyId": {},
        "snapshotArn": {},
        "snapshotCreationTime": {},
        "snapshotName": {},
        "snapshotType": {},
        "status": {},
        "subnetIds": {
          "shape": "Sc"
        },
        "vpcSecurityGroupIds": {
          "shape": "Sc"
        }
      }
    },
    "Sc": {
      "type": "list",
      "member": {}
    },
    "Se": {
      "type": "string",
      "sensitive": true
    },
    "Si": {
      "type": "structure",
      "required": [
        "adminUserName",
        "authType",
        "clusterArn",
        "clusterEndpoint",
        "clusterName",
        "createTime",
        "kmsKeyId",
        "preferredMaintenanceWindow",
        "shardCapacity",
        "shardCount",
        "status",
        "subnetIds",
        "vpcSecurityGroupIds"
      ],
      "members": {
        "adminUserName": {},
        "authType": {},
        "backupRetentionPeriod": {
          "type": "integer"
        },
        "clusterArn": {},
        "clusterEndpoint": {},
        "clusterName": {},
        "createTime": {},
        "kmsKeyId": {},
        "preferredBackupWindow": {},
        "preferredMaintenanceWindow": {},
        "shardCapacity": {
          "type": "integer"
        },
        "shardCount": {
          "type": "integer"
        },
        "shardInstanceCount": {
          "type": "integer"
        },
        "shards": {
          "type": "list",
          "member": {
            "type": "structure",
            "required": [
              "createTime",
              "shardId",
              "status"
            ],
            "members": {
              "createTime": {},
              "shardId": {},
              "status": {}
            }
          }
        },
        "status": {},
        "subnetIds": {
          "shape": "Sc"
        },
        "vpcSecurityGroupIds": {
          "shape": "Sc"
        }
      }
    }
  }
}