を使用した Network Manager の例 AWS CLI

次のコード例は、Network Manager AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

アクション

次のコード例は、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 ガイド」の「Customer Gateway Associations」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスAssociateCustomerGateway」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスAssociateLink」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateCoreNetwork」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateDevice」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateGlobalNetwork」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateLink」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateSite」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスCreateVpcAttachment」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスDeleteAttachment」の「」を参照してください。

次の例は、delete-bucket-analytics-configuration を使用する方法を説明しています。

AWS CLI

バケットの分析設定を削除するには

次の delete-bucket-analytics-configuration の例では、指定されたバケットと ID の分析設定を削除します。


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

このコマンドでは何も出力されません。

API 詳細については、AWS CLI 「コマンドリファレンスDeleteBucketAnalyticsConfiguration」の「」を参照してください。

次の例は、delete-bucket-metrics-configuration を使用する方法を説明しています。

AWS CLI

バケットのメトリクス設定を削除するには

次の delete-bucket-metrics-configuration の例では、指定したバケットと ID のメトリクス設定を削除します。


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

このコマンドでは何も出力されません。

API 詳細については、AWS CLI 「コマンドリファレンスDeleteBucketMetricsConfiguration」の「」を参照してください。

次のコード例は、delete-core-network を使用する方法を示しています。

AWS CLI

コアネットワークを削除するには

次のdelete-core-network例では、クラウド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 詳細については、AWS CLI 「コマンドリファレンスDeleteCoreNetwork」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスDeleteDevice」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスDeleteGlobalNetwork」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスDeleteLink」の「」を参照してください。

次のコード例は、delete-public-access-block を使用する方法を示しています。

AWS CLI

バケットのブロックパブリックアクセス設定を削除するには

次の delete-public-access-block の例では、指定したバケットのブロックパブリックアクセス設定を削除します。


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

このコマンドでは何も出力されません。

API 詳細については、AWS CLI 「コマンドリファレンスDeletePublicAccessBlock」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスDeleteSite」の「」を参照してください。

次の例は、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 Guide」の「Transit Gateway Registrations」を参照してください。

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 ガイド」の「Customer Gateway Associations」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスDisassociateCustomerGateway」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスDisassociateLink」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスGetBucketAnalyticsConfiguration」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスGetBucketMetricsConfiguration」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetCustomerGatewayAssociations」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetDevices」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスGetLinkAssociations」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetLinks」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetObjectRetention」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetPublicAccessBlock」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetSites」の「」を参照してください。

次のコード例は、get-transit-gateway-registrations を使用する方法を示しています。

AWS CLI

Transit Gateway の登録を取得するには

次の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 詳細については、AWS CLI 「コマンドリファレンスGetTransitGatewayRegistrations」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスGetVpcAttachment」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスListBucketAnalyticsConfigurations」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスListBucketMetricsConfigurations」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスListTagsForResource」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスPutBucketMetricsConfiguration」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスPutObjectRetention」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスPutPublicAccessBlock」の「」を参照してください。

次の例は、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 Guide」の「Transit Gateway Registrations」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスRegisterTransitGateway」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスRejectAttachment」の「」を参照してください。

次のコード例は、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
    }
}

詳細については、「Global AWS Networks for Transit Gateways ユーザーガイド」の「Route Analyzer」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスStartRouteAnalysis」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスTagResource」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスUntagResource」の「」を参照してください。

次の例は、update-device を使用する方法を説明しています。

AWS CLI

デバイスを更新するには

次のupdate-device例では、デバイスのサイト ID を指定device-07f6fd08867abc123してデバイスを更新します。


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 詳細については、AWS CLI 「コマンドリファレンスUpdateDevice」の「」を参照してください。

次の例は、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 ガイド」の「グローバルネットワーク」を参照してください。

API 詳細については、AWS CLI 「コマンドリファレンスUpdateGlobalNetwork」の「」を参照してください。

次のコード例は、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 詳細については、AWS CLI 「コマンドリファレンスUpdateLink」の「」を参照してください。

次の例は、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 詳細については、AWS CLI 「コマンドリファレンスUpdateSite」の「」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon MSK

Nimble Studio