Ejemplos de Network Manager que utilizan la AWS CLI - AWS Command Line Interface

Ejemplos de Network Manager que utilizan la AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes usando AWS Command Line Interface con Administrador de red.

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo utilizar associate-customer-gateway.

AWS CLI

Para asociar una puerta de enlace de cliente

El siguiente ejemplo de associate-customer-gateway asocia la puerta de enlace de cliente cgw-11223344556677889 de la red global especificada con el dispositivo 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

Salida:

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

Para obtener más información, consulte Customer Gateway Associations en la Guía de Transit Gateway Network Manager.

En el siguiente ejemplo de código, se muestra cómo utilizar associate-link.

AWS CLI

Para asociar un enlace

En el siguiente ejemplo de associate-link se asocia el enlace link-11112222aaaabbbb1 al dispositivo device-07f6fd08867abc123. El enlace y el dispositivo se encuentran en la red global especificada.

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

Salida:

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

Para obtener más información, consulte Device and Link Associations en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte AssociateLink en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-core-network.

AWS CLI

Para crear una red principal

En el siguiente ejemplo de create-core-network se crea una red principal con una descripción y etiquetas opcionales dentro de una red global WAN en la nube de AWS.

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

Salida:

{ "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" } ] } }

Para obtener más información, consulte Global and core networks en la Guía del usuario de AWS WAN en la nube.

  • Para obtener información sobre la API, consulte CreateCoreNetwork en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-device.

AWS CLI

Para crear un dispositivo

En el ejemplo siguiente de create-device se crea un dispositivo en la red global especificada. Los detalles del dispositivo incluyen descripción, tipo, proveedor, modelo y número de serie.

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

Salida:

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

Para obtener más información, consulte Working with Devices en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte CreateDevice en la Referencia de comandos de AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-global-network.

AWS CLI

Para crear una red global

En el siguiente ejemplo de create-global-network se crea una nueva red global. El estado inicial tras la creación es PENDING.

aws networkmanager create-global-network

Salida:

{ "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" } }
  • Para obtener información sobre la API, consulte CreateGlobalNetwork en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-link.

AWS CLI

Para crear un enlace

En el ejemplo siguiente de create-link se crea un enlace en la red global especificada. El enlace incluye una descripción y detalles sobre el tipo de enlace, el ancho de banda y el proveedor. El ID del sitio indica el sitio al que está asociado el enlace.

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

Salida:

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

Para obtener más información, consulte Working with Links en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte CreateLink en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-site.

AWS CLI

Para crear un sitio

En el ejemplo siguiente de create-site se crea un sitio en la red global especificada. Los detalles del sitio incluyen una descripción e información de ubicación.

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

Salida:

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

Para obtener más información, consulte Working with Sites en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte CreateSite en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar create-vpc-attachment.

AWS CLI

Para crear una asociación a VPC

En el siguiente ejemplo de create-vpc-attachment se crea una asociación a VPC compatible con IPv6 en una red principal.

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

Salida:

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

Para obtener más información, consulte Create an attachment en la Guía del usuario de WAN en la nube.

  • Para obtener información sobre la API, consulte CreateVpcAttachment en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-attachment.

AWS CLI

Para eliminar una asociación

En el siguiente ejemplo de delete-attachment se elimina una asociación a Connect.

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

Salida:

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

Para obtener más información, consulte Delete attachments en la Guía del usuario de WAN en la nube.

  • Para obtener información sobre la API, consulte DeleteAttachment en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-bucket-analytics-configuration.

AWS CLI

Eliminar una configuración de análisis de un bucket

En el siguiente ejemplo de delete-bucket-analytics-configuration, se elimina la configuración de análisis para el bucket e ID especificados.

aws s3api delete-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1

Este comando no genera ninguna salida.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-bucket-metrics-configuration.

AWS CLI

Eliminar una configuración de métricas de un bucket

En el siguiente ejemplo de delete-bucket-metrics-configuration, se elimina la configuración de métricas para el bucket e ID especificados.

