本文档仅适用于 Amazon CLI 版本 1。有关 Amazon CLI 版本 2 的相关文档,请参阅版本 2 用户指南。
使用 Amazon CLI 处理 Amazon SWF 域
您可以使用 Amazon Command Line Interface (Amazon CLI) 管理 Amazon Simple Workflow Service (Amazon SWF) 域。
列出您的域
要列出已为您的Amazon账户注册的 Amazon SWF 域,可以使用 swf
list-domains
。您必须包含 --registration-status
并指定 REGISTERED
或 DEPRECATED
。
下面是一个最简单的示例。
$
aws swf list-domains --registration-status REGISTERED
{ "domainInfos": [ { "status": "REGISTERED", "name": "ExampleDomain" }, { "status": "REGISTERED", "name": "mytest" } ] }
注意
有关使用 DEPRECATED
的示例,请参阅弃用域。
有关更多信息,请参阅《Amazon CLI 命令参考》中的 swf
list-domains
。
获取有关域的信息
要获取有关特定域的详细信息,请使用 swf
describe-domain
。有一个必需参数 --name
,此参数用于指定您要获取其信息的域的名称,如以下示例中所示。
$
aws swf describe-domain --name
ExampleDomain
{ "domainInfo": { "status": "REGISTERED", "name": "ExampleDomain" }, "configuration": { "workflowExecutionRetentionPeriodInDays": "1" } }
有关更多信息,请参阅《Amazon CLI 命令参考》中的 swf
describe-domain
。
注册域
要注册新域,请使用 swf
register-domain
。
有两个必需的参数:--name
和 --workflow-execution-retention-period-in-days
。--name
参数采用要注册的域名。--workflow-execution-retention-period-in-days
参数指定一个整数,以指定在该域上保留工作流程执行数据的天数,最长期间为 90 天(有关更多信息,请参阅 Amazon SWF 常见问题
如果您为此值指定零 (0),则保留期自动设置为最长持续时间。否则,在指定的天数过后,不会保留工作流程执行数据。以下示例说明如何注册新域。
$
aws swf register-domain --name
MyNeatNewDomain
--workflow-execution-retention-period-in-days 0
该命令不返回任何输出,但您可以使用 swf list-domains
或 swf describe-domain
查看新域,如以下示例中所示。
$
aws swf describe-domain --name
MyNeatNewDomain
{ "domainInfo": { "status": "REGISTERED", "name": "MyNeatNewDomain" }, "configuration": { "workflowExecutionRetentionPeriodInDays": "0" } }
有关更多信息,请参阅《Amazon CLI 命令参考》中的 swf
register-domain
。
弃用域
要弃用域(您仍可以看到它,但不能在它上面创建新工作流程执行或注册类型),请使用 swf
deprecate-domain
。它只有一个必需参数 --name
,此参数用于指定要弃用的域的名称。
$
aws swf deprecate-domain --name
MyNeatNewDomain
与 register-domain
一样,不会返回任何输出。不过,如果您使用 list-domains
查看已注册的域,则会看到该域不会再显示出来。您还可以使用 --registration-status
DEPRECATED
。
$
aws swf list-domains --registration-status DEPRECATED
{ "domainInfos": [ { "status": "DEPRECATED", "name": "MyNeatNewDomain" } ] }
有关更多信息,请参阅《Amazon CLI 命令参考》中的 deprecate-domain
。