CreateFramework - AWS Backup

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateFramework

创建具有一个或多个控件的框架。框架是可用于评估备份实践的控件集合。通过使用预构建的可自定义控件来定义策略,您可以评估您的备份实践是否符合您的策略以及哪些资源尚未符合要求。

请求语法

POST /audit/frameworks HTTP/1.1 Content-type: application/json { "FrameworkControls": [ { "ControlInputParameters": [ { "ParameterName": "string", "ParameterValue": "string" } ], "ControlName": "string", "ControlScope": { "ComplianceResourceIds": [ "string" ], "ComplianceResourceTypes": [ "string" ], "Tags": { "string" : "string" } } } ], "FrameworkDescription": "string", "FrameworkName": "string", "FrameworkTags": { "string" : "string" }, "IdempotencyToken": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

FrameworkControls

构成框架的控件列表。列表中的每个控件都有名称、输入参数和范围。

类型:FrameworkControl 对象数组

必需:是

FrameworkDescription

框架的可选描述,最多 1024 个字符。

类型:字符串

长度限制:长度下限为 0。最大长度为 1024。

模式:.*\S.*

必需:否

FrameworkName

框架的唯一名称。该名称的长度必须介于 1 到 256 个字符之间,以字母开头,由字母(a-z、A-Z)、数字 (0-9) 和下划线 (_) 组成。

类型:字符串

长度限制:最小长度为 1。最大长度为 256。

模式:[a-zA-Z][_a-zA-Z0-9]*

必需:是

FrameworkTags

您可以分配以帮助组织您创建的框架的元数据。每个标签都是一个键-值对。

类型:字符串到字符串映射

必需:否

IdempotencyToken

客户选择的字符串,可用于区分对 CreateFrameworkInput 的其他相同调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息,而不执行任何操作。

类型:字符串

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "FrameworkArn": "string", "FrameworkName": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

FrameworkArn

唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。

类型:字符串

FrameworkName

框架的唯一名称。该名称的长度必须介于 1 到 256 个字符之间,以字母开头,由字母(a-z、A-Z)、数字 (0-9) 和下划线 (_) 组成。

类型:字符串

长度限制:最小长度为 1。最大长度为 256。

模式:[a-zA-Z][_a-zA-Z0-9]*

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

AlreadyExistsException

所需的资源已存在。

HTTP 状态代码:400

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

LimitExceededException

已超过请求中的限制;例如,请求中允许的最大项目数。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: