使用云控制 API 示例 Amazon CLI - Amazon Command Line Interface
操作
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

使用云控制 API 示例 Amazon CLI

以下代码示例向您展示了如何使用 with Control API 来执行操作和实现常见场景。 Amazon Command Line Interface

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景和跨服务示例的上下文查看操作。

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示如何使用 create-resource。

Amazon CLI

创建资源

以下create-resource示例创建了一个名为 Amazon:: Kinesis:: Stream 的资源 ResourceExample，其保留期为 168 小时，分片计数为 3。

aws cloudcontrol create-resource \
    --type-name AWS::Kinesis::Stream \
    --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}"

输出：

{
    "ProgressEvent": {
        "EventTime": 1632506656.706,
        "TypeName": "AWS::Kinesis::Stream",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "CREATE",
        "Identifier": "ResourceExample",
        "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5"
    }
}

有关更多信息，请参阅《云控制 API 用户指南》中的创建资源。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateResource中的。

以下代码示例演示如何使用 delete-resource。

Amazon CLI

删除资源

以下delete-resource示例从您的账户中删除带有标识符 ResourceExample 的 Amazon:: Kinesis:: Stream 资源。 Amazon 

aws cloudcontrol delete-resource \
    --type-name AWS::Kinesis::Stream \
    --identifier ResourceExample

输出：

{
    "ProgressEvent": {
        "TypeName": "AWS::Kinesis::Stream",
        "Identifier": "ResourceExample",
        "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111",
        "Operation": "DELETE",
        "OperationStatus": "IN_PROGRESS",
        "EventTime": 1632950300.14
    }
}

有关更多信息，请参阅《云控制 API 用户指南》中的删除资源。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteResource中的。

以下代码示例演示如何使用 get-resource-request-status。

Amazon CLI

获取资源请求的状态信息

以下get-resource-request-status示例返回有关指定资源请求的状态信息。

aws cloudcontrol get-resource-request-status \
    --request-token "e1a6b86e-46bd-41ac-bfba-001234567890"

输出：

{
    "ProgressEvent": {
        "TypeName": "AWS::Kinesis::Stream",
        "Identifier": "Demo",
        "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890",
        "Operation": "CREATE",
        "OperationStatus": "FAILED",
        "EventTime": 1632950268.481,
        "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
        "ErrorCode": "AlreadyExists"
    }
}

有关更多信息，请参阅 Cloud Control API 用户指南中的管理资源操作请求。

以下代码示例演示如何使用 get-resource。

Amazon CLI

获取资源的当前状态

以下get-resource示例返回名为:: Kinesis Amazon:: Stream 资源的当前状态。 ResourceExample

aws cloudcontrol get-resource \
    --type-name AWS::Kinesis::Stream \
    --identifier ResourceExample

输出：

{
    "TypeName": "AWS::Kinesis::Stream",
    "ResourceDescription": {
        "Identifier": "ResourceExample",
        "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}"
    }
}

有关更多信息，请参阅 Cloud Control API 用户指南中的读取资源的当前状态。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetResource中的。

以下代码示例演示如何使用 list-resource-requests。

Amazon CLI

列出活动资源操作请求

以下list-resource-requests示例列出了您的 Amazon 账户中已失败的创建和更新操作的资源请求。

aws cloudcontrol list-resource-requests \
    --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED

输出：

{
    "ResourceRequestStatusSummaries": [
        {
            "TypeName": "AWS::Kinesis::Stream",
            "Identifier": "Demo",
            "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7",
            "Operation": "CREATE",
            "OperationStatus": "FAILED",
            "EventTime": 1632950268.481,
            "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
            "ErrorCode": "AlreadyExists"
        }
    ]
}

有关更多信息，请参阅 Cloud Control API 用户指南中的管理资源操作请求。

以下代码示例演示如何使用 list-resources。

Amazon CLI

列出给定类型的资源

以下list-resources示例列出了在您的账户中配置的 Amazon:: Kinesis:: Stream 资源。 Amazon 

aws cloudcontrol list-resources \
    --type-name AWS::Kinesis::Stream

输出：

{
    "TypeName": "AWS::Kinesis::Stream",
    "ResourceDescriptions": [
        {
            "Identifier": "MyKinesisStream",
            "Properties": "{\"Name\":\"MyKinesisStream\"}"
        },
        {
            "Identifier": "AnotherStream",
            "Properties": "{\"Name\":\"AnotherStream\"}"
        }
    ]
}

有关更多信息，请参阅《云控制 API 用户指南》中的发现资源。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListResources中的。

以下代码示例演示如何使用 update-resource。

Amazon CLI

更新现有资源的属性

以下update-resource示例将名为:: Logs Amazon:: LogGroup 资源的保留策略更新 ExampleLogGroup 为 90 天。

aws cloudcontrol update-resource \
    --type-name AWS::Logs::LogGroup \
    --identifier ExampleLogGroup \
    --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]"

输出：

{
    "ProgressEvent": {
        "EventTime": "2021-08-09T18:17:15.219Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "UPDATE",
        "Identifier": "ExampleLogGroup",
        "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789"
    }
}

有关更多信息，请参阅《云控制 API 用户指南》中的更新资源。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateResource中的。