aws s3api delete-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123

Este comando no genera ninguna salida.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-core-network.

AWS CLI

Para eliminar una red principal

En el siguiente ejemplo de delete-core-network se elimina una red principal de una red global de WAN en la nube.

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

Salida:

{ "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": [] } ] } }

Para obtener más información, consulte Core networks en la Guía del usuario de WAN en la nube.

  • Para obtener información sobre la API, consulte DeleteCoreNetwork en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-device.

AWS CLI

Para eliminar un dispositivo

En el siguiente ejemplo de delete-device se elimina el dispositivo especificado de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Working with Devices en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte DeleteDevice en la Referencia de comandos de AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-global-network.

AWS CLI

Para eliminar una red global

En el siguiente ejemplo de delete-global-network se crea una red global.

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

Salida:

{ "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" } }
  • Para obtener información sobre la API, consulte DeleteGlobalNetwork en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-link.

AWS CLI

Para eliminar un enlace

En el siguiente ejemplo de delete-link se elimina el enlace especificado de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Working with Links en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte DeleteLink en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-public-access-block.

AWS CLI

Eliminar la configuración de bloqueo de acceso público de un bucket

En el siguiente ejemplo de delete-public-access-block, se elimina la configuración de bloqueo de acceso público en el bucket especificado.

aws s3api delete-public-access-block \ --bucket amzn-s3-demo-bucket

Este comando no genera ninguna salida.

  • Para obtener información sobre la API, consulte DeletePublicAccessBlock en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar delete-site.

AWS CLI

Para eliminar un sitio

En el siguiente ejemplo de delete-site se elimina el sitio especificado (site-444555aaabbb11223) de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Working with Sites en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte DeleteSite en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar deregister-transit-gateway.

AWS CLI

Para anular el registro de una puerta de enlace de tránsito de una red global

En el siguiente ejemplo de deregister-transit-gateway se anula el registro de la puerta de enlace de tránsito especificada de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Transit Gateway Registrations en la Guía de Transit Gateway Network Manager.

En el siguiente ejemplo de código, se muestra cómo utilizar describe-global-networks.

AWS CLI

Para describir sus redes globales

En el siguiente ejemplo de describe-global-networks se describen todas las redes globales de su cuenta.

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

Salida:

{ "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" } ] }
  • Para obtener información sobre la API, consulte DescribeGlobalNetworks en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-customer-gateway.

AWS CLI

Para desasociar una puerta de enlace de cliente

En el siguiente ejemplo de disassociate-customer-gateway se desasocia la puerta de enlace de cliente especificada (cgw-11223344556677889) de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Customer Gateway Associations en la Guía de Transit Gateway Network Manager.

En el siguiente ejemplo de código, se muestra cómo utilizar disassociate-link.

AWS CLI

Para desasociar un enlace

En el siguiente ejemplo de disassociate-link se desasocia el enlace especificado del dispositivo device-07f6fd08867abc123 de la red global indicada.

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

Salida:

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

Para obtener más información, consulte Device and Link Associations en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte DisassociateLink en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-bucket-analytics-configuration.

AWS CLI

Recuperar la configuración de análisis de un bucket con un ID específico

En el siguiente ejemplo de get-bucket-analytics-configuration, se muestra la configuración de análisis para el bucket e ID especificados.

aws s3api get-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar get-bucket-metrics-configuration.

AWS CLI

Recuperar la configuración de métricas de un bucket con un ID específico

En el siguiente ejemplo de get-bucket-metrics-configuration, se muestra la configuración de métricas para el bucket e ID especificados.

aws s3api get-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar get-customer-gateway-associations.

AWS CLI

Para obtener sus asociaciones de puerta de enlace de cliente

En el siguiente ejemplo de get-customer-gateway-associations se obtienen asociaciones de puerta de enlace de cliente para la red global especificada.

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

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar get-devices.

AWS CLI

Para configurar los dispositivos

