Network Manager examples using AWS CLI - AWS Command Line Interface
アクション

このドキュメントはバージョン 1 の AWS CLI のみを対象としています。AWS CLI のバージョン 2 に関連するドキュメントについては、バージョン 2 用ユーザーガイドを参照してください。

Network Manager examples using 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 ガイド」の「カスタマーゲートウェイの関連付け」を参照してください。

  • 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 Cloud 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
        }
    }
}

詳細については、「Cloud 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"
    }
}

詳細については、「Cloud 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

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

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

AWS CLI

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

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

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

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

次の例は、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": []
            }
        ]
    }
}

詳細については、「Cloud 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 ガイド」の「トランジットゲートウェイの登録」を参照してください。

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

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

次の例は、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 の詳細については、「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"
    }
}

次の例は、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"
        }
    ]
}

次の例は、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

トランジットゲートウェイの登録を取得するには

次の 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"
            }
        }
    ]
}

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

詳細については、「Cloud 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
}

次の例は、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"
        }
    ]
}

次の例は、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 ガイド」の「トランジットゲートウェイの登録」を参照してください。

  • 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"
    }
}

詳細については、「Cloud 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
    }
}

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

  • 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 の例では、キー device-07f6fd08867abc123 のタグをデバイス Network から削除します。

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」を参照してください。