使用的 Network Manager 範例 AWS CLI

下列程式碼範例示範如何搭配 AWS Command Line Interface Network Manager 使用來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

動作

下列程式碼範例示範如何使用 associate-customer-gateway。

AWS CLI

建立客戶閘道的關聯

下列associate-customer-gateway範例將指定全域網路cgw-11223344556677889中的客戶閘道與裝置建立關聯device-07f6fd08867abc123。


aws networkmanager associate-customer-gateway \
    --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889  \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --region us-west-2

輸出：


{
    "CustomerGatewayAssociation": {
        "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "State": "PENDING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的客戶閘道關聯。

如需API詳細資訊，請參閱命令參考 AssociateCustomerGateway中的。 AWS CLI

下列程式碼範例示範如何使用 associate-link。

AWS CLI

建立連結的關聯

下列associate-link範例會將連結link-11112222aaaabbbb1與裝置建立關聯device-07f6fd08867abc123。連結和裝置位於指定的全域網路中。


aws networkmanager associate-link \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

輸出：


{
    "LinkAssociation": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "LinkId": "link-11112222aaaabbbb1",
        "LinkAssociationState": "PENDING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的裝置和連結關聯。

如需API詳細資訊，請參閱命令參考 AssociateLink中的。 AWS CLI

下列程式碼範例示範如何使用 create-core-network。

AWS CLI

建立核心網路

下列create-core-network範例使用 AWS Cloud WAN全域網路中的選用描述和標籤建立核心網路。


aws networkmanager create-core-network \
    --global-network-id global-network-cdef-EXAMPLE22222 \
    --description "Main headquarters location" \
    --tags Key=Name,Value="New York City office"

輸出：


{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-cdef-EXAMPLE22222",
        "CoreNetworkId": "core-network-cdef-EXAMPLE33333",
        "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-cdef-EXAMPLE33333",
        "Description": "Main headquarters location",
        "CreatedAt": "2022-01-10T19:53:59+00:00",
        "State": "AVAILABLE",
        "Tags": [
            {
                "Key": "Name",
                "Value": "New York City office"
            }
        ]
    }
}

如需詳細資訊，請參閱 AWS 雲端WAN使用者指南 中的全域和核心網路。

如需API詳細資訊，請參閱命令參考 CreateCoreNetwork中的。 AWS CLI

下列程式碼範例示範如何使用 create-device。

AWS CLI

若要建立裝置

下列create-device範例會在指定的全域網路中建立裝置。裝置詳細資訊包括描述、類型、廠商、模型和序號。


aws networkmanager create-device
    --global-network-id global-network-01231231231231231 \
    --description "New York office device" \
    --type "office device" \
    --vendor "anycompany" \
    --model "abcabc" \
    --serial-number "1234" \
    --region us-west-2

輸出：


{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York office device",
        "Type": "office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "CreatedAt": 1575554005.0,
        "State": "PENDING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用裝置。

如需API詳細資訊，請參閱命令參考 CreateDevice中的。 AWS CLI

下列程式碼範例示範如何使用 create-global-network。

AWS CLI

建立全域網路

下列create-global-network範例會建立新的全域網路。建立時的初始狀態為 PENDING。


aws networkmanager create-global-network

輸出：


{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-00a77fc0f722dae74",
        "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-00a77fc0f722dae74",
        "CreatedAt": "2022-03-14T20:31:56+00:00",
        "State": "PENDING"
    }
}

如需API詳細資訊，請參閱命令參考 CreateGlobalNetwork中的。 AWS CLI

下列程式碼範例示範如何使用 create-link。

AWS CLI

建立連結

下列create-link範例會在指定的全域網路中建立連結。連結包含有關連結類型、頻寬和提供者的說明和詳細資訊。網站 ID 表示連結所關聯的網站。


aws networkmanager create-link \
    --global-network-id global-network-01231231231231231 \
    --description "VPN Link" \
    --type "broadband" \
    --bandwidth UploadSpeed=10,DownloadSpeed=20 \
    --provider "AnyCompany" \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

輸出：


{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 10,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "PENDING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用連結。

如需API詳細資訊，請參閱命令參考 CreateLink中的。 AWS CLI

下列程式碼範例示範如何使用 create-site。

AWS CLI

建立網站

下列create-site範例會在指定的全域網路中建立站台。網站詳細資訊包括描述和位置資訊。


aws networkmanager create-site \
    --global-network-id global-network-01231231231231231 \
    --description  "New York head office" \
    --location Latitude=40.7128,Longitude=-74.0060 \
    --region us-west-2

輸出：


{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York head office",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554300.0,
        "State": "PENDING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用網站。

如需API詳細資訊，請參閱命令參考 CreateSite中的。 AWS CLI

下列程式碼範例示範如何使用 create-vpc-attachment。

AWS CLI

若要建立VPC附件

下列create-vpc-attachment範例會在核心網路中建立IPv6支援的VPC附件。


aws networkmanager create-vpc-attachment \
    --core-network-id core-network-0fab62fe438d94db6 \
    --vpc-arn arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8  \
    --subnet-arns arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7 \
    --Ipv6Support=true

輸出：


{
    "VpcAttachment": {
        "Attachment": {
            "CoreNetworkId": "core-network-0fab62fe438d94db6",
            "AttachmentId": "attachment-05e1da6eba87a06e6",
            "OwnerAccountId": "987654321012",
            "AttachmentType": "VPC",
            "State": "CREATING",
            "EdgeLocation": "us-east-1",
            "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8",
            "Tags": [],
            "CreatedAt": "2022-03-10T20:59:14+00:00",
            "UpdatedAt": "2022-03-10T20:59:14+00:00"
        },
        "SubnetArns": [
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7"
        ],
        "Options": {
            "Ipv6Support": true
        }
    }
}

如需詳細資訊，請參閱 雲端WAN使用者指南 中的建立附件。

如需API詳細資訊，請參閱命令參考 CreateVpcAttachment中的。 AWS CLI

下列程式碼範例示範如何使用 delete-attachment。

AWS CLI

若要刪除附件

下列delete-attachment範例會刪除 Connect 附件。


aws networkmanager delete-attachment \
    --attachment-id attachment-01feddaeae26ab68c

輸出：


{
    "Attachment": {
        "CoreNetworkId": "core-network-0f4b0a9d5ee7761d1",
        "AttachmentId": "attachment-01feddaeae26ab68c",
        "OwnerAccountId": "987654321012",
        "AttachmentType": "CONNECT",
        "State": "DELETING",
        "EdgeLocation": "us-east-1",
        "ResourceArn": "arn:aws:networkmanager::987654321012:attachment/attachment-02c3964448fedf5aa",
        "CreatedAt": "2022-03-15T19:18:41+00:00",
        "UpdatedAt": "2022-03-15T19:28:59+00:00"
    }
}

如需詳細資訊，請參閱 雲端WAN使用者指南 中的刪除附件。

如需API詳細資訊，請參閱命令參考 DeleteAttachment中的。 AWS CLI

下列程式碼範例示範如何使用 delete-bucket-analytics-configuration。

AWS CLI

刪除儲存貯體的分析組態

下列delete-bucket-analytics-configuration範例會移除指定儲存貯體和 ID 的分析組態。


aws s3api delete-bucket-analytics-configuration \
    --bucket my-bucket \
    --id 1

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeleteBucketAnalyticsConfiguration中的。 AWS CLI

下列程式碼範例示範如何使用 delete-bucket-metrics-configuration。

AWS CLI

刪除儲存貯體的指標組態

下列delete-bucket-metrics-configuration範例會移除指定儲存貯體和 ID 的指標組態。


aws s3api delete-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeleteBucketMetricsConfiguration中的。 AWS CLI

下列程式碼範例示範如何使用 delete-core-network。

AWS CLI

刪除核心網路

下列delete-core-network範例會從 Cloud WAN全域網路刪除核心網路。


aws networkmanager delete-core-network \
    --core-network-id core-network-0fab62fe438d94db6

輸出：


{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-0d59060f16a73bc41",
        "CoreNetworkId": "core-network-0fab62fe438d94db6",
        "Description": "Main headquarters location",
        "CreatedAt": "2021-12-09T18:31:11+00:00",
        "State": "DELETING",
        "Segments": [
            {
                "Name": "dev",
                "EdgeLocations": [
                    "us-east-1"
                ],
                "SharedSegments": []
            }
        ],
        "Edges": [
            {
                "EdgeLocation": "us-east-1",
                "Asn": 64512,
                "InsideCidrBlocks": []
            }
        ]
    }
}

如需詳細資訊，請參閱 雲端WAN使用者指南 中的核心網路。

如需API詳細資訊，請參閱命令參考 DeleteCoreNetwork中的。 AWS CLI

下列程式碼範例示範如何使用 delete-device。

AWS CLI

若要刪除裝置

下列delete-device範例會從指定的全域網路刪除指定的裝置。


aws networkmanager delete-device \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --region us-west-2

輸出：


{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York office device",
        "Type": "office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "SiteId": "site-444555aaabbb11223",
        "CreatedAt": 1575554005.0,
        "State": "DELETING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用裝置。

如需API詳細資訊，請參閱命令參考 DeleteDevice中的。 AWS CLI

下列程式碼範例示範如何使用 delete-global-network。

AWS CLI

若要刪除全域網路

下列delete-global-network範例會刪除全域網路。


aws networkmanager delete-global-network \
    --global-network-id global-network-052bedddccb193b6b

輸出：


{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-052bedddccb193b6b",
        "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-052bedddccb193b6b",
        "CreatedAt": "2021-12-09T18:19:12+00:00",
        "State": "DELETING"
    }
}

如需API詳細資訊，請參閱命令參考 DeleteGlobalNetwork中的。 AWS CLI

下列程式碼範例示範如何使用 delete-link。

AWS CLI

若要刪除連結

下列delete-link範例會從指定的全域網路刪除指定的連結。


aws networkmanager delete-link \
    --global-network-id global-network-01231231231231231  \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

輸出：


{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 20,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "DELETING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用連結。

如需API詳細資訊，請參閱命令參考 DeleteLink中的。 AWS CLI

下列程式碼範例示範如何使用 delete-public-access-block。

AWS CLI

刪除儲存貯體的區塊公有存取組態

下列delete-public-access-block範例會移除指定儲存貯體上的區塊公有存取組態。


aws s3api delete-public-access-block \
    --bucket my-bucket

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 DeletePublicAccessBlock中的。 AWS CLI

下列程式碼範例示範如何使用 delete-site。

AWS CLI

刪除網站

下列delete-site範例會刪除指定全域網路中的指定站台（site-444555aaabbb11223）。


aws networkmanager delete-site \
    --global-network-id global-network-01231231231231231  \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

輸出：


{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York head office",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554300.0,
        "State": "DELETING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用網站。

如需API詳細資訊，請參閱命令參考 DeleteSite中的。 AWS CLI

下列程式碼範例示範如何使用 deregister-transit-gateway。

AWS CLI

從全域網路取消註冊傳輸閘道

下列deregister-transit-gateway範例會從指定的全域網路取消註冊指定的傳輸閘道。


aws networkmanager deregister-transit-gateway \
    --global-network-id global-network-01231231231231231 \
    --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \
    --region us-west-2

輸出：


{
    "TransitGatewayRegistration": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
        "State": {
            "Code": "DELETING"
        }
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的 Transit Gateway 註冊。

如需API詳細資訊，請參閱命令參考 DeregisterTransitGateway中的。 AWS CLI

下列程式碼範例示範如何使用 describe-global-networks。

AWS CLI

描述您的全球網路

下列describe-global-networks範例說明您帳戶中的所有全域網路。


aws networkmanager describe-global-networks \
    --region us-west-2

輸出：


{
    "GlobalNetworks": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
            "Description": "Company 1 global network",
            "CreatedAt": 1575553525.0,
            "State": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 DescribeGlobalNetworks中的。 AWS CLI

下列程式碼範例示範如何使用 disassociate-customer-gateway。

AWS CLI

若要取消與客戶閘道的關聯

下列disassociate-customer-gateway範例會將指定的客戶閘道（cgw-11223344556677889）與指定的全域網路取消關聯。


aws networkmanager disassociate-customer-gateway \
    --global-network-id global-network-01231231231231231 \
    --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \
    --region us-west-2

輸出：


{
    "CustomerGatewayAssociation": {
        "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "State": "DELETING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的客戶閘道關聯。

如需API詳細資訊，請參閱命令參考 DisassociateCustomerGateway中的。 AWS CLI

下列程式碼範例示範如何使用 disassociate-link。

AWS CLI

若要取消連結的關聯

下列disassociate-link範例會取消指定連結與指定全域網路device-07f6fd08867abc123中裝置的關聯。


aws networkmanager disassociate-link \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --link-id link-11112222aaaabbbb1 \
    --region us-west-2

輸出：


{
    "LinkAssociation": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "DeviceId": "device-07f6fd08867abc123",
        "LinkId": "link-11112222aaaabbbb1",
        "LinkAssociationState": "DELETING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的裝置和連結關聯。

如需API詳細資訊，請參閱命令參考 DisassociateLink中的。 AWS CLI

下列程式碼範例示範如何使用 get-bucket-analytics-configuration。

AWS CLI

擷取具有特定 ID 之儲存貯體的分析組態

下列get-bucket-analytics-configuration範例顯示指定儲存貯體和 ID 的分析組態。


aws s3api get-bucket-analytics-configuration \
    --bucket my-bucket \
    --id 1

輸出：


{
    "AnalyticsConfiguration": {
        "StorageClassAnalysis": {},
        "Id": "1"
    }
}

如需API詳細資訊，請參閱命令參考 GetBucketAnalyticsConfiguration中的。 AWS CLI

下列程式碼範例示範如何使用 get-bucket-metrics-configuration。

AWS CLI

擷取具有特定 ID 之儲存貯體的指標組態

下列get-bucket-metrics-configuration範例顯示指定儲存貯體和 ID 的指標組態。


aws s3api get-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123

輸出：


{
    "MetricsConfiguration": {
        "Filter": {
            "Prefix": "logs"
        },
        "Id": "123"
    }
}

如需API詳細資訊，請參閱命令參考 GetBucketMetricsConfiguration中的。 AWS CLI

下列程式碼範例示範如何使用 get-customer-gateway-associations。

AWS CLI

取得您的客戶閘道關聯

下列get-customer-gateway-associations範例會取得指定全域網路的客戶閘道關聯。


aws networkmanager get-customer-gateway-associations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "CustomerGatewayAssociations": [
        {
            "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889",
            "GlobalNetworkId": "global-network-01231231231231231",
            "DeviceId": "device-07f6fd08867abc123",
            "State": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetCustomerGatewayAssociations中的。 AWS CLI

下列程式碼範例示範如何使用 get-devices。

AWS CLI

若要取得您的裝置

下列get-devices範例取得指定全域網路中的裝置。


aws networkmanager get-devices \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "Devices": [
        {
            "DeviceId": "device-07f6fd08867abc123",
            "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
            "GlobalNetworkId": "global-network-01231231231231231",
            "Description": "NY office device",
            "Type": "office device",
            "Vendor": "anycompany",
            "Model": "abcabc",
            "SerialNumber": "1234",
            "CreatedAt": 1575554005.0,
            "State": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetDevices中的。 AWS CLI

下列程式碼範例示範如何使用 get-link-associations。

AWS CLI

若要取得連結關聯

下列get-link-associations範例會取得指定全域網路中的連結關聯。


aws networkmanager get-link-associations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "LinkAssociations": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "DeviceId": "device-07f6fd08867abc123",
            "LinkId": "link-11112222aaaabbbb1",
            "LinkAssociationState": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetLinkAssociations中的。 AWS CLI

下列程式碼範例示範如何使用 get-links。

AWS CLI

若要取得您的連結

下列get-links範例會取得指定全域網路中的連結。


aws networkmanager get-links \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "Links": [
        {
            "LinkId": "link-11112222aaaabbbb1",
            "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
            "GlobalNetworkId": "global-network-01231231231231231",
            "SiteId": "site-444555aaabbb11223",
            "Description": "VPN Link",
            "Type": "broadband",
            "Bandwidth": {
                "UploadSpeed": 10,
                "DownloadSpeed": 20
            },
            "Provider": "AnyCompany",
            "CreatedAt": 1575555811.0,
            "State": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetLinks中的。 AWS CLI

下列程式碼範例示範如何使用 get-object-retention。

AWS CLI

擷取物件的物件保留組態

下列get-object-retention範例會擷取指定物件的物件保留組態。


aws s3api get-object-retention \
    --bucket my-bucket-with-object-lock \
    --key doc1.rtf

輸出：


{
    "Retention": {
        "Mode": "GOVERNANCE",
        "RetainUntilDate": "2025-01-01T00:00:00.000Z"
    }
}

如需API詳細資訊，請參閱命令參考 GetObjectRetention中的。 AWS CLI

下列程式碼範例示範如何使用 get-public-access-block。

AWS CLI

設定或修改儲存貯體的區塊公有存取組態

下列get-public-access-block範例顯示指定儲存貯體的區塊公有存取組態。


aws s3api get-public-access-block --bucket my-bucket

輸出：


{
    "PublicAccessBlockConfiguration": {
        "IgnorePublicAcls": true,
        "BlockPublicPolicy": true,
        "BlockPublicAcls": true,
        "RestrictPublicBuckets": true
    }
}

如需API詳細資訊，請參閱命令參考 GetPublicAccessBlock中的。 AWS CLI

下列程式碼範例示範如何使用 get-sites。

AWS CLI

若要取得您的網站

下列get-sites範例取得指定全域網路中的站台。


aws networkmanager get-sites \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "Sites": [
        {
            "SiteId": "site-444555aaabbb11223",
            "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
            "GlobalNetworkId": "global-network-01231231231231231",
            "Description": "NY head office",
            "Location": {
                "Latitude": "40.7128",
                "Longitude": "-74.0060"
            },
            "CreatedAt": 1575554528.0,
            "State": "AVAILABLE"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetSites中的。 AWS CLI

下列程式碼範例示範如何使用 get-transit-gateway-registrations。

AWS CLI

若要取得傳輸閘道註冊

下列get-transit-gateway-registrations範例會取得已註冊至指定全域網路的傳輸閘道。


aws networkmanager get-transit-gateway-registrations \
    --global-network-id global-network-01231231231231231 \
    --region us-west-2

輸出：


{
    "TransitGatewayRegistrations": [
        {
            "GlobalNetworkId": "global-network-01231231231231231",
            "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
            "State": {
                "Code": "AVAILABLE"
            }
        }
    ]
}

如需API詳細資訊，請參閱命令參考 GetTransitGatewayRegistrations中的。 AWS CLI

下列程式碼範例示範如何使用 get-vpc-attachment。

AWS CLI

若要取得VPC附件

下列get-vpc-attachment範例會傳回有關VPC附件的資訊。


aws networkmanager get-vpc-attachment \
    --attachment-id  attachment-03b7ea450134787da

輸出：


{
    "VpcAttachment": {
        "Attachment": {
            "CoreNetworkId": "core-network-0522de1b226a5d7b3",
            "AttachmentId": "attachment-03b7ea450134787da",
            "OwnerAccountId": "987654321012",
            "AttachmentType": "VPC",
            "State": "CREATING",
            "EdgeLocation": "us-east-1",
            "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda",
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "DevVPC"
                }
            ],
            "CreatedAt": "2022-03-11T17:48:58+00:00",
            "UpdatedAt": "2022-03-11T17:48:58+00:00"
        },
        "SubnetArns": [
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-202cde6c",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-e5022dba",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-2387ae02",
            "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-cda9dffc"
        ],
        "Options": {
            "Ipv6Support": false
        }
    }
}

如需詳細資訊，請參閱 雲端WAN使用者指南 中的附件。

如需API詳細資訊，請參閱命令參考 GetVpcAttachment中的。 AWS CLI

下列程式碼範例示範如何使用 list-bucket-analytics-configurations。

AWS CLI

擷取儲存貯體的分析組態清單

以下內容會list-bucket-analytics-configurations擷取指定儲存貯體的分析組態清單。


aws s3api list-bucket-analytics-configurations \
    --bucket my-bucket

輸出：


{
    "AnalyticsConfigurationList": [
        {
            "StorageClassAnalysis": {},
            "Id": "1"
        }
    ],
    "IsTruncated": false
}

如需API詳細資訊，請參閱命令參考 ListBucketAnalyticsConfigurations中的。 AWS CLI

下列程式碼範例示範如何使用 list-bucket-metrics-configurations。

AWS CLI

擷取儲存貯體的指標組態清單

下列list-bucket-metrics-configurations範例會擷取指定儲存貯體的指標組態清單。


aws s3api list-bucket-metrics-configurations \
    --bucket my-bucket

輸出：


{
    "IsTruncated": false,
    "MetricsConfigurationList": [
        {
            "Filter": {
                "Prefix": "logs"
            },
            "Id": "123"
        },
        {
            "Filter": {
                "Prefix": "tmp"
            },
            "Id": "234"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListBucketMetricsConfigurations中的。 AWS CLI

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出資源的標籤

下列list-tags-for-resource範例列出指定裝置資源的標籤（device-07f6fd08867abc123）。


aws networkmanager list-tags-for-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \
    --region us-west-2

輸出：


{
    "TagList": [
        {
            "Key": "Network",
            "Value": "Northeast"
        }
    ]
}

如需API詳細資訊，請參閱命令參考 ListTagsForResource中的。 AWS CLI

下列程式碼範例示範如何使用 put-bucket-metrics-configuration。

AWS CLI

設定儲存貯體的指標組態

下列put-bucket-metrics-configuration範例會為指定的儲存貯體設定 ID 為 123 的指標組態。


aws s3api put-bucket-metrics-configuration \
    --bucket my-bucket \
    --id 123 \
    --metrics-configuration '{"Id": "123", "Filter": {"Prefix": "logs"}}'

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 PutBucketMetricsConfiguration中的。 AWS CLI

下列程式碼範例示範如何使用 put-object-retention。

AWS CLI

設定物件的物件保留組態

下列put-object-retention範例會設定指定物件的物件保留組態，直到 2025-01-01。


aws s3api put-object-retention \
    --bucket my-bucket-with-object-lock \
    --key doc1.rtf \
    --retention '{ "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00" }'

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 PutObjectRetention中的。 AWS CLI

下列程式碼範例示範如何使用 put-public-access-block。

AWS CLI

設定儲存貯體的區塊公有存取組態

下列put-public-access-block範例會為指定的儲存貯體設定限制性區塊公有存取組態。


aws s3api put-public-access-block \
    --bucket my-bucket \
    --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true"

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 PutPublicAccessBlock中的。 AWS CLI

下列程式碼範例示範如何使用 register-transit-gateway。

AWS CLI

在全球網路中註冊傳輸閘道

下列register-transit-gateway範例會註冊指定全域網路tgw-123abc05e04123abc中的傳輸閘道。


aws networkmanager register-transit-gateway \
    --global-network-id global-network-01231231231231231 \
    --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \
    --region us-west-2

輸出：


{
    "TransitGatewayRegistration": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
        "State": {
            "Code": "PENDING"
        }
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的 Transit Gateway 註冊。

如需API詳細資訊，請參閱命令參考 RegisterTransitGateway中的。 AWS CLI

下列程式碼範例示範如何使用 reject-attachment。

AWS CLI

若要拒絕附件

下列reject-attachment範例會拒絕VPC附件請求。


aws networkmanager reject-attachment \
    --attachment-id  attachment-03b7ea450134787da

輸出：


{
    "Attachment": {
        "CoreNetworkId": "core-network-0522de1b226a5d7b3",
        "AttachmentId": "attachment-03b7ea450134787da",
        "OwnerAccountId": "987654321012",
        "AttachmentType": "VPC",
        "State": "AVAILABLE",
        "EdgeLocation": "us-east-1",
        "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda",
        "CreatedAt": "2022-03-11T17:48:58+00:00",
        "UpdatedAt": "2022-03-11T17:51:25+00:00"
    }
}

如需詳細資訊，請參閱 雲端WAN使用者指南 中的附件接受。

如需API詳細資訊，請參閱命令參考 RejectAttachment中的。 AWS CLI

下列程式碼範例示範如何使用 start-route-analysis。

AWS CLI

開始路由分析

下列start-route-analysis範例會啟動來源和目的地之間的分析，包括選用的 include-return-path。


aws networkmanager start-route-analysis \
    --global-network-id global-network-00aa0aaa0b0aaa000 \
    --source TransitGatewayAttachmentArn=arn:aws:ec2:us-east-1:503089527312:transit-gateway-attachment/tgw-attach-0d4a2d491bf68c093,IpAddress=10.0.0.0 \
    --destination TransitGatewayAttachmentArn=arn:aws:ec2:us-west-1:503089527312:transit-gateway-attachment/tgw-attach-002577f30bb181742,IpAddress=11.0.0.0 \
    --include-return-path

輸出：


{
    "RouteAnalysis": {
        "GlobalNetworkId": "global-network-00aa0aaa0b0aaa000
        "OwnerAccountId": "1111222233333",
        "RouteAnalysisId": "a1873de1-273c-470c-1a2bc2345678",
        "StartTimestamp": 1695760154.0,
        "Status": "RUNNING",
        "Source": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-attachment/tgw-attach-1234567890abcdef0,
            "TransitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-abcdef01234567890",
            "IpAddress": "10.0.0.0"
        },
        "Destination": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-west-1:555555555555:transit-gateway-attachment/tgw-attach-021345abcdef6789",
            "TransitGatewayArn": "arn:aws:ec2:us-west-1:111122223333:transit-gateway/tgw-09876543210fedcba0",
            "IpAddress": "11.0.0.0"
        },
        "IncludeReturnPath": true,
        "UseMiddleboxes": false
    }
}

如需詳細資訊，請參閱 AWS Global Networks for Transit Gateways 使用者指南中的 Route Analyzer。

如需API詳細資訊，請參閱命令參考 StartRouteAnalysis中的。 AWS CLI

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

將標籤套用至資源

下列tag-resource範例會將標籤套用至Network=Northeast裝置 device-07f6fd08867abc123。


aws networkmanager tag-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \
    --tags Key=Network,Value=Northeast \
    --region us-west-2

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 TagResource中的。 AWS CLI

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

從資源中移除標籤

下列untag-resource範例Network會從裝置移除具有金鑰的標籤device-07f6fd08867abc123。


aws networkmanager untag-resource \
    --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 ]
    --tag-keys Network \
    --region us-west-2

此命令不會產生輸出。

如需API詳細資訊，請參閱命令參考 UntagResource中的。 AWS CLI

下列程式碼範例示範如何使用 update-device。

AWS CLI

若要更新裝置

下列update-device範例device-07f6fd08867abc123會透過指定裝置的網站 ID 來更新裝置。


aws networkmanager update-device \
    --global-network-id global-network-01231231231231231 \
    --device-id device-07f6fd08867abc123 \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

輸出：


{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "NY office device",
        "Type": "Office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "SiteId": "site-444555aaabbb11223",
        "CreatedAt": 1575554005.0,
        "State": "UPDATING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用裝置。

如需API詳細資訊，請參閱命令參考 UpdateDevice中的。 AWS CLI

下列程式碼範例示範如何使用 update-global-network。

AWS CLI

更新全域網路

下列update-global-network範例會更新全域網路的描述global-network-01231231231231231。


aws networkmanager update-global-network \
    --global-network-id global-network-01231231231231231 \
    --description "Head offices" \
    --region us-west-2

輸出：


{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
        "Description": "Head offices",
        "CreatedAt": 1575553525.0,
        "State": "UPDATING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的 Global Networks。

如需API詳細資訊，請參閱命令參考 UpdateGlobalNetwork中的。 AWS CLI

下列程式碼範例示範如何使用 update-link。

AWS CLI

更新連結

下列update-link範例會更新連結的頻寬資訊link-11112222aaaabbbb1。


aws networkmanager update-link \
    --global-network-id global-network-01231231231231231 \
    --link-id link-11112222aaaabbbb1 \
    --bandwidth  UploadSpeed=20,DownloadSpeed=20 \
    --region us-west-2

輸出：


{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 20,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "UPDATING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用連結。

如需API詳細資訊，請參閱命令參考 UpdateLink中的。 AWS CLI

下列程式碼範例示範如何使用 update-site。

AWS CLI

更新網站

下列update-site範例會更新指定全域網路site-444555aaabbb11223中站台的描述。


aws networkmanager update-site \
    --global-network-id global-network-01231231231231231 \
    --site-id site-444555aaabbb11223 \
    --description "New York Office site" \
    --region us-west-2

輸出：


{
    "Site": {
        "SiteId": "site-444555aaabbb11223",
        "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York Office site",
        "Location": {
            "Latitude": "40.7128",
            "Longitude": "-74.0060"
        },
        "CreatedAt": 1575554528.0,
        "State": "UPDATING"
    }
}

如需詳細資訊，請參閱 Transit Gateway Network Manager 指南中的使用網站。

如需API詳細資訊，請參閱命令參考 UpdateSite中的。 AWS CLI

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Amazon MSK

Nimble Studio

使用 的 Network Manager 範例 AWS CLI

主題

動作

使用的 Network Manager 範例 AWS CLI