En el siguiente ejemplo de get-devices se obtienen los dispositivos en la red global especificada.

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

Salida:

{ "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" } ] }
  • Para obtener información sobre la API, consulte GetDevices en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-link-associations.

AWS CLI

Para obtener sus asociaciones de enlaces

En el siguiente ejemplo de get-link-associations se obtienen asociaciones de enlace de la red global especificada.

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

Salida:

{ "LinkAssociations": [ { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "AVAILABLE" } ] }
  • Para obtener información sobre la API, consulte GetLinkAssociations en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-links.

AWS CLI

Para obtener sus enlaces

En el siguiente ejemplo de get-links se obtienen los enlaces de la red global especificada.

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

Salida:

{ "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" } ] }
  • Para obtener información sobre la API, consulte GetLinks en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-object-retention.

AWS CLI

Para recuperar la configuración de retención de un objeto

En el siguiente ejemplo de get-object-retention, se recupera la configuración de retención del objeto especificado.

aws s3api get-object-retention \ --bucket amzn-s3-demo-bucket-with-object-lock \ --key doc1.rtf

Salida:

{ "Retention": { "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00.000Z" } }
  • Para obtener información sobre la API, consulte GetObjectRetention en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-public-access-block.

AWS CLI

Establecer o modificar la configuración de bloqueo de acceso público de un bucket

En el siguiente ejemplo de get-public-access-block, se elimina la configuración de bloqueo de acceso público del bucket especificado.

aws s3api get-public-access-block --bucket amzn-s3-demo-bucket

Salida:

{ "PublicAccessBlockConfiguration": { "IgnorePublicAcls": true, "BlockPublicPolicy": true, "BlockPublicAcls": true, "RestrictPublicBuckets": true } }
  • Para obtener información sobre la API, consulte GetPublicAccessBlock en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-sites.

AWS CLI

Para obtener sus sitios

En el siguiente ejemplo de get-sites se obtienen los sitios de la red global especificada.

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

Salida:

{ "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" } ] }
  • Para obtener información sobre la API, consulte GetSites en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar get-transit-gateway-registrations.

AWS CLI

Para obtener sus registros de puerta de enlace de tránsito

En el siguiente ejemplo de get-transit-gateway-registrations, se obtienen las puertas de enlace de tránsito que están registradas en la red global especificada.

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

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar get-vpc-attachment.

AWS CLI

Para obtener una asociación a VPC

El siguiente ejemplo de get-vpc-attachment devuelve información sobre una asociación a VPC.

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

Salida:

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

Para obtener más información, consulte Attachments en la Guía del usuario de WAN en la nube.

  • Para obtener información sobre la API, consulte GetVpcAttachment en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar list-bucket-analytics-configurations.

AWS CLI

Recuperar una lista de configuraciones de análisis para un bucket

El siguiente list-bucket-analytics-configurations recupera una lista de configuraciones de análisis para el bucket especificado.

aws s3api list-bucket-analytics-configurations \ --bucket amzn-s3-demo-bucket

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar list-bucket-metrics-configurations.

AWS CLI

Para recuperar una lista de las configuraciones de métricas para un bucket

En el siguiente ejemplo de list-bucket-metrics-configurations se recupera una lista de configuraciones de métricas para el bucket especificado.

aws s3api list-bucket-metrics-configurations \ --bucket amzn-s3-demo-bucket

Salida:

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

En el siguiente ejemplo de código, se muestra cómo utilizar list-tags-for-resource.

AWS CLI

Para enumerar las etiquetas de un recurso

En el siguiente ejemplo de list-tags-for-resource se enumeran las etiquetas del recurso de dispositivo especificado (device-07f6fd08867abc123).

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

Salida:

{ "TagList": [ { "Key": "Network", "Value": "Northeast" } ] }
  • Para ver los detalles de la API, consulte ListTagsForResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar put-bucket-metrics-configuration.

AWS CLI

Para establecer una configuración de métricas para un bucket

