openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 347 kB

JSON

{"openapi":"3.0.0","info":{"version":"2018-11-15","x-release":"v4","title":"AWS Backup","description":"<fullname>Backup</fullname> Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"backup","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/backup-2018-11-15.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/backup/"},"servers":[{"url":"http://backup.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Backup multi-region endpoint"},{"url":"https://backup.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Backup multi-region endpoint"},{"url":"http://backup.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Backup endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://backup.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Backup endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/legal-holds/{legalHoldId}#cancelDescription":{"delete":{"operationId":"CancelLegalHold","description":"This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelLegalHoldOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"InvalidResourceStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidResourceStateException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"legalHoldId","in":"path","required":true,"description":"Legal hold ID required to remove the specified legal hold on a recovery point.","schema":{"type":"string"}},{"name":"cancelDescription","in":"query","required":true,"description":"String describing the reason for removing the legal hold.","schema":{"type":"string"}},{"name":"retainRecordInDays","in":"query","required":false,"description":"The integer amount in days specifying amount of days after this API operation to remove legal hold.","schema":{"type":"integer"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/backup/plans/":{"put":{"operationId":"CreateBackupPlan","description":"Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call <code>CreateBackupPlan</code> with a plan that already exists, you receive an <code>AlreadyExistsException</code> exception.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupPlanOutput"}}}},"480":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"481":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlan"],"properties":{"BackupPlan":{"description":"Contains an optional backup plan display name and an array of <code>BackupRule</code> objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task. ","type":"object","properties":{"BackupPlanName":{"allOf":[{"$ref":"#/components/schemas/BackupPlanName"},{"description":"The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters."}]},"Rules":{"allOf":[{"$ref":"#/components/schemas/BackupRulesInput"},{"description":"An array of <code>BackupRule</code> objects, each of which specifies a scheduled task that is used to back up a selection of resources."}]},"AdvancedBackupSettings":{"allOf":[{"$ref":"#/components/schemas/AdvancedBackupSettings"},{"description":"Specifies a list of <code>BackupOptions</code> for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs."}]}}},"BackupPlanTags":{"description":"To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"CreatorRequestId":{"description":"Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a <code>CreatorRequestId</code> that matches an existing backup plan, that plan is returned. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListBackupPlans","description":"Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackupPlansOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of items to be returned.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"includeDeleted","in":"query","required":false,"description":"A Boolean value with a default value of <code>FALSE</code> that returns deleted backup plans when set to <code>TRUE</code>.","schema":{"type":"boolean"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/backup/plans/{backupPlanId}/selections/":{"put":{"operationId":"CreateBackupSelection","description":"Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json\">Assigning resources programmatically</a>. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupSelectionOutput"}}}},"480":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"481":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies the backup plan to be associated with the selection of resources.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupSelection"],"properties":{"BackupSelection":{"description":"Used to specify a set of resources to a backup plan. Specifying your desired <code>Conditions</code>, <code>ListOfTags</code>, <code>NotResources</code>, and/or <code>Resources</code> is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.","type":"object","properties":{"SelectionName":{"allOf":[{"$ref":"#/components/schemas/BackupSelectionName"},{"description":"The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters."}]},"IamRoleArn":{"allOf":[{"$ref":"#/components/schemas/IAMRoleArn"},{"description":"The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>."}]},"Resources":{"allOf":[{"$ref":"#/components/schemas/ResourceArns"},{"description":"A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags."}]},"ListOfTags":{"allOf":[{"$ref":"#/components/schemas/ListOfTags"},{"description":"A list of conditions that you define to assign resources to your backup plans using tags. For example, <code>\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },</code>. Condition operators are case sensitive. <code>ListOfTags</code> differs from <code>Conditions</code> as follows: <ul> <li> When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic). </li> <li> <code>ListOfTags</code> only supports <code>StringEquals</code>. <code>Conditions</code> supports <code>StringEquals</code>, <code>StringLike</code>, <code>StringNotEquals</code>, and <code>StringNotLike</code>. </li> </ul>"}]},"NotResources":{"allOf":[{"$ref":"#/components/schemas/ResourceArns"},{"description":"A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags."}]},"Conditions":{"allOf":[{"$ref":"#/components/schemas/Conditions"},{"description":"A list of conditions that you define to assign resources to your backup plans using tags. For example, <code>\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },</code>. Condition operators are case sensitive. <code>Conditions</code> differs from <code>ListOfTags</code> as follows: <ul> <li> When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic). </li> <li> <code>Conditions</code> supports <code>StringEquals</code>, <code>StringLike</code>, <code>StringNotEquals</code>, and <code>StringNotLike</code>. <code>ListOfTags</code> only supports <code>StringEquals</code>. </li> </ul>"}]}}},"CreatorRequestId":{"description":"A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListBackupSelections","description":"Returns an array containing metadata of the resources associated with the target backup plan.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackupSelectionsOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies a backup plan.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The next item following a partial list of returned items. For example, if a request is made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of items to be returned.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/backup-vaults/{backupVaultName}":{"put":{"operationId":"CreateBackupVault","description":"Creates a logical container where backups are stored. A <code>CreateBackupVault</code> request includes a name, optionally one or more resource tags, an encryption key, and a request ID. <note> Do not include sensitive data, such as passport numbers, in the name of a backup vault. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupVaultOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.","schema":{"type":"string","pattern":"^[a-zA-Z0-9\\-\\_]{2,50}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"BackupVaultTags":{"description":"Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"EncryptionKeyArn":{"description":"The server-side encryption key that is used to protect your backups; for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.","type":"string"},"CreatorRequestId":{"description":"A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteBackupVault","description":"Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.","responses":{"200":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeBackupVault","description":"Returns metadata about a backup vault specified by its name.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeBackupVaultOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.","schema":{"type":"string"}}]}},"/audit/frameworks":{"post":{"operationId":"CreateFramework","description":"Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFrameworkOutput"}}}},"480":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"481":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FrameworkName","FrameworkControls"],"properties":{"FrameworkName":{"description":"The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).","type":"string","pattern":"[a-zA-Z][_a-zA-Z0-9]*","minLength":1,"maxLength":256},"FrameworkDescription":{"description":"An optional description of the framework with a maximum of 1,024 characters.","type":"string","pattern":".*\\S.*","minLength":0,"maxLength":1024},"FrameworkControls":{"description":"A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.","type":"array","items":{"$ref":"#/components/schemas/FrameworkControl"}},"IdempotencyToken":{"description":"A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateFrameworkInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.","type":"string"},"FrameworkTags":{"description":"Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.","type":"object","additionalProperties":{"$ref":"#/components/schemas/string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListFrameworks","description":"Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFrameworksOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"NextToken","in":"query","required":false,"description":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.","schema":{"type":"string"}}]}},"/legal-holds/":{"post":{"operationId":"CreateLegalHold","description":"This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalHoldOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"482":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Title","Description"],"properties":{"Title":{"description":"This is the string title of the legal hold.","type":"string"},"Description":{"description":"This is the string description of the legal hold.","type":"string"},"IdempotencyToken":{"description":"This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.","type":"string"},"RecoveryPointSelection":{"description":"This specifies criteria to assign a set of resources, such as resource types or backup vaults.","type":"object","properties":{"VaultNames":{"allOf":[{"$ref":"#/components/schemas/VaultNames"},{"description":"These are the names of the vaults in which the selected recovery points are contained."}]},"ResourceIdentifiers":{"allOf":[{"$ref":"#/components/schemas/ResourceIdentifiers"},{"description":"These are the resources included in the resource selection (including type of resources and vaults)."}]},"DateRange":{"$ref":"#/components/schemas/DateRange"}}},"Tags":{"description":"Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListLegalHolds","description":"This action returns metadata about active and previous legal holds.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLegalHoldsOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The next item following a partial list of returned resources. For example, if a request is made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of resource list items to be returned.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/audit/report-plans":{"post":{"operationId":"CreateReportPlan","description":"Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call <code>CreateReportPlan</code> with a plan that already exists, you receive an <code>AlreadyExistsException</code> exception.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportPlanOutput"}}}},"480":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"481":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReportPlanName","ReportDeliveryChannel","ReportSetting"],"properties":{"ReportPlanName":{"description":"The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).","type":"string","pattern":"[a-zA-Z][_a-zA-Z0-9]*","minLength":1,"maxLength":256},"ReportPlanDescription":{"description":"An optional description of the report plan with a maximum of 1,024 characters.","type":"string","pattern":".*\\S.*","minLength":0,"maxLength":1024},"ReportDeliveryChannel":{"description":"Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.","type":"object","properties":{"S3BucketName":{"allOf":[{"$ref":"#/components/schemas/string"},{"description":"The unique name of the S3 bucket that receives your reports."}]},"S3KeyPrefix":{"allOf":[{"$ref":"#/components/schemas/string"},{"description":"The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/<code>prefix</code>/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix."}]},"Formats":{"allOf":[{"$ref":"#/components/schemas/FormatList"},{"description":"A list of the format of your reports: <code>CSV</code>, <code>JSON</code>, or both. If not specified, the default format is <code>CSV</code>."}]}}},"ReportSetting":{"description":"Contains detailed information about a report setting.","type":"object","properties":{"ReportTemplate":{"allOf":[{"$ref":"#/components/schemas/string"},{"description":"Identifies the report template for the report. Reports are built using a report template. The report templates are: <code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</code> "}]},"FrameworkArns":{"allOf":[{"$ref":"#/components/schemas/stringList"},{"description":"The Amazon Resource Names (ARNs) of the frameworks a report covers."}]},"NumberOfFrameworks":{"allOf":[{"$ref":"#/components/schemas/integer"},{"description":"The number of frameworks a report covers."}]},"Accounts":{"allOf":[{"$ref":"#/components/schemas/stringList"},{"description":"These are the accounts to be included in the report."}]},"OrganizationUnits":{"allOf":[{"$ref":"#/components/schemas/stringList"},{"description":"These are the Organizational Units to be included in the report."}]},"Regions":{"allOf":[{"$ref":"#/components/schemas/stringList"},{"description":"These are the Regions to be included in the report."}]}}},"ReportPlanTags":{"description":"Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.","type":"object","additionalProperties":{"$ref":"#/components/schemas/string"}},"IdempotencyToken":{"description":"A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListReportPlans","description":"Returns a list of your report plans. For detailed information about a single report plan, use <code>DescribeReportPlan</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReportPlansOutput"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"NextToken","in":"query","required":false,"description":"An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.","schema":{"type":"string"}}]}},"/backup/plans/{backupPlanId}":{"delete":{"operationId":"DeleteBackupPlan","description":"Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBackupPlanOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies a backup plan.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"UpdateBackupPlan","description":"Updates an existing backup plan identified by its <code>backupPlanId</code> with the input document in JSON format. The new version is uniquely identified by a <code>VersionId</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBackupPlanOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies a backup plan.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BackupPlan"],"properties":{"BackupPlan":{"description":"Contains an optional backup plan display name and an array of <code>BackupRule</code> objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task. ","type":"object","properties":{"BackupPlanName":{"allOf":[{"$ref":"#/components/schemas/BackupPlanName"},{"description":"The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters."}]},"Rules":{"allOf":[{"$ref":"#/components/schemas/BackupRulesInput"},{"description":"An array of <code>BackupRule</code> objects, each of which specifies a scheduled task that is used to back up a selection of resources."}]},"AdvancedBackupSettings":{"allOf":[{"$ref":"#/components/schemas/AdvancedBackupSettings"},{"description":"Specifies a list of <code>BackupOptions</code> for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs."}]}}}}}}}}}},"/backup/plans/{backupPlanId}/selections/{selectionId}":{"delete":{"operationId":"DeleteBackupSelection","description":"Deletes the resource selection associated with a backup plan that is specified by the <code>SelectionId</code>.","responses":{"200":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies a backup plan.","schema":{"type":"string"}},{"name":"selectionId","in":"path","required":true,"description":"Uniquely identifies the body of a request to assign a set of resources to a backup plan.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBackupSelection","description":"Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBackupSelectionOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupPlanId","in":"path","required":true,"description":"Uniquely identifies a backup plan.","schema":{"type":"string"}},{"name":"selectionId","in":"path","required":true,"description":"Uniquely identifies the body of a request to assign a set of resources to a backup plan.","schema":{"type":"string"}}]}},"/backup-vaults/{backupVaultName}/access-policy":{"delete":{"operationId":"DeleteBackupVaultAccessPolicy","description":"Deletes the policy document that manages permissions on a backup vault.","responses":{"200":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.","schema":{"type":"string","pattern":"^[a-zA-Z0-9\\-\\_]{2,50}$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetBackupVaultAccessPolicy","description":"Returns the access policy document that is associated with the named backup vault.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBackupVaultAccessPolicyOutput"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.","schema":{"type":"string","pattern":"^[a-zA-Z0-9\\-\\_]{2,50}$"}}]},"put":{"operationId":"PutBackupVaultAccessPolicy","description":"Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.","responses":{"200":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"MissingParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingParameterValueException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"backupVaultName","in":"path","required":true,"description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.","schema":{"type":"string","pattern":"^[a-zA-Z0-9\\-\\_]{2,50}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Policy":{"description":"The backup vault access policy document in JSON format.","type":"string"}}}}}}}},"/backup-vaults/{backupVaultName}/vault-lock":{"delete":{"operationId":"DeleteBackupVaultLockConfiguration","description":"Deletes Backup Vault Lock from a backup vault specified by a back