En el siguiente ejemplo de put-bucket-metrics-configuration se establece una configuración de métricas para ID 123 para el bucket especificado.

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

Este comando no genera ninguna salida.

En el siguiente ejemplo de código, se muestra cómo utilizar put-object-retention.

AWS CLI

Para establecer la configuración de retención de un objeto

En el siguiente ejemplo de put-object-retention, se establece una configuración de retención del objeto especificado hasta el 1 de enero de 2025.

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

Este comando no genera ninguna salida.

  • Para obtener información sobre la API, consulte PutObjectRetention en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar put-public-access-block.

AWS CLI

Para establecer la configuración de bloqueo de acceso público para un bucket

En el siguiente ejemplo de put-public-access-block se establece una configuración de bloqueo de acceso público restrictiva para el bucket especificado.

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

Este comando no genera ninguna salida.

  • Para obtener información sobre la API, consulte PutPublicAccessBlock en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar register-transit-gateway.

AWS CLI

Para registrar una puerta de enlace de tránsito en una red global

En el siguiente ejemplo de register-transit-gateway se registra la puerta de enlace de tránsito tgw-123abc05e04123abc en la red global especificada.

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

Salida:

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

Para obtener más información, consulte Transit Gateway Registrations en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte RegisterTransitGateway en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar reject-attachment.

AWS CLI

Para rechazar una asociación

En el siguiente ejemplo de reject-attachment se rechaza una solicitud de asociación a VPC.

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

Salida:

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

Para obtener más información, consulte Attachment acceptance en la Guía del usuario de WAN en la nube.

  • Para obtener información sobre la API, consulte RejectAttachment en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar start-route-analysis.

AWS CLI

Para iniciar análisis de rutas

En el siguiente ejemplo de start-route-analysis se inicia el análisis entre un origen y un destino, incluida la include-return-path opcional.

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

Salida:

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

Para obtener más información, consulte Route Analyzer en la Guía del usuario de AWS Global Networks for Transit Gateways.

  • Para obtener información sobre la API, consulte StartRouteAnalysis en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar tag-resource.

AWS CLI

Para aplicar etiquetas a un recurso

En el siguiente ejemplo de tag-resource se aplica la etiqueta Network=Northeast al dispositivo 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

Este comando no genera ninguna salida.

  • Para ver los detalles de la API, consulte TagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar untag-resource.

AWS CLI

Para eliminar etiquetas de un recurso

En el siguiente ejemplo de untag-resource se elimina la etiqueta con la clave Network del dispositivo 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

Este comando no genera ninguna salida.

  • Para ver los detalles de la API, consulte UntagResource en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-device.

AWS CLI

Para actualizar un dispositivo

El siguiente ejemplo de update-device actualiza el dispositivo device-07f6fd08867abc123 especificando un ID de sitio para el dispositivo.

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

Salida:

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

Para obtener más información, consulte Working with Devices en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte UpdateDevice en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-global-network.

AWS CLI

Para actualizar una red global

En el siguiente ejemplo de update-global-network se actualiza la descripción de la red global global-network-01231231231231231.

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

Salida:

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

Para obtener más información, consulte Global Networks en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte UpdateGlobalNetwork en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-link.

AWS CLI

Para actualizar un enlace

El siguiente ejemplo de update-link actualiza la información de ancho de banda del enlace 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

Salida:

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

Para obtener más información, consulte Working with Links en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte UpdateLink en la Referencia de comandos de la AWS CLI.

En el siguiente ejemplo de código, se muestra cómo utilizar update-site.

AWS CLI

Para actualizar un sitio

En el siguiente ejemplo de update-site se actualiza la descripción del sitio site-444555aaabbb11223 en la red global especificada.

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

Salida:

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

Para obtener más información, consulte Working with Sites en la Guía de Transit Gateway Network Manager.

  • Para obtener información sobre la API, consulte UpdateSite en la Referencia de comandos de la AWS CLI.