Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Ejemplos de código de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo usar el Herramientas de AWS para PowerShell V5 con. AWS
Los *conceptos básicos* son ejemplos de código que muestran cómo realizar las operaciones esenciales dentro de un servicio.
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.
Los *escenarios* son ejemplos de código que muestran cómo llevar a cabo una tarea específica a través de llamadas a varias funciones dentro del servicio o combinado con otros Servicios de AWS.
Algunos servicios contienen categorías de ejemplo adicionales que muestran cómo aprovechar las bibliotecas o funciones específicas del servicio.
**Más recursos**
+ **[Guía para desarrolladores de Tools for PowerShell V5](https://docs.aws.amazon.com/powershell/v5/userguide/pstools-welcome.html)**: más información sobre su uso con PowerShell . AWS
+ **[Centro para desarrolladores de AWS](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-programming-language=programming-language%23)**: ejemplos de código que puede filtrar por categoría o por búsqueda de texto completo.
+ **[AWS Ejemplos de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)**: GitHub repositorio con código completo en los idiomas preferidos. Incluye instrucciones para configurar y ejecutar el código.
**Topics**
+ [ACM](powershell_5_acm_code_examples.md)
+ [Aplicación de escalado automático](powershell_5_application-auto-scaling_code_examples.md)
+ [WorkSpaces Aplicaciones](powershell_5_appstream_code_examples.md)
+ [Aurora](powershell_5_aurora_code_examples.md)
+ [escalado automático](powershell_5_auto-scaling_code_examples.md)
+ [AWS Budgets](powershell_5_budgets_code_examples.md)
+ [AWS Cloud9](powershell_5_cloud9_code_examples.md)
+ [CloudFormation](powershell_5_cloudformation_code_examples.md)
+ [CloudFront](powershell_5_cloudfront_code_examples.md)
+ [CloudTrail](powershell_5_cloudtrail_code_examples.md)
+ [CloudWatch](powershell_5_cloudwatch_code_examples.md)
+ [CodeCommit](powershell_5_codecommit_code_examples.md)
+ [CodeDeploy](powershell_5_codedeploy_code_examples.md)
+ [CodePipeline](powershell_5_codepipeline_code_examples.md)
+ [Amazon Cognito Identity](powershell_5_cognito-identity_code_examples.md)
+ [AWS Config](powershell_5_config-service_code_examples.md)
+ [Device Farm](powershell_5_device-farm_code_examples.md)
+ [Directory Service](powershell_5_directory-service_code_examples.md)
+ [AWS DMS](powershell_5_database-migration-service_code_examples.md)
+ [DynamoDB](powershell_5_dynamodb_code_examples.md)
+ [Amazon EC2](powershell_5_ec2_code_examples.md)
+ [Amazon ECR](powershell_5_ecr_code_examples.md)
+ [Amazon ECS](powershell_5_ecs_code_examples.md)
+ [Amazon EFS](powershell_5_efs_code_examples.md)
+ [Amazon EKS](powershell_5_eks_code_examples.md)
+ [Elastic Load Balancing - versión 1](powershell_5_elastic-load-balancing_code_examples.md)
+ [Elastic Load Balancing - versión 2](powershell_5_elastic-load-balancing-v2_code_examples.md)
+ [Amazon FSx](powershell_5_fsx_code_examples.md)
+ [Amazon Glacier](powershell_5_glacier_code_examples.md)
+ [AWS Glue](powershell_5_glue_code_examples.md)
+ [AWS Health](powershell_5_health_code_examples.md)
+ [IAM](powershell_5_iam_code_examples.md)
+ [Kinesis](powershell_5_kinesis_code_examples.md)
+ [Lambda](powershell_5_lambda_code_examples.md)
+ [Amazon ML](powershell_5_machine-learning_code_examples.md)
+ [Macie](powershell_5_macie2_code_examples.md)
+ [Lista de precios de AWS](powershell_5_pricing_code_examples.md)
+ [Resource Groups](powershell_5_resource-groups_code_examples.md)
+ [API de Resource Groups Tagging](powershell_5_resource-groups-tagging-api_code_examples.md)
+ [Route 53](powershell_5_route-53_code_examples.md)
+ [Amazon S3](powershell_5_s3_code_examples.md)
+ [CSPM de Security Hub](powershell_5_securityhub_code_examples.md)
+ [Amazon SES](powershell_5_ses_code_examples.md)
+ [Amazon SES API v2](powershell_5_sesv2_code_examples.md)
+ [Amazon SNS](powershell_5_sns_code_examples.md)
+ [Amazon SQS](powershell_5_sqs_code_examples.md)
+ [AWS STS](powershell_5_sts_code_examples.md)
+ [Soporte](powershell_5_support_code_examples.md)
+ [Systems Manager](powershell_5_ssm_code_examples.md)
+ [Amazon Translate](powershell_5_translate_code_examples.md)
+ [AWS WAFV2](powershell_5_wafv2_code_examples.md)
+ [WorkSpaces](powershell_5_workspaces_code_examples.md)
# Ejemplos de ACM con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con ACM.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-ACMCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ACMCertificate`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra cómo devolver un certificado y su cadena mediante el ARN del certificado.**
```
Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Para obtener más información sobre la API, consulte [GetCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ACMCertificateDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ACMCertificateDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve información detallada del certificado especificado.**
```
Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
**Salida:**
```
CertificateArn : arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CreatedAt : 1/21/2016 5:55:59 PM
DomainName : www.example.com
DomainValidationOptions : {www.example.com}
InUseBy : {}
IssuedAt : 1/1/0001 12:00:00 AM
Issuer :
KeyAlgorithm : RSA-2048
NotAfter : 1/1/0001 12:00:00 AM
NotBefore : 1/1/0001 12:00:00 AM
RevocationReason :
RevokedAt : 1/1/0001 12:00:00 AM
Serial :
SignatureAlgorithm : SHA256WITHRSA
Status : PENDING_VALIDATION
Subject : CN=www.example.com
SubjectAlternativeNames : {www.example.net}
```
+ Para obtener más información sobre la API, consulte [DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ACMCertificateList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ACMCertificateList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: recupera una lista de todos sus certificados ARNs y el nombre de dominio de cada uno. El cmdlet se paginará automáticamente para recuperar todos los. ARNs Para controlar manualmente la paginación, utilice el MaxItem parámetro - para controlar cuántos certificados ARNs se devuelven por cada llamada de servicio y el NextToken parámetro - para indicar el punto de partida de cada llamada.**
```
Get-ACMCertificateList
```
**Salida:**
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com
```
**Ejemplo 2: Recupera una lista de todos los certificados en los ARNs que el estado del certificado coincide con los estados proporcionados.**
```
Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"
```
**Ejemplo 3: Este ejemplo devuelve una lista de todos los certificados de la región us-east-1 que tienen el tipo de clave RSA\$12048 y el uso o propósito de clave extendido CODE\$1SIGNING. Puede encontrar los valores de estos parámetros de filtrado en el tema de referencia de la API de ListCertificates filtros: https://docs.aws.amazon.com/acm/ latest/APIReference/API \$1Filters.html.**
```
Get-ACMCertificateList -Region us-east-1 -Includes_KeyType RSA_2048 -Includes_ExtendedKeyUsage CODE_SIGNING
```
**Salida:**
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-d7c0-48c1-af8d-2133d8f30zzz *.route53docs.com
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-98a5-443d-a734-800430c80zzz nerdzizm.net
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-2be6-4376-8fa7-bad559525zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-e7ca-44c5-803e-24d9f2f36zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-1241-4b71-80b1-090305a62zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-8709-4568-8c64-f94617c99zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-a8fa-4a61-98cf-e08ccc0eezzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-fa47-40fe-a714-2d277d3eezzz *.route53docs.com
```
+ Para obtener más información sobre la API, consulte [ListCertificates Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-ACMCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ACMCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un certificado nuevo. El servicio devuelve el ARN del nuevo certificado.**
```
New-ACMCertificate -DomainName "www.example.com"
```
**Salida:**
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
**Ejemplo 2: Crea un certificado nuevo. El servicio devuelve el ARN del nuevo certificado.**
```
New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"
```
**Salida:**
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
+ Para obtener más información sobre la API, consulte [RequestCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ACMCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ACMCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina el certificado identificado por el ARN y la clave privada asociada proporcionados. El cmdlet pedirá confirmación antes de continuar con la operación; para suprimir la confirmación, utilice el modificador -Force.**
```
Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Para obtener más información sobre la API, consulte [DeleteCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Send-ACMValidationEmail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-ACMValidationEmail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Solicita que se envíe el correo electrónico para validar la propiedad del dominio de “www.example.com”. Si el valor \$1 de su shell ConfirmPreference está configurado en «Medio» o inferior, el cmdlet solicitará la confirmación antes de continuar. Añada el modificador -Force para suprimir la solicitud de confirmación.**
```
$params = @{
CertificateArn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
Domain="www.example.com"
ValidationDomain="example.com"
}
Send-ACMValidationEmail @params
```
+ Para obtener más información sobre la API, consulte la referencia de [ResendValidationEmail Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*cmdlets* (V5).
# Ejemplos de Application Auto Scaling utilizando Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Application Auto Scaling.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-AASScalableTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-AASScalableTarget`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: Este cmdlet registra o actualiza un destino escalable. Un destino escalable es un recurso que se puede escalar horizontalmente o reducir horizontalmente con Application Auto Scaling.**
```
Add-AASScalableTarget -ServiceNamespace AppStream -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -MinCapacity 2 -MaxCapacity 10
```
+ Para obtener más información sobre la API, consulte [RegisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-AASScalableTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-AASScalableTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se proporcionará información acerca de los destinos escalables de Application Auto Scaling en el espacio de nombres especificado.**
```
Get-AASScalableTarget -ServiceNamespace "AppStream"
```
**Salida:**
```
CreationTime : 11/7/2019 2:30:03 AM
MaxCapacity : 5
MinCapacity : 1
ResourceId : fleet/Test
RoleARN : arn:aws:iam::012345678912:role/aws-service-role/appstream.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_AppStreamFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
SuspendedState : Amazon.ApplicationAutoScaling.Model.SuspendedState
```
+ Para obtener más información sobre la API, consulte [DescribeScalableTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-AASScalingActivity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-AASScalingActivity`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Proporciona información descriptiva sobre las actividades de escalado en el espacio de nombres especificado de las seis semanas anteriores.**
```
Get-AASScalingActivity -ServiceNamespace AppStream
```
**Salida:**
```
ActivityId : 2827409f-b639-4cdb-a957-8055d5d07434
Cause : monitor alarm Appstream2-MyFleet-default-scale-in-Alarm in state ALARM triggered policy default-scale-in
Description : Setting desired capacity to 2.
Details :
EndTime : 12/14/2019 11:32:49 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StartTime : 12/14/2019 11:32:14 AM
StatusCode : Successful
StatusMessage : Successfully set desired capacity to 2. Change successfully fulfilled by appstream.
```
+ Para obtener más información sobre la API, consulte [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-AASScalingPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-AASScalingPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet describe las políticas de escalado de Application Auto Scaling para el espacio de nombres del servicio especificado.**
```
Get-AASScalingPolicy -ServiceNamespace AppStream
```
**Salida:**
```
Alarms : {Appstream2-LabFleet-default-scale-out-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-out
PolicyName : default-scale-out
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
Alarms : {Appstream2-LabFleet-default-scale-in-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-in
PolicyName : default-scale-in
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
```
+ Para obtener más información sobre la API, consulte [DescribeScalingPolicies](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-AASScheduledAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-AASScheduledAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra una lista de acciones programadas para su grupo de Auto Scaling que no se han ejecutado o que no han alcanzado su hora de finalización.**
```
Get-AASScheduledAction -ServiceNamespace AppStream
```
**Salida:**
```
CreationTime : 12/22/2019 9:25:52 AM
EndTime : 1/1/0001 12:00:00 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ScalableTargetAction : Amazon.ApplicationAutoScaling.Model.ScalableTargetAction
Schedule : cron(0 0 8 ? * MON-FRI *)
ScheduledActionARN : arn:aws:autoscaling:us-west-2:012345678912:scheduledAction:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:scheduledActionName
/WeekDaysFleetScaling
ScheduledActionName : WeekDaysFleetScaling
ServiceNamespace : appstream
StartTime : 1/1/0001 12:00:00 AM
```
+ Para obtener más información sobre la API, consulte [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-AASScalableTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-AASScalableTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet anula el registro de un destino escalable de Application Auto Scaling. Al anular el registro de un destino escalable, se eliminan las políticas de escalado asociadas a él.**
```
Remove-AASScalableTarget -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -ServiceNamespace AppStream
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScalableTarget (DeregisterScalableTarget)" on target "fleet/MyFleet".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeregisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-AASScalingPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-AASScalingPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina la política de escalado especificada para un destino escalable de Application Auto Scaling.**
```
Remove-AASScalingPolicy -ServiceNamespace AppStream -PolicyName "default-scale-out" -ResourceId fleet/Test -ScalableDimension appstream:fleet:DesiredCapacity
```
+ Para obtener más información sobre la API, consulte [DeleteScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-AASScheduledAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-AASScheduledAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina la acción programada especificada para un destino escalable de Application Auto Scaling.**
```
Remove-AASScheduledAction -ServiceNamespace AppStream -ScheduledActionName WeekDaysFleetScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScheduledAction (DeleteScheduledAction)" on target "WeekDaysFleetScaling".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-AASScalingPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-AASScalingPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet crea o actualiza una política para un destino escalable de Application Auto Scaling. Cada destino escalable se identifica mediante un espacio de nombres de servicio, un ID de recurso y una dimensión escalable.**
```
Set-AASScalingPolicy -ServiceNamespace AppStream -PolicyName ASFleetScaleInPolicy -PolicyType StepScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -StepScalingPolicyConfiguration_AdjustmentType ChangeInCapacity -StepScalingPolicyConfiguration_Cooldown 360 -StepScalingPolicyConfiguration_MetricAggregationType Average -StepScalingPolicyConfiguration_StepAdjustments @{ScalingAdjustment = -1; MetricIntervalUpperBound = 0}
```
**Salida:**
```
Alarms PolicyARN
------ ---------
{} arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
```
+ Para obtener más información sobre la API, consulte [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-AASScheduledAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-AASScheduledAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet crea o actualiza una acción programada para un destino escalable de Application Auto Scaling. Cada destino escalable se identifica mediante un espacio de nombres de servicio, un ID de recurso y una dimensión escalable.**
```
Set-AASScheduledAction -ServiceNamespace AppStream -ResourceId fleet/MyFleet -Schedule "cron(0 0 8 ? * MON-FRI *)" -ScalableDimension appstream:fleet:DesiredCapacity -ScheduledActionName WeekDaysFleetScaling -ScalableTargetAction_MinCapacity 5 -ScalableTargetAction_MaxCapacity 10
```
+ Para obtener más información sobre la API, consulte [PutScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# WorkSpaces Ejemplos de aplicaciones que utilizan Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con WorkSpaces aplicaciones.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-APSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-APSResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este ejemplo agrega una etiqueta de recurso al AppStream recurso**
```
Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^Tag
```
**Salida:**
```
Name Value
---- -----
StackState Test
```
+ Para obtener más información sobre la API, consulte [TagResource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Copy-APSImage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Copy-APSImage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se copia una imagen a otra región**
```
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell
```
**Salida:**
```
TestImageCopy
```
+ Para obtener más información sobre la API, consulte [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-APSUSer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-APSUSer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo deshabilita un usuario en USERPOOL.**
```
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obtener más información sobre la API, consulte [DisableUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-APSUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-APSUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo habilita un usuario en USERPOOL.**
```
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obtener más información sobre la API, consulte [EnableUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSAssociatedFleetList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSAssociatedFleetList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la flota asociada a una pila.**
```
Get-APSAssociatedFleetList -StackName PowershellStack
```
**Salida:**
```
PowershellFleet
```
+ Para obtener más información sobre la API, consulte [ListAssociatedFleets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSAssociatedStackList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSAssociatedStackList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la pila asociada a una flota.**
```
Get-APSAssociatedStackList -FleetName PowershellFleet
```
**Salida:**
```
PowershellStack
```
+ Para obtener más información sobre la API, consulte [ListAssociatedStacks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSDirectoryConfigList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSDirectoryConfigList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las configuraciones de directorio creadas en AppStream**
```
Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTime
```
**Salida:**
```
DirectoryName OrganizationalUnitDistinguishedNames CreatedTime
------------- ------------------------------------ -----------
Test.com {OU=AppStream,DC=Test,DC=com} 9/6/2019 10:56:40 AM
contoso.com {OU=AppStream,OU=contoso,DC=contoso,DC=com} 8/9/2019 9:08:50 AM
```
+ Para obtener más información sobre la API, consulte [DescribeDirectoryConfigs Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSFleetList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSFleetList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los detalles de una flota.**
```
Get-APSFleetList -Name Test
```
**Salida:**
```
Arn : arn:aws:appstream:us-east-1:1234567890:fleet/Test
ComputeCapacityStatus : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime : 9/12/2019 5:00:45 PM
Description : Test
DisconnectTimeoutInSeconds : 900
DisplayName : Test
DomainJoinInfo :
EnableDefaultInternetAccess : False
FleetErrors : {}
FleetType : ON_DEMAND
IamRoleArn :
IdleDisconnectTimeoutInSeconds : 900
ImageArn : arn:aws:appstream:us-east-1:1234567890:image/Test
ImageName : Test
InstanceType : stream.standard.medium
MaxUserDurationInSeconds : 57600
Name : Test
State : STOPPED
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [DescribeFleets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSImageBuilderList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSImageBuilderList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los detalles de un ImageBuilder**
```
Get-APSImageBuilderList -Name TestImage
```
**Salida:**
```
AccessEndpoints : {}
AppstreamAgentVersion : 06-19-2019
Arn : arn:aws:appstream:us-east-1:1234567890:image-builder/TestImage
CreatedTime : 1/14/2019 4:33:05 AM
Description :
DisplayName : TestImage
DomainJoinInfo :
EnableDefaultInternetAccess : False
IamRoleArn :
ImageArn : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors : {}
InstanceType : stream.standard.large
Name : TestImage
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform : WINDOWS
State : STOPPED
StateChangeReason :
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [DescribeImageBuilders Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSImageList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSImageList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran imágenes privadas AppStream **
```
Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arn
```
**Salida:**
```
DisplayName ImageBuilderName Visibility Arn
----------- ---------------- ---------- ---
OfficeApps OfficeApps PRIVATE arn:aws:appstream:us-east-1:123456789012:image/OfficeApps
SessionScriptV2 SessionScriptTest PRIVATE arn:aws:appstream:us-east-1:123456789012:image/SessionScriptV2
```
+ Para obtener más información sobre la API, consulte [DescribeImages Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSImagePermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSImagePermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los permisos de imagen en una imagen compartida AppStream **
```
Get-APSImagePermission -Name Powershell | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}
```
**Salida:**
```
SharedAccountId AllowFleet AllowImageBuilder
--------------- ---------- -----------------
123456789012 True True
```
+ Para obtener más información sobre la API, consulte [DescribeImagePermissions Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSSessionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSSessionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra una lista de sesiones en una flota.**
```
Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStack
```
**Salida:**
```
AuthenticationType : API
ConnectionState : CONNECTED
FleetName : PowershellFleet
Id : d8987c70-4394-4324-a396-2d485c26f2a2
MaxExpirationTime : 12/27/2019 4:54:07 AM
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
StackName : PowershellStack
StartTime : 12/26/2019 12:54:12 PM
State : ACTIVE
UserId : Test
```
+ Para obtener más información sobre la API, consulte [DescribeSessions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSStackList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSStackList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo muestra la lista de Stack AppStream **
```
Get-APSStackList | Select DisplayName, Arn, CreatedTime
```
**Salida:**
```
DisplayName Arn CreatedTime
----------- --- -----------
PowershellStack arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack 4/24/2019 8:49:29 AM
SessionScriptTest arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest 9/12/2019 3:23:12 PM
```
+ Para obtener más información sobre la API, consulte [DescribeStacks Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSTagsForResourceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSTagsForResourceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas de un recurso AppStream **
```
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest
```
**Salida:**
```
Key Value
--- -----
StackState Test
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSUsageReportSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSUsageReportSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los detalles AppStreamUsageReport de configuración**
```
Get-APSUsageReportSubscription
```
**Salida:**
```
LastGeneratedReportDate S3BucketName Schedule SubscriptionErrors
----------------------- ------------ -------- ------------------
1/1/0001 12:00:00 AM appstream-logs-us-east-1-123456789012-sik1hnxe DAILY {}
```
+ Para obtener más información sobre la API, consulte [DescribeUsageReportSubscriptions Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-APSUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra una lista de usuarios con el estado activado.**
```
Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, Enabled
```
**Salida:**
```
UserName AuthenticationType Enabled
-------- ------------------ -------
foo1@contoso.com USERPOOL True
foo2@contoso.com USERPOOL True
foo3@contoso.com USERPOOL True
foo4@contoso.com USERPOOL True
foo5@contoso.com USERPOOL True
```
+ Para obtener más información sobre la API, consulte [DescribeUsers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-APSUserStackAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-APSUserStackAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo muestra la lista de usuarios asignados a una pila.**
```
Get-APSUserStackAssociation -StackName PowershellStack
```
**Salida:**
```
AuthenticationType SendEmailNotification StackName UserName
------------------ --------------------- --------- --------
USERPOOL False PowershellStack TestUser1@lab.com
USERPOOL False PowershellStack TestUser2@lab.com
```
+ Para obtener más información sobre la API, consulte [DescribeUserStackAssociations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-APSDirectoryConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSDirectoryConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una configuración de directorio en AppStream**
```
New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"
```
**Salida:**
```
CreatedTime DirectoryName OrganizationalUnitDistinguishedNames ServiceAccountCredentials
----------- ------------- ------------------------------------ -------------------------
12/27/2019 11:00:30 AM contoso.com {OU=AppStream,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials
```
+ Para obtener más información sobre la API, consulte [CreateDirectoryConfig Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una flota nueva AppStream **
```
New-APSFleet -ComputeCapacity_DesiredInstance 1 -InstanceType stream.standard.medium -Name TestFleet -DisplayName TestFleet -FleetType ON_DEMAND -EnableDefaultInternetAccess $True -VpcConfig_SubnetIds "subnet-123ce32","subnet-a1234cfd" -VpcConfig_SecurityGroupIds sg-4d012a34 -ImageName SessionScriptTest -Region us-west-2
```
**Salida:**
```
Arn : arn:aws:appstream:us-west-2:123456789012:fleet/TestFleet
ComputeCapacityStatus : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime : 12/27/2019 11:24:42 AM
Description :
DisconnectTimeoutInSeconds : 900
DisplayName : TestFleet
DomainJoinInfo :
EnableDefaultInternetAccess : True
FleetErrors : {}
FleetType : ON_DEMAND
IamRoleArn :
IdleDisconnectTimeoutInSeconds : 0
ImageArn : arn:aws:appstream:us-west-2:123456789012:image/SessionScriptTest
ImageName : SessionScriptTest
InstanceType : stream.standard.medium
MaxUserDurationInSeconds : 57600
Name : TestFleet
State : STOPPED
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [CreateFleet Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-APSImageBuilder`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSImageBuilder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un Image Builder en AppStream**
```
New-APSImageBuilder -InstanceType stream.standard.medium -Name TestIB -DisplayName TestIB -ImageName AppStream-WinServer2012R2-12-12-2019 -EnableDefaultInternetAccess $True -VpcConfig_SubnetId subnet-a1234cfd -VpcConfig_SecurityGroupIds sg-2d012a34 -Region us-west-2
```
**Salida:**
```
AccessEndpoints : {}
AppstreamAgentVersion : 12-16-2019
Arn : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime : 12/27/2019 11:39:24 AM
Description :
DisplayName : TestIB
DomainJoinInfo :
EnableDefaultInternetAccess : True
IamRoleArn :
ImageArn : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors : {}
InstanceType : stream.standard.medium
Name : TestIB
NetworkAccessConfiguration :
Platform : WINDOWS
State : PENDING
StateChangeReason :
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [CreateImageBuilder Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-APSImageBuilderStreamingURL`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSImageBuilderStreamingURL`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una URL ImageBuilder de streaming con una validez de 2 horas**
```
New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2
```
**Salida:**
```
Expires StreamingURL
------- ------------
12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F
```
+ Para obtener información sobre la API, consulte [CreateImageBuilderStreamingla URL](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (V5)*.
### `New-APSStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una pila nueva AppStream **
```
New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2
```
**Salida:**
```
AccessEndpoints : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn : arn:aws:appstream:us-west-2:123456789012:stack/TestStack
CreatedTime : 12/27/2019 12:34:19 PM
Description :
DisplayName : TestStack
EmbedHostDomains : {}
FeedbackURL :
Name : TestStack
RedirectURL :
StackErrors : {}
StorageConnectors : {}
UserSettings : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}
```
+ Para obtener más información sobre la API, consulte [CreateStack Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-APSStreamingURL`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSStreamingURL`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una URL de streaming de la pila.**
```
New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUser
```
**Salida:**
```
Expires StreamingURL
------- ------------
12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2
```
+ Para obtener información sobre la API, consulte [CreateStreamingla URL en la](https://docs.aws.amazon.com/powershell/v5/reference) *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-APSUsageReportSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSUsageReportSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo habilita los informes AppStream de uso**
```
New-APSUsageReportSubscription
```
**Salida:**
```
S3BucketName Schedule
------------ --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
```
+ Para obtener más información sobre la API, consulte [CreateUsageReportSubscription Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-APSUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-APSUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un usuario en USERPOOL.**
```
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName
```
**Salida:**
```
Test@lab.com
```
+ Para obtener más información sobre la API, consulte [CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra la flota con una pila.**
```
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obtener más información sobre la API, consulte [AssociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-APSUserStackBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-APSUserStackBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asigna una pila a un usuario de USERPOOL.**
```
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obtener más información sobre la API, consulte [BatchAssociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-APSDirectoryConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSDirectoryConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la configuración AppStream del directorio**
```
Remove-APSDirectoryConfig -DirectoryName contoso.com
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSDirectoryConfig (DeleteDirectoryConfig)" on target "contoso.com".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteDirectoryConfig Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina o elimina una flota AppStream **
```
Remove-APSFleet -Name TestFleet -Region us-west-2
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSFleet (DeleteFleet)" on target "TestFleet".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteFleet Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-APSImage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSImage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina una imagen.**
```
Remove-APSImage -Name TestImage -Region us-west-2
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImage (DeleteImage)" on target "TestImage".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
Applications : {}
AppstreamAgentVersion : LATEST
Arn : arn:aws:appstream:us-west-2:123456789012:image/TestImage
BaseImageArn :
CreatedTime : 12/27/2019 1:34:10 PM
Description :
DisplayName : TestImage
ImageBuilderName :
ImageBuilderSupported : True
ImagePermissions :
Name : TestImage
Platform : WINDOWS
PublicBaseImageReleasedDate : 6/12/2018 12:00:00 AM
State : AVAILABLE
StateChangeReason :
Visibility : PRIVATE
```
+ Para obtener más información sobre la API, consulte [DeleteImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-APSImageBuilder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSImageBuilder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina un ImageBuilder**
```
Remove-APSImageBuilder -Name TestIB -Region us-west-2
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImageBuilder (DeleteImageBuilder)" on target "TestIB".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
AccessEndpoints : {}
AppstreamAgentVersion : 12-16-2019
Arn : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime : 12/27/2019 11:39:24 AM
Description :
DisplayName : TestIB
DomainJoinInfo :
EnableDefaultInternetAccess : True
IamRoleArn :
ImageArn : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors : {}
InstanceType : stream.standard.medium
Name : TestIB
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform : WINDOWS
State : DELETING
StateChangeReason :
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [DeleteImageBuilder Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-APSImagePermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSImagePermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se eliminan los permisos de una imagen.**
```
Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImagePermission (DeleteImagePermissions)" on target "Powershell".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-APSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina una etiqueta de recurso del AppStream recurso**
```
Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackState
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSResourceTag (UntagResource)" on target "arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [UntagResource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-APSStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina una pila.**
```
Remove-APSStack -Name TestStack -Region us-west-2
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSStack (DeleteStack)" on target "TestStack".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-APSUsageReportSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSUsageReportSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo desactiva la suscripción a los informes AppStream de uso**
```
Remove-APSUsageReportSubscription
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUsageReportSubscription (DeleteUsageReportSubscription)" on target "".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteUsageReportSubscription Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-APSUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-APSUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina un usuario de USERPOOL.**
```
Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOL
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUser (DeleteUser)" on target "TestUser@lab.com".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A
```
+ Para obtener más información sobre la API, consulte [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Revoke-APSSession`
En el siguiente ejemplo de código, se muestra cómo utilizar `Revoke-APSSession`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se revoca una sesión con la flota AppStream **
```
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
```
+ Para obtener más información sobre la API, consulte [ExpireSession Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Start-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se inicia una flota.**
```
Start-APSFleet -Name PowershellFleet
```
+ Para obtener más información sobre la API, consulte [StartFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-APSImageBuilder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-APSImageBuilder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo inicia un ImageBuilder**
```
Start-APSImageBuilder -Name TestImage
```
**Salida:**
```
AccessEndpoints : {}
AppstreamAgentVersion : 06-19-2019
Arn : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime : 1/14/2019 4:33:05 AM
Description :
DisplayName : TestImage
DomainJoinInfo :
EnableDefaultInternetAccess : False
IamRoleArn :
ImageArn : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors : {}
InstanceType : stream.standard.large
Name : TestImage
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform : WINDOWS
State : PENDING
StateChangeReason :
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [StartImageBuilder Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Stop-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se detiene una flota.**
```
Stop-APSFleet -Name PowershellFleet
```
+ Para obtener más información sobre la API, consulte [StopFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-APSImageBuilder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-APSImageBuilder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo detiene un ImageBuilder**
```
Stop-APSImageBuilder -Name TestImage
```
**Salida:**
```
AccessEndpoints : {}
AppstreamAgentVersion : 06-19-2019
Arn : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime : 1/14/2019 4:33:05 AM
Description :
DisplayName : TestImage
DomainJoinInfo :
EnableDefaultInternetAccess : False
IamRoleArn :
ImageArn : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors : {}
InstanceType : stream.standard.large
Name : TestImage
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform : WINDOWS
State : STOPPING
StateChangeReason :
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [StopImageBuilder Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Unregister-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela el registro de una flota de una pila.**
```
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obtener más información sobre la API, consulte [DisassociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-APSUserStackBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-APSUserStackBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina un usuario de una pila asignada.**
```
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obtener más información sobre la API, consulte [BatchDisassociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-APSDirectoryConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-APSDirectoryConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo actualiza la configuración del directorio creada en AppStream**
```
Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"
```
**Salida:**
```
CreatedTime DirectoryName OrganizationalUnitDistinguishedNames ServiceAccountCredentials
----------- ------------- ------------------------------------ -------------------------
12/27/2019 3:50:02 PM contoso.com {OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials
```
+ Para obtener más información sobre la API, consulte [UpdateDirectoryConfig Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Update-APSFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-APSFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualizan las propiedades de una flota.**
```
Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950
```
**Salida:**
```
Arn : arn:aws:appstream:us-east-1:123456789012:fleet/PowershellFleet
ComputeCapacityStatus : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime : 4/24/2019 8:39:41 AM
Description : PowershellFleet
DisconnectTimeoutInSeconds : 950
DisplayName : PowershellFleet
DomainJoinInfo :
EnableDefaultInternetAccess : True
FleetErrors : {}
FleetType : ON_DEMAND
IamRoleArn :
IdleDisconnectTimeoutInSeconds : 900
ImageArn : arn:aws:appstream:us-east-1:123456789012:image/Powershell
ImageName : Powershell
InstanceType : stream.standard.medium
MaxUserDurationInSeconds : 57600
Name : PowershellFleet
State : STOPPED
VpcConfig : Amazon.AppStream.Model.VpcConfig
```
+ Para obtener más información sobre la API, consulte [UpdateFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-APSImagePermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-APSImagePermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se comparte una AppStream imagen con otra cuenta**
```
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
```
+ Para obtener más información sobre la API, consulte [UpdateImagePermissions Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Update-APSStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-APSStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza (se habilita) la persistencia de la configuración de la aplicación y las carpetas principales de una pila.**
```
Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}
```
**Salida:**
```
AccessEndpoints : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn : arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack
CreatedTime : 4/24/2019 8:49:29 AM
Description : PowershellStack
DisplayName : PowershellStack
EmbedHostDomains : {}
FeedbackURL :
Name : PowershellStack
RedirectURL :
StackErrors : {}
StorageConnectors : {Amazon.AppStream.Model.StorageConnector, Amazon.AppStream.Model.StorageConnector}
UserSettings : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}
```
+ Para obtener más información sobre la API, consulte [UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Aurora con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Aurora.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-RDSOrderableDBInstanceOption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RDSOrderableDBInstanceOption`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: este ejemplo enumera las versiones del motor de base de datos que admiten una clase de instancia de base de datos concreta en una Región de AWS.**
```
$params = @{
Engine = 'aurora-postgresql'
DBInstanceClass = 'db.r5.large'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
**Ejemplo 2: este ejemplo enumera las clases de instancia de base de datos que se admiten para una versión de motor de base de datos concreta en una Región de AWS.**
```
$params = @{
Engine = 'aurora-postgresql'
EngineVersion = '13.6'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
+ Para obtener información sobre la API, consulte [DescribeOrderableDBInstancelas opciones](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Auto Scaling con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Auto Scaling.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-ASLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ASLoadBalancer`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: En este ejemplo se asocia el equilibrador de carga especificado al grupo de escalado automático especificado.**
```
Add-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [AttachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Complete-ASLifecycleAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Complete-ASLifecycleAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se completa la acción del ciclo de vida especificada.**
```
Complete-ASLifecycleAction -LifecycleHookName myLifecycleHook -AutoScalingGroupName my-asg -LifecycleActionResult CONTINUE -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ Para obtener más información sobre la API, consulte [CompleteLifecycleAction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-ASMetricsCollection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-ASMetricsCollection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se deshabilita la supervisión de las métricas especificadas para el grupo de escalado automático especificado.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg -Metric @("GroupMinSize", "GroupMaxSize")
```
**Ejemplo 2: En este ejemplo se deshabilita la supervisión de todas las métricas del grupo de escalado automático especificado.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [DisableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-ASInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-ASInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se desasocia la instancia especificada del grupo de escalado automático especificado y se reduce la capacidad deseada para que Auto Scaling no inicialice una instancia de sustitución.**
```
Dismount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Salida:**
```
ActivityId : 06733445-ce94-4039-be1b-b9f1866e276e
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-93633f9b was detached in response to a user request, shrinking
the capacity from 2 to 1.
Description : Detaching EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
**Ejemplo 2: En este ejemplo, se separa la instancia especificada del grupo de escalado automático especificado sin reducir la capacidad deseada. Auto Scaling inicializa una instancia de sustitución.**
```
Dismount-ASInstance -InstanceId i-7bf746a2 -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Salida:**
```
ActivityId : f43a3cd4-d38c-4af7-9fe0-d76ec2307b6d
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-7bf746a2 was detached in response to a user request.
Description : Detaching EC2 instance: i-7bf746a2
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [DetachInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-ASLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-ASLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desasocia el equilibrador de carga especificado del grupo de escalado automático especificado.**
```
Dismount-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [DetachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-ASMetricsCollection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-ASMetricsCollection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la supervisión de las métricas especificadas para el grupo de escalado automático especificado.**
```
Enable-ASMetricsCollection -Metric @("GroupMinSize", "GroupMaxSize") -AutoScalingGroupName my-asg -Granularity 1Minute
```
**Ejemplo 2: En este ejemplo se habilita la supervisión de todas las métricas del grupo de escalado automático especificado.**
```
Enable-ASMetricsCollection -AutoScalingGroupName my-asg -Granularity 1Minute
```
+ Para obtener más información sobre la API, consulte [EnableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enter-ASStandby`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enter-ASStandby`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se pone la instancia especificada en modo de espera y se reduce la capacidad deseada para que Auto Scaling no inicialice una instancia de sustitución.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Salida:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request,
shrinking the capacity from 2 to 1.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
**Ejemplo 2: En este ejemplo, se pone la instancia especificada en modo de espera sin reducir la capacidad deseada. Auto Scaling inicializa una instancia de sustitución.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Salida:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [EnterStandby](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Exit-ASStandby`
En el siguiente ejemplo de código, se muestra cómo utilizar `Exit-ASStandby`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se saca la instancia especificada del modo de espera.**
```
Exit-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
**Salida:**
```
ActivityId : 1833d3e8-e32f-454e-b731-0670ad4c6934
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:51:21Z instance i-95b8484f was moved out of standby in response to a user
request, increasing the capacity from 1 to 2.
Description : Moving EC2 instance out of Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 30
StartTime : 11/22/2015 7:51:21 AM
StatusCode : PreInService
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [ExitStandby](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASAccountLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAccountLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo describe los límites de recursos de Auto Scaling para su AWS cuenta.**
```
Get-ASAccountLimit
```
**Salida:**
```
MaxNumberOfAutoScalingGroups : 20
MaxNumberOfLaunchConfigurations : 100
```
+ Para obtener más información sobre la API, consulte [DescribeAccountLimits Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ASAdjustmentType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAdjustmentType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen los tipos de ajuste que son compatibles con el escalado automático.**
```
Get-ASAdjustmentType
```
**Salida:**
```
Type
----
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
```
+ Para obtener más información sobre la API, consulte [DescribeAdjustmentTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASAutoScalingGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAutoScalingGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran los nombres de los grupos de escalado automático.**
```
Get-ASAutoScalingGroup | format-table -property AutoScalingGroupName
```
**Salida:**
```
AutoScalingGroupName
--------------------
my-asg-1
my-asg-2
my-asg-3
my-asg-4
my-asg-5
my-asg-6
```
**Ejemplo 2: En este ejemplo, se describe el grupo de escalado automático especificado.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1
```
**Salida:**
```
AutoScalingGroupARN : arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480
f03:autoScalingGroupName/my-asg-1
AutoScalingGroupName : my-asg-1
AvailabilityZones : {us-west-2b, us-west-2a}
CreatedTime : 3/1/2015 9:05:31 AM
DefaultCooldown : 300
DesiredCapacity : 2
EnabledMetrics : {}
HealthCheckGracePeriod : 300
HealthCheckType : EC2
Instances : {my-lc}
LaunchConfigurationName : my-lc
LoadBalancerNames : {}
MaxSize : 0
MinSize : 0
PlacementGroup :
Status :
SuspendedProcesses : {}
Tags : {}
TerminationPolicies : {Default}
VPCZoneIdentifier : subnet-e4f33493,subnet-5264e837
```
**Ejemplo 3: En este ejemplo, se describen los dos grupos de escalado automático especificados.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName @("my-asg-1", "my-asg-2")
```
**Ejemplo 4: En este ejemplo, se describen las instancias de escalado automático para el grupo de escalado automático especificado.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1).Instances
```
**Ejemplo 5: En este ejemplo se describen todos los grupos de escalado automático.**
```
Get-ASAutoScalingGroup
```
**Ejemplo 6: Este LaunchTemplate ejemplo describe el grupo de Auto Scaling especificado. En este ejemplo, se supone que las «Opciones de compra de instancias» están configuradas en «Adherirse a la plantilla de inicialización». En caso de que esta opción esté configurada como «Combinar opciones de compra y tipos de instancias», se LaunchTemplate puede acceder a ella mediante»MixedInstancesPolicy. LaunchTemplate«propiedad.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-ag-1).LaunchTemplate
```
**Salida:**
```
LaunchTemplateId LaunchTemplateName Version
---------------- ------------------ -------
lt-06095fd619cb40371 test-launch-template $Default
```
+ Para obtener más información sobre la API, consulte [DescribeAutoScalingGroups Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ASAutoScalingInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAutoScalingInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran las instancias IDs de Auto Scaling.**
```
Get-ASAutoScalingInstance | format-table -property InstanceId
```
**Salida:**
```
InstanceId
----------
i-12345678
i-87654321
i-abcd1234
```
**Ejemplo 2: En este ejemplo se describe la instancia de escalado automático especificada.**
```
Get-ASAutoScalingInstance -InstanceId i-12345678
```
**Salida:**
```
AutoScalingGroupName : my-asg
AvailabilityZone : us-west-2b
HealthStatus : HEALTHY
InstanceId : i-12345678
LaunchConfigurationName : my-lc
LifecycleState : InService
```
**Ejemplo 3: En este ejemplo se describen las dos instancias de escalado automático especificadas.**
```
Get-ASAutoScalingInstance -InstanceId @("i-12345678", "i-87654321")
```
**Ejemplo 4: En este ejemplo, se describen las instancias de escalado automático para el grupo de escalado automático especificado.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg).Instances | Get-ASAutoScalingInstance
```
**Ejemplo 5: En este ejemplo se describen todas las instancias de escalado automático.**
```
Get-ASAutoScalingInstance
```
+ Para obtener más información sobre la API, consulte [DescribeAutoScalingInstances Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ASAutoScalingNotificationType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAutoScalingNotificationType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran los tipos de notificaciones que son compatibles con el escalado automático.**
```
Get-ASAutoScalingNotificationType
```
**Salida:**
```
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
```
+ Para obtener más información sobre la API, consulte [DescribeAutoScalingNotificationTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASLaunchConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASLaunchConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los nombres de las configuraciones de inicialización.**
```
Get-ASLaunchConfiguration | format-table -property LaunchConfigurationName
```
**Salida:**
```
LaunchConfigurationName
-----------------------
my-lc-1
my-lc-2
my-lc-3
my-lc-4
my-lc-5
```
**Ejemplo 2: En este ejemplo se describe la configuración de inicialización especificada.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName my-lc-1
```
**Salida:**
```
AssociatePublicIpAddress : True
BlockDeviceMappings : {/dev/xvda}
ClassicLinkVPCId :
ClassicLinkVPCSecurityGroups : {}
CreatedTime : 12/12/2014 3:22:08 PM
EbsOptimized : False
IamInstanceProfile :
ImageId : ami-043a5034
InstanceMonitoring : Amazon.AutoScaling.Model.InstanceMonitoring
InstanceType : t2.micro
KernelId :
KeyName :
LaunchConfigurationARN : arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:7e5f31e4-693b-4604-9322-
e6f68d7fafad:launchConfigurationName/my-lc-1
LaunchConfigurationName : my-lc-1
PlacementTenancy :
RamdiskId :
SecurityGroups : {sg-67ef0308}
SpotPrice :
UserData :
```
**Ejemplo 3: En este ejemplo se describen las dos configuraciones de inicialización especificadas.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName @("my-lc-1", "my-lc-2")
```
**Ejemplo 4: En este ejemplo se describen todas las configuraciones de inicialización.**
```
Get-ASLaunchConfiguration
```
+ Para obtener más información sobre la API, consulte [DescribeLaunchConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASLifecycleHook`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASLifecycleHook`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el enlace de ciclo de vida especificado.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Salida:**
```
AutoScalingGroupName : my-asg
DefaultResult : ABANDON
GlobalTimeout : 172800
HeartbeatTimeout : 3600
LifecycleHookName : myLifecycleHook
LifecycleTransition : auto-scaling:EC2_INSTANCE_LAUNCHING
NotificationMetadata :
NotificationTargetARN : arn:aws:sns:us-west-2:123456789012:my-topic
RoleARN : arn:aws:iam::123456789012:role/my-iam-role
```
**Ejemplo 2: En este ejemplo se describen los enlaces de ciclo de vida del grupo de escalado automático especificado.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg
```
**Ejemplo 3: En este ejemplo se describen todos los enlaces de ciclo de vida para todos los grupos de escalado automático.**
```
Get-ASLifecycleHook
```
+ Para obtener más información sobre la API, consulte [DescribeLifecycleHooks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASLifecycleHookType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASLifecycleHookType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran los tipos de enlaces de ciclo de vida compatibles con el escalado automático.**
```
Get-ASLifecycleHookType
```
**Salida:**
```
autoscaling:EC2_INSTANCE_LAUNCHING
auto-scaling:EC2_INSTANCE_TERMINATING
```
+ Para obtener más información sobre la API, consulte [DescribeLifecycleHookTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen los equilibradores de carga del grupo de escalado automático **especificado.
```
Get-ASLoadBalancer -AutoScalingGroupName my-asg
```
**Salida:**
```
LoadBalancerName State
---------------- -----
my-lb Added
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASMetricCollectionType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASMetricCollectionType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran los tipos de recopilación de métricas que admite el escalado automático.**
```
(Get-ASMetricCollectionType).Metrics
```
**Salida:**
```
Metric
------
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupStandbyInstances
GroupTotalInstances
```
**Ejemplo 2: En este ejemplo se enumeran las granularidades correspondientes.**
```
(Get-ASMetricCollectionType).Granularities
```
**Salida:**
```
Granularity
-----------
1Minute
```
+ Para obtener más información sobre la API, consulte [DescribeMetricCollectionTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASNotificationConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASNotificationConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las acciones de notificación asociadas al grupo de escalado automático especificado.**
```
Get-ASNotificationConfiguration -AutoScalingGroupName my-asg | format-list
```
**Salida:**
```
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_LAUNCH
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_TERMINATE
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
```
**Ejemplo 2: En este ejemplo se describen las acciones de notificación asociadas a todos los grupos de escalado automático.**
```
Get-ASNotificationConfiguration
```
+ Para obtener más información sobre la API, consulte [DescribeNotificationConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se describen todas las políticas para el grupo de escalado automático especificado.**
```
Get-ASPolicy -AutoScalingGroupName my-asg
```
**Salida:**
```
AdjustmentType : ChangeInCapacity
Alarms : {}
AutoScalingGroupName : my-asg
Cooldown : 0
EstimatedInstanceWarmup : 0
MetricAggregationType :
MinAdjustmentMagnitude : 0
MinAdjustmentStep : 0
PolicyARN : arn:aws:auto-scaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef
:autoScalingGroupName/my-asg:policyName/myScaleInPolicy
PolicyName : myScaleInPolicy
PolicyType : SimpleScaling
ScalingAdjustment : -1
StepAdjustments : {}
```
**Ejemplo 2: En este ejemplo se describen las políticas especificadas para el grupo de escalado automático especificado.**
```
Get-ASPolicy -AutoScalingGroupName my-asg -PolicyName @("myScaleOutPolicy", "myScaleInPolicy")
```
**Ejemplo 3: En este ejemplo se describen todas las políticas para todos los grupos de escalado automático.**
```
Get-ASPolicy
```
+ Para obtener más información sobre la API, consulte [DescribePolicies](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASScalingActivity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASScalingActivity`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se describen actividades de escalado de las últimas de seis semanas para el grupo de escalado automático especificado.**
```
Get-ASScalingActivity -AutoScalingGroupName my-asg
```
**Salida:**
```
ActivityId : 063308ae-aa22-4a9b-94f4-9fae4EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:45:16Z a user request explicitly set group desired capacity changing the desired
capacity from 1 to 2. At 2015-11-22T15:45:34Z an instance was started in response to a difference
between desired and actual capacity, increasing the capacity from 1 to 2.
Description : Launching a new EC2 instance: i-26e715fc
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/22/2015 7:46:09 AM
Progress : 100
StartTime : 11/22/2015 7:45:35 AM
StatusCode : Successful
StatusMessage :
ActivityId : ce719997-086d-4c73-a2f1-ab703EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:57:53Z a user request created an AutoScalingGroup changing the desired capacity
from 0 to 1. At 2015-11-20T22:57:58Z an instance was started in response to a difference betwe
en desired and actual capacity, increasing the capacity from 0 to 1.
Description : Launching a new EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/20/2015 2:58:32 PM
Progress : 100
StartTime : 11/20/2015 2:57:59 PM
StatusCode : Successful
StatusMessage :
```
**Ejemplo 2: En este ejemplo se describe la actividad de escalado especificada.**
```
Get-ASScalingActivity -ActivityId "063308ae-aa22-4a9b-94f4-9fae4EXAMPLE"
```
**Ejemplo 3: En este ejemplo se describen las actividades de escalado de las últimas seis semanas para todos los grupos de escalado automático.**
```
Get-ASScalingActivity
```
+ Para obtener más información sobre la API, consulte [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASScalingProcessType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASScalingProcessType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran los tipos de procesos que admite el escalado automático.**
```
Get-ASScalingProcessType
```
**Salida:**
```
ProcessName
-----------
AZRebalance
AddToLoadBalancer
AlarmNotification
HealthCheck
Launch
ReplaceUnhealthy
ScheduledActions
Terminate
```
+ Para obtener más información sobre la API, consulte [DescribeScalingProcessTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASScheduledAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASScheduledAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se describen las acciones de escalado programadas para el grupo de escalado automático especificado.**
```
Get-ASScheduledAction -AutoScalingGroupName my-asg
```
**Salida:**
```
AutoScalingGroupName : my-asg
DesiredCapacity : 10
EndTime :
MaxSize :
MinSize :
Recurrence :
ScheduledActionARN : arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8a4c5f24-6ec6-4306-a2dd-f7
2c3af3a4d6:autoScalingGroupName/my-asg:scheduledActionName/myScheduledAction
ScheduledActionName : myScheduledAction
StartTime : 11/30/2015 8:00:00 AM
Time : 11/30/2015 8:00:00 AM
```
**Ejemplo 2: En este ejemplo, se describen las acciones de escalado programadas especificadas.**
```
Get-ASScheduledAction -ScheduledActionName @("myScheduledScaleOut", "myScheduledScaleIn")
```
**Ejemplo 3: En este ejemplo, se describen las acciones de escalado programadas que comienzan a la hora especificada.**
```
Get-ASScheduledAction -StartTime "2015-12-01T08:00:00Z"
```
**Ejemplo 4: En este ejemplo, se describen las acciones de escalado programadas que finalizan a la hora especificada.**
```
Get-ASScheduledAction -EndTime "2015-12-30T08:00:00Z"
```
**Ejemplo 5: En este ejemplo, se describen las acciones de escalado programadas para todos los grupos de escalado automático.**
```
Get-ASScheduledAction
```
+ Para obtener más información sobre la API, consulte [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las etiquetas con un valor clave de «myTag» o «myTag2». Los valores posibles para el nombre del filtro son auto-scaling-group '', 'clave', 'valor' y 'propagate-at-launch'. La sintaxis utilizada en este ejemplo requiere PowerShell la versión 3 o posterior.**
```
Get-ASTag -Filter @( @{ Name="key"; Values=@("myTag", "myTag2") } )
```
**Salida:**
```
Key : myTag2
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue2
Key : myTag
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear el filtro para el parámetro Filter.**
```
$keys = New-Object string[] 2
$keys[0] = "myTag"
$keys[1] = "myTag2"
$filter = New-Object Amazon.AutoScaling.Model.Filter
$filter.Name = "key"
$filter.Values = $keys
Get-ASTag -Filter @( $filter )
```
**Ejemplo 3: En este ejemplo se describen todas las etiquetas para todos los grupos de escalado automático.**
```
Get-ASTag
```
+ Para obtener más información sobre la API, consulte [DescribeTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-ASTerminationPolicyType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASTerminationPolicyType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran las políticas de terminación compatibles con el escalado automático.**
```
Get-ASTerminationPolicyType
```
**Salida:**
```
ClosestToNextInstanceHour
Default
NewestInstance
OldestInstance
OldestLaunchConfiguration
```
+ Para obtener más información sobre la API, consulte [DescribeTerminationPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Mount-ASInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Mount-ASInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se asocia la instancia especificada al grupo de escalado automático especificado. El escalado automático aumenta automáticamente la capacidad deseada del grupo de escalado automático.**
```
Mount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [AttachInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ASAutoScalingGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ASAutoScalingGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un grupo de escalado automático con el nombre y los atributos especificados. La capacidad deseada por defecto es el tamaño mínimo. Por lo tanto, este grupo de escalado automático inicializa dos instancias, una en cada una de las dos zonas de disponibilidad especificadas.**
```
New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
```
+ Para obtener más información sobre la API, consulte [CreateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ASLaunchConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ASLaunchConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una configuración de inicialización denominada «my-lc». Las instancias de EC2 inicializadas por los grupos de escalado automático que utilizan esta configuración de inicialización utilizan un tipo de instancia, una AMI, un grupo de seguridad y un rol de IAM específicos.**
```
New-ASLaunchConfiguration -LaunchConfigurationName my-lc -InstanceType "m3.medium" -ImageId "ami-12345678" -SecurityGroup "sg-12345678" -IamInstanceProfile "myIamRole"
```
+ Para obtener más información sobre la API, consulte [CreateLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASAutoScalingGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASAutoScalingGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de escalado automático especificado si no tiene instancias en ejecución. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASAutoScalingGroup (DeleteAutoScalingGroup)" on Target "my-asg".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -Force
```
**Ejemplo 3: En este ejemplo se elimina el grupo de escalado automático especificado y se finalizan todas las instancias en ejecución que contenga.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -ForceDelete $true -Force
```
+ Para obtener más información sobre la API, consulte [DeleteAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASLaunchConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASLaunchConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la configuración de inicialización especificada si no está asociada a un grupo de escalado automático. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLaunchConfiguration (DeleteLaunchConfiguration)" on Target "my-lc".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc -Force
```
+ Para obtener más información sobre la API, consulte [DeleteLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASLifecycleHook`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASLifecycleHook`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el enlace de ciclo de vida especificado para el grupo de escalado automático especificado. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLifecycleHook (DeleteLifecycleHook)" on Target "myLifecycleHook".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -Force
```
+ Para obtener más información sobre la API, consulte [DeleteLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASNotificationConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASNotificationConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la acción de notificación especificada. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASNotificationConfiguration (DeleteNotificationConfiguration)" on Target
"arn:aws:sns:us-west-2:123456789012:my-topic".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic" -Force
```
+ Para obtener más información sobre la API, consulte [DeleteNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la política especificada para el grupo de escalado automático especificado. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASPolicy (DeletePolicy)" on Target "myScaleInPolicy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy -Force
```
+ Para obtener más información sobre la API, consulte [DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASScheduledAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASScheduledAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la acción programada especificada para el grupo de escalado automático especificado. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASScheduledAction (DeleteScheduledAction)" on Target "myScheduledAction".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction" -Force
```
+ Para obtener más información sobre la API, consulte [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ASTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ASTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta especificada del grupo de escalado automático especificado. Se le solicitará una confirmación antes de continuar con la operación. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } )
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ASTag (DeleteTags)" on target "Amazon.AutoScaling.Model.Tag".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Si especifica el parámetro Force, no se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } ) -Force
```
**Ejemplo 3: Con la versión 2 de PowerShell, debe usar New-Object para crear la etiqueta para el parámetro Etiqueta.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
Remove-ASTag -Tag $tag -Force
```
+ Para obtener más información sobre la API, consulte [DeleteTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Resume-ASProcess`
En el siguiente ejemplo de código, se muestra cómo utilizar `Resume-ASProcess`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reanuda el proceso de escalado automático especificado para el grupo de escalado automático especificado.**
```
Resume-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Ejemplo 2: En este ejemplo se reanudan todos los procesos de escalado automático suspendidos para el grupo de escalado automático especificado.**
```
Resume-ASProcess -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [ResumeProcesses](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ASDesiredCapacity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ASDesiredCapacity`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se establece el tamaño del grupo de escalado automático especificado.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2
```
**Ejemplo 2: En este ejemplo se establece el tamaño del grupo de escalado automático especificado y espera a que finalice el período de recuperación antes de escalar al nuevo tamaño.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2 -HonorCooldown $true
```
+ Para obtener más información sobre la API, consulte [SetDesiredCapacity](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ASInstanceHealth`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ASInstanceHealth`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se establece el estado de la instancia especificada en «Mal estado», por lo que queda fuera de servicio. El escalado automático finaliza y reemplaza la instancia.**
```
Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b
```
**Ejemplo 2: En este ejemplo, se establece el estado de la instancia especificada en «Buen estado» y se mantiene en servicio. No se respeta ningún periodo de gracia de la comprobación de estado para un grupo de escalado automático.**
```
Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
```
+ Para obtener más información sobre la API, consulte [SetInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ASInstanceProtection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ASInstanceProtection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la protección de instancias para la instancia especificada.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $true
```
**Ejemplo 2: En este ejemplo se deshabilita la protección de instancias para la instancia especificada.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $false
```
+ Para obtener más información sobre la API, consulte [SetInstanceProtection](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ASTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ASTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se agrega una etiqueta única al grupo de escalado automático especificado. La clave de la etiqueta es 'myTag' y el valor de la etiqueta es ''. myTagValue El escalado automático propaga esta etiqueta a las siguientes instancias de EC2 inicializadas por el grupo de escalado automático. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
Set-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag"; Value="myTagValue"; PropagateAtLaunch=$true} )
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear la etiqueta para el parámetro Tag.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
$tag.Value = "myTagValue"
$tag.PropagateAtLaunch = $true
Set-ASTag -Tag $tag
```
+ Para obtener más información sobre la API, consulte [CreateOrUpdateTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Start-ASPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-ASPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se ejecuta la política especificada para el grupo de escalado automático especificado.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy"
```
**Ejemplo 2: En este ejemplo se ejecuta la política especificada para el grupo de escalado automático especificado, después de esperar a que finalice el período de recuperación.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy" -HonorCooldown $true
```
+ Para obtener más información sobre la API, consulte [ExecutePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-ASInstanceInAutoScalingGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-ASInstanceInAutoScalingGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se termina la instancia especificada y se reduce la capacidad deseada de su grupo de escalado automático para que Auto Scaling no inicialice una instancia de sustitución.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $true
```
**Salida:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request, shrinking the capacity from 2 to 1.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
**Ejemplo 2: En este ejemplo, se termina la instancia especificada sin disminuir la capacidad deseada de su grupo de escalado automático. Auto Scaling inicializa una instancia de remplazo.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $false
```
**Salida:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Suspend-ASProcess`
En el siguiente ejemplo de código, se muestra cómo utilizar `Suspend-ASProcess`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se suspende el proceso de escalado automático especificado para el grupo de escalado automático especificado.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Ejemplo 2: En este ejemplo se suspenden todos los procesos de escalado automático para el grupo de escalado automático especificado.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg
```
+ Para obtener más información sobre la API, consulte [SuspendProcesses](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-ASAutoScalingGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-ASAutoScalingGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se actualiza el tamaño mínimo y máximo del grupo de escalado automático especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
```
**Ejemplo 2: En este ejemplo se actualiza el período de recuperación predeterminado del grupo de escalado automático especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
```
**Ejemplo 3: En este ejemplo se actualizan las zonas de disponibilidad del grupo de escalado automático especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
```
**Ejemplo 4: En este ejemplo, se actualiza el grupo de escalado automático especificado para utilizar comprobaciones de estado de Elastic Load Balancing.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
```
+ Para obtener más información sobre la API, consulte [UpdateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-ASLifecycleActionHeartbeat`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-ASLifecycleActionHeartbeat`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra un latido para la acción del ciclo de vida especificada. Esto mantiene la instancia en estado pendiente hasta que complete la acción personalizada.**
```
Write-ASLifecycleActionHeartbeat -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ Para obtener más información sobre la API, consulte [RecordLifecycleActionHeartbeat](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-ASLifecycleHook`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-ASLifecycleHook`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se agrega el enlace de ciclo de vida especificado al grupo de escalado automático especificado.**
```
Write-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName "myLifecycleHook" -LifecycleTransition "autoscaling:EC2_INSTANCE_LAUNCHING" -NotificationTargetARN "arn:aws:sns:us-west-2:123456789012:my-sns-topic" -RoleARN "arn:aws:iam::123456789012:role/my-iam-role"
```
+ Para obtener más información sobre la API, consulte [PutLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-ASNotificationConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-ASNotificationConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se configura el grupo de escalado automático especificado para enviar una notificación al tema de SNS especificado cuando inicialice instancias de EC2.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType "autoscaling:EC2_INSTANCE_LAUNCH" -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Ejemplo 2: En este ejemplo se configura el grupo de escalado automático especificado para enviar una notificación al tema de SNS especificado cuando inicialice o finalice las instancias de EC2.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType @("autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_TERMINATE") -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
+ Para obtener más información sobre la API, consulte [PutNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-ASScalingPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-ASScalingPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se agrega la política especificada al grupo de escalado automático especificado. El tipo de ajuste especificado determina cómo interpretar el ScalingAdjustment parámetro. Con 'ChangeInCapacity', un valor positivo aumenta la capacidad en el número especificado de instancias y un valor negativo reduce la capacidad en el número especificado de instancias.**
```
Write-ASScalingPolicy -AutoScalingGroupName my-asg -AdjustmentType "ChangeInCapacity" -PolicyName "myScaleInPolicy" -ScalingAdjustment -1
```
**Salida:**
```
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef:autoScalingGroupName/my-asg
:policyName/myScaleInPolicy
```
+ Para obtener más información sobre la API, consulte [PutScalingPolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Write-ASScheduledUpdateGroupAction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-ASScheduledUpdateGroupAction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea o actualiza una acción programada única para cambiar la capacidad deseada a la hora de inicio especificada.**
```
Write-ASScheduledUpdateGroupAction -AutoScalingGroupName my-asg -ScheduledActionName "myScheduledAction" -StartTime "2015-12-01T00:00:00Z" -DesiredCapacity 10
```
+ Para obtener más información sobre la API, consulte [PutScheduledUpdateGroupAction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS Budgets ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS Budgets
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `New-BGTBudget`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-BGTBudget`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Crea un nuevo presupuesto con las restricciones presupuestarias y de tiempo especificadas mediante notificaciones por correo electrónico.**
```
$notification = @{
NotificationType = "ACTUAL"
ComparisonOperator = "GREATER_THAN"
Threshold = 80
}
$addressObject = @{
Address = @("user@domain.com")
SubscriptionType = "EMAIL"
}
$subscriber = New-Object Amazon.Budgets.Model.NotificationWithSubscribers
$subscriber.Notification = $notification
$subscriber.Subscribers.Add($addressObject)
$startDate = [datetime]::new(2017,09,25)
$endDate = [datetime]::new(2017,10,25)
New-BGTBudget -Budget_BudgetName "Tester" -Budget_BudgetType COST -CostTypes_IncludeTax $true -Budget_TimeUnit MONTHLY -BudgetLimit_Unit USD -TimePeriod_Start $startDate -TimePeriod_End $endDate -AccountId 123456789012 -BudgetLimit_Amount 200 -NotificationsWithSubscriber $subscriber
```
+ Para obtener más información sobre la API, consulte [CreateBudget](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS Cloud9 ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS Cloud9
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-C9EnvironmentData`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-C9EnvironmentData`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: en este ejemplo se obtiene información sobre los entornos de desarrollo de AWS Cloud9 especificados.**
```
Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX,1980b80e5f584920801c09086667f0EX
```
**Salida:**
```
Arn : arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX
Description : Created from CodeStar.
Id : 685f892f431b45c2b28cb69eadcdb0EX
Lifecycle : Amazon.Cloud9.Model.EnvironmentLifecycle
Name : my-demo-ec2-env
OwnerArn : arn:aws:iam::123456789012:user/MyDemoUser
Type : ec2
Arn : arn:aws:cloud9:us-east-1:123456789012:environment:1980b80e5f584920801c09086667f0EX
Description :
Id : 1980b80e5f584920801c09086667f0EX
Lifecycle : Amazon.Cloud9.Model.EnvironmentLifecycle
Name : my-demo-ssh-env
OwnerArn : arn:aws:iam::123456789012:user/MyDemoUser
Type : ssh
```
**Ejemplo 2: Este ejemplo obtiene información sobre el estado del ciclo de vida del entorno de desarrollo AWS Cloud9 especificado.**
```
(Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX).Lifecycle
```
**Salida:**
```
FailureResource Reason Status
--------------- ------ ------
CREATED
```
+ Para obtener más información sobre la API, consulte [DescribeEnvironments Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-C9EnvironmentList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-C9EnvironmentList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de los identificadores del entorno de desarrollo de AWS Cloud9 disponibles.**
```
Get-C9EnvironmentList
```
**Salida:**
```
685f892f431b45c2b28cb69eadcdb0EX
1980b80e5f584920801c09086667f0EX
```
+ Para obtener más información sobre la API, consulte [ListEnvironments Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-C9EnvironmentMembershipList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-C9EnvironmentMembershipList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtiene información sobre los miembros del entorno de desarrollo AWS Cloud9 especificado.**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
**Salida:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-write
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
**Ejemplo 2: Este ejemplo obtiene información sobre el propietario del entorno de desarrollo AWS Cloud9 especificado.**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission owner
```
**Salida:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
**Ejemplo 3: Este ejemplo obtiene información sobre el miembro del entorno especificado para varios entornos de desarrollo de AWS Cloud9.**
```
Get-C9EnvironmentMembershipList -UserArn arn:aws:iam::123456789012:user/MyDemoUser
```
**Salida:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/17/2018 7:48:14 PM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
EnvironmentId : 1980b80e5f584920801c09086667f0EX
LastAccess : 1/16/2018 11:21:24 PM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
+ Para obtener más información sobre la API, consulte [DescribeEnvironmentMemberships Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-C9EnvironmentStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-C9EnvironmentStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo obtiene información de estado del entorno de desarrollo AWS Cloud9 especificado.**
```
Get-C9EnvironmentStatus -EnvironmentId 349c86d4579e4e7298d500ff57a6b2EX
```
**Salida:**
```
Message Status
------- ------
Environment is ready to use ready
```
+ Para obtener información sobre la API, consulte [DescribeEnvironmentStatus Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-C9EnvironmentEC2`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-C9EnvironmentEC2`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un entorno de desarrollo AWS Cloud9 con la configuración especificada, se lanza una instancia de Amazon Elastic Compute Cloud (Amazon EC2) y, a continuación, se conecta desde la instancia al entorno.**
```
New-C9EnvironmentEC2 -Name my-demo-env -AutomaticStopTimeMinutes 60 -Description "My demonstration development environment." -InstanceType t2.micro -OwnerArn arn:aws:iam::123456789012:user/MyDemoUser -SubnetId subnet-d43a46EX
```
**Salida:**
```
ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obtener más información sobre la API, consulte la sección [CreateEnvironmentEc2](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (V5*).
### `New-C9EnvironmentMembership`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-C9EnvironmentMembership`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo agrega el miembro del entorno especificado al entorno de desarrollo AWS Cloud9 especificado.**
```
New-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-write
```
**Salida:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-write
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ Para obtener más información sobre la API, consulte [CreateEnvironmentMembership Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-C9Environment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-C9Environment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el entorno de desarrollo AWS Cloud9 especificado. Si hay una instancia de Amazon EC2 conectada al entorno, se termina también la instancia.**
```
Remove-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obtener más información sobre la API, consulte [DeleteEnvironment Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Remove-C9EnvironmentMembership`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-C9EnvironmentMembership`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el miembro del entorno de entorno especificado del entorno de desarrollo AWS Cloud9 especificado.**
```
Remove-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obtener más información sobre la API, consulte [DeleteEnvironmentMembership Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Update-C9Environment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-C9Environment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo cambia la configuración especificada del entorno de desarrollo AWS Cloud9 existente especificado.**
```
Update-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Description "My changed demonstration development environment." -Name my-changed-demo-env
```
+ Para obtener más información sobre la API, consulte [UpdateEnvironment Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Update-C9EnvironmentMembership`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-C9EnvironmentMembership`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo cambia la configuración del miembro del entorno existente especificado para el entorno de desarrollo AWS Cloud9 especificado.**
```
Update-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-only
```
**Salida:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-only
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ Para obtener más información sobre la API, consulte [UpdateEnvironmentMembership Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
# CloudFormation ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CloudFormation
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStack`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Devolución de una colección de instancias de pila que describen todas las pilas del usuario.**
```
Get-CFNStack
```
**Ejemplo 2: Devolución de una instancia de pila que describe la pila especificada.**
```
Get-CFNStack -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFNStackEvent`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStackEvent`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devolución de todos los eventos relacionados con la pila especificada.**
```
Get-CFNStackEvent -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [DescribeStackEvents](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFNStackResource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStackResource`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve la descripción de un recurso identificado en la plantilla asociada a la pila especificada mediante el identificador lógico DBInstance «My».**
```
Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance"
```
+ Para obtener más información sobre la API, consulte [DescribeStackResource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CFNStackResourceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStackResourceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve las descripciones AWS de los recursos de un máximo de 100 recursos asociados a la pila especificada. Para obtener detalles de todos los recursos asociados a una pila, utilice el comando Get- CFNStackResourceSummary, que también permite la paginación manual de los resultados.**
```
Get-CFNStackResourceList -StackName "myStack"
```
**Ejemplo 2: Devolución de la descripción de la instancia de Amazon EC2 identificada en la plantilla asociada a la pila especificada con la identificación lógica “Ec2Instance”.**
```
Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"
```
**Ejemplo 3: Devolución de la descripción de hasta 100 recursos asociados a la pila que contiene una instancia de Amazon EC2 identificada con la identificación de instancia “i-123456”. Para obtener detalles de todos los recursos asociados a una pila, usa el Get- CFNStackResourceSummary, que también permite la paginación manual de los resultados.**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456"
```
**Ejemplo 4: Devolución de la descripción de la instancia de Amazon EC2 identificada con la identificación lógica “Ec2Instance” en la plantilla de una pila. La pila se identifica con la identificación de un recurso físico que también contiene una instancia de Amazon EC2 con la identificación de instancia “i-123456”. También se puede utilizar un recurso físico distinto para identificar la pila según el contenido de la plantilla; por ejemplo, un bucket de Amazon S3.**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"
```
+ Para obtener más información sobre la API, consulte [DescribeStackResources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-CFNStackResourceSummary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStackResourceSummary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devolución de las descripciones de todos los recursos asociados a la pila especificada.**
```
Get-CFNStackResourceSummary -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [ListStackResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFNStackSummary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNStackSummary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devolución de información de resumen de todas las pilas.**
```
Get-CFNStackSummary
```
**Ejemplo 2: Devolución de información de resumen de todas las pilas que se crean actualmente.**
```
Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"
```
**Ejemplo 3: Devolución de información de resumen de todas las pilas que se crean o se actualizan actualmente.**
```
Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")
```
+ Para obtener más información sobre la API, consulte [ListStacks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFNTemplate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFNTemplate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devolución de la plantilla asociada a la pila especificada.**
```
Get-CFNTemplate -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [GetTemplate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Measure-CFNTemplateCost`
En el siguiente ejemplo de código, se muestra cómo utilizar `Measure-CFNTemplateCost`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve la URL de una calculadora mensual AWS simple con una cadena de consulta que describe los recursos necesarios para ejecutar la plantilla. La plantilla se obtiene de la URL de Amazon S3 especificada y del único parámetro de personalización aplicado. El parámetro también se puede especificar mediante «Clave» y «Valor» en lugar de «ParameterKey» y «ParameterValue».**
```
Measure-CFNTemplateCost -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Region us-west-1 `
-Parameter @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" }
```
**Ejemplo 2: devuelve la URL de una calculadora mensual AWS simple con una cadena de consulta que describe los recursos necesarios para ejecutar la plantilla. La plantilla se analiza a partir del contenido suministrado y de los parámetros de personalización aplicados (en este ejemplo se supone que el contenido de la plantilla habría declarado dos parámetros, 'KeyName' y 'InstanceType'). Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de «ParameterKey» y «ParameterValue».**
```
Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" },`
@{ ParameterKey="InstanceType"; ParameterValue="m1.large" })
```
**Ejemplo 3: Utiliza New-Object para crear el conjunto de parámetros de la plantilla y devuelve la URL de una calculadora mensual AWS simple con una cadena de consulta que describe los recursos necesarios para ejecutar la plantilla. La plantilla se analiza a partir del contenido suministrado, con parámetros de personalización (en este ejemplo se supone que el contenido de la plantilla habría declarado dos parámetros, '' y KeyName ''). InstanceType**
```
$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "KeyName"
$p1.ParameterValue = "myKeyPairName"
$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "InstanceType"
$p2.ParameterValue = "m1.large"
Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" -Parameter @( $p1, $p2 )
```
+ Para obtener más información sobre la API, consulte [EstimateTemplateCost Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CFNStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Creación de una pila nueva con el nombre especificado. La plantilla se analiza a partir del contenido suministrado con parámetros de personalización ('' y PK1 'PK2' representan los nombres de los parámetros declarados en el contenido de la plantilla, 'PV1' y PV2 'representan los valores de esos parámetros). Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de «ParameterKey» y «ParameterValue». Si la creación de la pila falla, no se revertirá.**
```
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
-DisableRollback $true
```
**Ejemplo 2: Creación de una pila nueva con el nombre especificado. La plantilla se analiza a partir del contenido suministrado con los parámetros de personalización ('PK1' y 'PK2' representan los nombres de los parámetros declarados en el contenido de la plantilla, PV1 '' y PV2 'representan los valores de esos parámetros). Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de «ParameterKey» y «ParameterValue». Si la creación de la pila falla, se revertirá.**
```
$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"
$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( $p1, $p2 ) `
-OnFailure "ROLLBACK"
```
**Ejemplo 3: Creación de una pila nueva con el nombre especificado. La plantilla se obtiene de la URL de Amazon S3 con los parámetros de personalización (PK1'' representa el nombre de un parámetro declarado en el contenido de la plantilla, PV1 '' representa el valor del parámetro). Los parámetros de personalización también se pueden especificar mediante «clave» y «valor» en lugar de «ParameterKey» y «ParameterValue». Si la creación de la pila falla, se revertirá (igual que si se especificara: DisableRollback \$1false).**
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Ejemplo 4: Creación de una pila nueva con el nombre especificado. La plantilla se obtiene de la URL de Amazon S3 con los parámetros de personalización (PK1'' representa el nombre de un parámetro declarado en el contenido de la plantilla, PV1 '' representa el valor del parámetro). Los parámetros de personalización también se pueden especificar mediante «clave» y «valor» en lugar de «ParameterKey» y «ParameterValue». Si la creación de la pila falla, se revertirá (igual que si se especificara: DisableRollback \$1false). La notificación especificada AENs recibirá los eventos publicados relacionados con la pila.**
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
-NotificationARN @( "arn1", "arn2" )
```
+ Para obtener más información sobre la API, consulte [CreateStack Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Remove-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CFNStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Eliminación de la pila especificada.**
```
Remove-CFNStack -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Resume-CFNUpdateRollback`
En el siguiente ejemplo de código, se muestra cómo utilizar `Resume-CFNUpdateRollback`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Reanudación de la reversión de la pila seleccionada, la cual debería encontrarse en el estado “UPDATE\$1ROLLBACK\$1FAILED”. Si la reversión continua es exitosa, el estado de la pila será “UPDATE\$1ROLLBACK\$1COMPLETE”.**
```
Resume-CFNUpdateRollback -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [ContinueUpdateRollback](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-CFNUpdateStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-CFNUpdateStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Cancelación de una actualización en la pila especificada.**
```
Stop-CFNUpdateStack -StackName "myStack"
```
+ Para obtener más información sobre la API, consulte [CancelUpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Test-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Test-CFNStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Comprueba si la pila ha alcanzado uno de los estados UPDATE\$1ROLLBACK\$1COMPLETE, CREATE\$1COMPLETE, ROLLBACK\$1COMPLETE o UPDATE\$1COMPLETE.**
```
Test-CFNStack -StackName MyStack
```
**Salida:**
```
False
```
**Ejemplo 2: Comprueba si la pila ha alcanzado el estado UPDATE\$1COMPLETE o UPDATE\$1ROLLBACK\$1COMPLETE.**
```
Test-CFNStack -StackName MyStack -Status UPDATE_COMPLETE,UPDATE_ROLLBACK_COMPLETE
```
**Salida:**
```
True
```
+ Para obtener más información sobre la API, consulte [Test- CFNStack](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Test-CFNTemplate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Test-CFNTemplate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Validación del contenido de la plantilla especificada. El resultado detalla las capacidades, la descripción y los parámetros de la plantilla.**
```
Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"
```
**Ejemplo 2: Validación de la plantilla especificada a la que se ha accedido con una URL de Amazon S3. El resultado detalla las capacidades, la descripción y los parámetros de la plantilla.**
```
Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template
```
+ Para obtener más información sobre la API, consulte [ValidateTemplate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CFNStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: actualiza la pila 'myStack' con la plantilla y los parámetros de personalización especificados. 'PK1' representa el nombre de un parámetro declarado en la plantilla y 'PV1' representa su valor. Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de ParameterKey «» y «ParameterValue».**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Ejemplo 2: actualiza la pila «myStack» con la plantilla y los parámetros de personalización especificados. 'PK1' y 'PK2' representan los nombres de los parámetros declarados en la plantilla, 'PV1' y 'PV2' representan los valores solicitados. Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de ParameterKey «» y «ParameterValue».**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )
```
**Ejemplo 3: actualiza la pila «myStack» con la plantilla y los parámetros de personalización especificados. 'PK1' representa el nombre de un parámetro declarado en la plantilla y 'PV2' representa su valor. Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de ParameterKey «» y «ParameterValue».**
```
Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Ejemplo 4: actualiza la pila 'myStack' con la plantilla especificada, obtenida de Amazon S3, y los parámetros de personalización. 'PK1' y 'PK2' representan los nombres de los parámetros declarados en la plantilla, 'PV1' y 'PV2' representan los valores solicitados. Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de ParameterKey «» y «ParameterValue».**
```
Update-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )
```
**Ejemplo 5: actualiza la pila «MyStack», que en este ejemplo se supone que contiene recursos de IAM, con la plantilla especificada, obtenida de Amazon S3, y los parámetros de personalización. 'PK1' y 'PK2' representan los nombres de los parámetros declarados en la plantilla, 'PV1' y 'PV2' representan los valores solicitados. Los parámetros de personalización también se pueden especificar mediante «Clave» y «Valor» en lugar de ParameterKey «» y «ParameterValue». Las pilas que contienen recursos de IAM requieren que especifiques el parámetro «CAPABILITY\$1IAM» de -Capabilities; de lo contrario, la actualización fallará y aparecerá un error de «». InsufficientCapabilities**
```
Update-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) `
-Capabilities "CAPABILITY_IAM"
```
+ *Para obtener más información sobre la API, consulte la referencia de cmdlets ([UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)V5).Herramientas de AWS para PowerShell *
### `Wait-CFNStack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Wait-CFNStack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Comprueba si la pila ha alcanzado uno de los estados UPDATE\$1ROLLBACK\$1COMPLETE, CREATE\$1COMPLETE, ROLLBACK\$1COMPLETE o UPDATE\$1COMPLETE. Si la pila no tiene ninguno de los estados, el comando permanece inactivo durante dos segundos antes de volver a comprobar el estado. Esto se repite hasta que la pila alcance uno de los estados solicitados o hasta que transcurra el tiempo de espera predeterminado de 60 segundos. Si se supera el tiempo de espera, se generará una excepción. Si la pila alcanza uno de los estados solicitados dentro del período de tiempo de espera, se devuelve a la canalización.**
```
$stack = Wait-CFNStack -StackName MyStack
```
**Ejemplo 2: Este ejemplo espera un total de 5 minutos (300 segundos) para que la pila alcance cualquiera de los estados especificados. En este ejemplo, el estado se alcanza antes del tiempo de espera y, por lo tanto, el objeto de pila se devuelve a la canalización.**
```
Wait-CFNStack -StackName MyStack -Timeout 300 -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**Salida:**
```
Capabilities : {CAPABILITY_IAM}
ChangeSetId :
CreationTime : 6/1/2017 9:29:33 AM
Description : AWS CloudFormation Sample Template ec2_instance_with_instance_profile: Create an EC2 instance with an associated instance profile. **WARNING** This template creates one or more Amazon EC2
instances and an Amazon SQS queue. You will be billed for the AWS resources used if you create a stack from this template.
DisableRollback : False
LastUpdatedTime : 1/1/0001 12:00:00 AM
NotificationARNs : {}
Outputs : {}
Parameters : {}
RoleARN :
StackId : arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/7ea87b50-46e7-11e7-9c9b-503a90a9c4d1
StackName : MyStack
StackStatus : CREATE_COMPLETE
StackStatusReason :
Tags : {}
TimeoutInMinutes : 0
```
**Ejemplo 3: Este ejemplo muestra el error generado cuando una pila no alcanza uno de los estados solicitados dentro del período de tiempo de espera (en este caso, el período predeterminado de 60 segundos).**
```
Wait-CFNStack -StackName MyStack -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**Salida:**
```
Wait-CFNStack : Timed out after 60 seconds waiting for CloudFormation stack MyStack in region us-west-2 to reach one of state(s): UPDATE_ROLLBACK_COMPLETE,CREATE_COMPLETE,ROLLBACK_COMPLETE,UPDATE_COMPLETE
At line:1 char:1
+ Wait-CFNStack -StackName MyStack -State CREATE_COMPLETE,ROLLBACK_COMPLETE
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (Amazon.PowerShe...tCFNStackCmdlet:WaitCFNStackCmdlet) [Wait-CFNStack], InvalidOperationException
+ FullyQualifiedErrorId : InvalidOperationException,Amazon.PowerShell.Cmdlets.CFN.WaitCFNStackCmdlet
```
+ Para obtener información sobre la API, consulte la *referencia del Herramientas de AWS para PowerShell cmdlet [Wait- CFNStack](https://docs.aws.amazon.com/powershell/v5/reference) in (*V5).
# CloudFront ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CloudFront
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-CFCloudFrontOriginAccessIdentity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFCloudFrontOriginAccessIdentity`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este ejemplo devuelve una identidad de acceso a Amazon CloudFront Origin específica, especificada mediante el parámetro -Id. Aunque el parámetro -Id no es obligatorio, si no lo especifica, no se devolverá ningún resultado.**
```
Get-CFCloudFrontOriginAccessIdentity -Id E3XXXXXXXXXXRT
```
**Salida:**
```
CloudFrontOriginAccessIdentityConfig Id S3CanonicalUserId
------------------------------------ -- -----------------
Amazon.CloudFront.Model.CloudFrontOr... E3XXXXXXXXXXRT 4b6e...
```
+ Para obtener más información sobre la API, consulte [GetCloudFrontOriginAccessIdentity Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-CFCloudFrontOriginAccessIdentityConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFCloudFrontOriginAccessIdentityConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve información de configuración sobre una única identidad de acceso a Amazon CloudFront Origin, especificada mediante el parámetro -Id. Se producen errores si no se especifica ningún parámetro -Id.**
```
Get-CFCloudFrontOriginAccessIdentityConfig -Id E3XXXXXXXXXXRT
```
**Salida:**
```
CallerReference Comment
--------------- -------
mycallerreference: 2/1/2011 1:16:32 PM Caller reference: 2/1/2011 1:16:32 PM
```
+ Para obtener más información sobre la API, consulte [GetCloudFrontOriginAccessIdentityConfig Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-CFCloudFrontOriginAccessIdentityList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFCloudFrontOriginAccessIdentityList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve una lista de identidades de acceso a Amazon CloudFront Origin. Como el MaxItem parámetro - especifica un valor de 2, los resultados incluyen dos identidades.**
```
Get-CFCloudFrontOriginAccessIdentityList -MaxItem 2
```
**Salida:**
```
IsTruncated : True
Items : {E326XXXXXXXXXT, E1YWXXXXXXX9B}
Marker :
MaxItems : 2
NextMarker : E1YXXXXXXXXX9B
Quantity : 2
```
+ Para obtener más información sobre la API, consulte [ListCloudFrontOriginAccessIdentities Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CFDistribution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFDistribution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recupera la información de una distribución específica.**
```
Get-CFDistribution -Id EXAMPLE0000ID
```
+ Para obtener más información sobre la API, consulte [GetDistribution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFDistributionConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFDistributionConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recupera la configuración de una distribución específica.**
```
Get-CFDistributionConfig -Id EXAMPLE0000ID
```
+ Para obtener más información sobre la API, consulte [GetDistributionConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFDistributionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFDistributionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve distribuciones.**
```
Get-CFDistributionList
```
+ Para obtener más información sobre la API, consulte [ListDistributions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CFDistribution`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CFDistribution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea una CloudFront distribución básica, configurada con registro y almacenamiento en caché.**
```
$origin = New-Object Amazon.CloudFront.Model.Origin
$origin.DomainName = "amzn-s3-demo-bucket.s3.amazonaws.com"
$origin.Id = "UniqueOrigin1"
$origin.S3OriginConfig = New-Object Amazon.CloudFront.Model.S3OriginConfig
$origin.S3OriginConfig.OriginAccessIdentity = ""
New-CFDistribution `
-DistributionConfig_Enabled $true `
-DistributionConfig_Comment "Test distribution" `
-Origins_Item $origin `
-Origins_Quantity 1 `
-Logging_Enabled $true `
-Logging_IncludeCookie $true `
-Logging_Bucket amzn-s3-demo-logging-bucket.s3.amazonaws.com `
-Logging_Prefix "help/" `
-DistributionConfig_CallerReference Client1 `
-DistributionConfig_DefaultRootObject index.html `
-DefaultCacheBehavior_TargetOriginId $origin.Id `
-ForwardedValues_QueryString $true `
-Cookies_Forward all `
-WhitelistedNames_Quantity 0 `
-TrustedSigners_Enabled $false `
-TrustedSigners_Quantity 0 `
-DefaultCacheBehavior_ViewerProtocolPolicy allow-all `
-DefaultCacheBehavior_MinTTL 1000 `
-DistributionConfig_PriceClass "PriceClass_All" `
-CacheBehaviors_Quantity 0 `
-Aliases_Quantity 0
```
+ Para obtener más información sobre la API, consulte [CreateDistribution Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-CFInvalidation`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CFInvalidation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva invalidación en una distribución con un ID de EXAMPLENSTXAXE. CallerReference Es un identificador único elegido por el usuario; en este caso, se utiliza una marca de tiempo que representa el 15 de mayo de 2019 a las 9:00 a. m. La variable \$1Paths almacena tres rutas a archivos multimedia y de imagen que el usuario no desea que formen parte de la memoria caché de la distribución. El valor del parámetro -Paths\$1Quantity es el número total de rutas especificadas en el parámetro -Paths\$1Item.**
```
$Paths = "/images/*.gif", "/images/image1.jpg", "/videos/*.mp4"
New-CFInvalidation -DistributionId "EXAMPLENSTXAXE" -InvalidationBatch_CallerReference 20190515090000 -Paths_Item $Paths -Paths_Quantity 3
```
**Salida:**
```
Invalidation Location
------------ --------
Amazon.CloudFront.Model.Invalidation https://cloudfront.amazonaws.com/2018-11-05/distribution/EXAMPLENSTXAXE/invalidation/EXAMPLE8NOK9H
```
+ Para obtener más información sobre la API, consulte [CreateInvalidation Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-CFSignedCookie`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CFSignedCookie`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea una cookie firmada en el recurso especificado mediante una política predefinida. La cookie tendrá una validez de un año.**
```
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/image1.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddYears(1)
}
New-CFSignedCookie @params
```
**Salida:**
```
Expires
-------
[CloudFront-Expires, 1472227284]
```
**Ejemplo 2: Crea una cookie firmada en los recursos especificados mediante una política personalizada. La cookie será válida a partir de 24 horas y caducará una semana después.**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/content/*.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=$start.AddDays(7)
"ActiveFrom"=$start
}
New-CFSignedCookie @params
```
**Salida:**
```
Policy
------
[CloudFront-Policy, eyJTd...wIjo...
```
**Ejemplo 3: Crea una cookie firmada en los recursos especificados mediante una política personalizada. La cookie será válida a partir de 24 horas y caducará una semana después. El acceso a los recursos está restringido al intervalo de IP especificado.**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/content/*.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=$start.AddDays(7)
"ActiveFrom"=$start
"IpRange"="192.0.2.0/24"
}
New-CFSignedCookie @params
```
**Salida:**
```
Policy ------ [CloudFront-Policy, eyJTd...wIjo...
```
+ Para obtener más información sobre la API, consulte [New- CFSigned Cookie](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `New-CFSignedUrl`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CFSignedUrl`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea una URL firmada en el recurso especificado mediante una política predefinida. La URL tendrá una validez de una hora. Se envía a la canalización un objeto System.Uri que contiene la URL firmada.**
```
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddHours(1)
}
New-CFSignedUrl @params
```
**Ejemplo 2: Crea una URL firmada en el recurso especificado mediante una política personalizada. La URL será válida a partir de 24 horas y caducará una semana después.**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddDays(7)
"ActiveFrom"=$start
}
New-CFSignedUrl @params
```
**Ejemplo 3: Crea una URL firmada en el recurso especificado mediante una política personalizada. La URL será válida a partir de 24 horas y caducará una semana después. El acceso al recurso está restringido al intervalo de IP especificado.**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddDays(7)
"ActiveFrom"=$start
"IpRange"="192.0.2.0/24"
}
New-CFSignedUrl @params
```
+ Para obtener más información sobre la API, consulte [New- CFSigned Url](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
# CloudTrail ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CloudTrail
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Find-CTEvent`
En el siguiente ejemplo de código, se muestra cómo utilizar `Find-CTEvent`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Devuelve todos los eventos que se produjeron en los últimos siete días. De forma predeterminada, el cmdlet realiza automáticamente varias llamadas para entregar todos los eventos y termina de ejecutarse cuando el servicio indica que no hay más datos disponibles.**
```
Find-CTEvent
```
**Ejemplo 2: Devuelve todos los eventos que se han producido en los últimos siete días y especifica una región que no es la predeterminada del intérprete de comandos actual.**
```
Find-CTEvent -Region eu-central-1
```
**Ejemplo 3: Devuelve todos los eventos asociados a la llamada a la RunInstances API.**
```
Find-CTEvent -LookupAttribute @{ AttributeKey="EventName"; AttributeValue="RunInstances" }
```
**Ejemplo 4: Devuelve los cinco primeros eventos disponibles.**
```
Find-CTEvent -MaxResult 5
```
+ Para obtener más información sobre la API, consulte [LookupEvents Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CTTrail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CTTrail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recupera la configuración de todos los registros de seguimiento asociados a la región actual de su cuenta.**
```
Get-CTTrail
```
**Ejemplo 2: Devuelve la configuración de todos los registros de seguimiento especificados.**
```
Get-CTTrail -TrailNameList trail1,trail2
```
**Ejemplo 3: Devuelve la configuración de todos los registros de seguimiento especificados que se crearon en una región distinta de la predeterminada del intérprete de comandos actual (en este caso, la región de Fráncfort (eu-central-1)).**
```
Get-CTTrail -TrailNameList trailABC,trailDEF -Region eu-central-1
```
+ Para obtener más información sobre la API, consulte [DescribeTrails](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CTTrailStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CTTrailStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la información de estado de la ruta con el nombre 'myExampleTrail'. Los datos devueltos incluyen información sobre los errores de entrega, los errores de Amazon SNS y Amazon S3 y las horas de inicio y finalización de registro del registro de seguimiento. En este ejemplo se presupone que el registro de seguimiento se creó en la misma región que el intérprete de comandos predeterminado actual.**
```
Get-CTTrailStatus -Name myExampleTrail
```
**Ejemplo 2: Devuelve la configuración de un registro de seguimiento que se creó en una región distinta de la predeterminada del intérprete de comandos actual (en este caso, la región de Fráncfort (eu-central-1)).**
```
Get-CTTrailStatus -Name myExampleTrail -Region eu-central-1
```
+ Para obtener más información sobre la API, consulte [GetTrailStatus Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-CTTrail`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CTTrail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un registro de seguimiento que utilizará el bucket “amzn-s3-demo-bucket” para almacenar los archivos de registro.**
```
New-CTTrail -Name "awscloudtrail-example" -S3BucketName "amzn-s3-demo-bucket"
```
**Ejemplo 2: Crea un registro de seguimiento que utilizará el bucket “amzn-s3-demo-bucket” para almacenar los archivos de registro. Los objetos de S3 que representan los registros tendrán el prefijo de clave común “mylogs”. Cuando se envíen nuevos registros al bucket, se enviará una notificación al tema de SNS “mlog-deliverytopic”. En este ejemplo, se utiliza el método splatting para proporcionar los valores de los parámetros al cmdlet.**
```
$params = @{
Name="awscloudtrail-example"
S3BucketName="amzn-s3-demo-bucket"
S3KeyPrefix="mylogs"
SnsTopicName="mlog-deliverytopic"
}
New-CTTrail @params
```
+ Para obtener más información sobre la API, consulte [CreateTrail](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CTTrail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CTTrail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina el registro de seguimiento especificado. Se le pedirá confirmación antes de que se ejecute el comando. Para suprimir la confirmación, añada el parámetro modificador -Force.**
```
Remove-CTTrail -Name "awscloudtrail-example"
```
+ Para obtener más información sobre la API, consulte [DeleteTrail](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-CTLogging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-CTLogging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Inicia el registro de las llamadas a la AWS API y la entrega del archivo de registro para la ruta denominada 'myExampleTrail'. En este ejemplo se presupone que el registro de seguimiento se creó en la misma región que el intérprete de comandos predeterminado actual.**
```
Start-CTLogging -Name myExampleTrail
```
**Ejemplo 2: Inicia el registro de las llamadas a la AWS API y la entrega de archivos de registro para una ruta que se creó en una región distinta de la predeterminada del shell actual (en este caso, la región de Fráncfort (eu-central-1)).**
```
Start-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [StartLogging](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Stop-CTLogging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-CTLogging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: suspende la grabación de las llamadas a la AWS API y la entrega de archivos de registro para la ruta denominada ''. myExampleTrail En este ejemplo se presupone que el registro de seguimiento se creó en la misma región que el intérprete de comandos predeterminado actual.**
```
Stop-CTLogging -Name myExampleTrail
```
**Ejemplo 2: suspende la grabación de las llamadas a la AWS API y la entrega de archivos de registro para una ruta que se creó en una región distinta de la predeterminada del shell actual (en este caso, la región de Fráncfort (eu-central-1)).**
```
Stop-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [StopLogging](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Update-CTTrail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CTTrail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Actualiza el registro de seguimiento especificado para que se registren los eventos de servicio globales (como los de IAM) y cambia el prefijo de clave común de los archivos de registro para que en el futuro sea “globallogs”.**
```
Update-CTTrail -Name "awscloudtrail-example" -IncludeGlobalServiceEvents $true -S3KeyPrefix "globallogs"
```
**Ejemplo 2: Actualiza el registro de seguimiento especificado para que las notificaciones sobre las nuevas entregas de registros se envíen al tema de SNS especificado.**
```
Update-CTTrail -Name "awscloudtrail-example" -SnsTopicName "mlog-deliverytopic2"
```
**Ejemplo 3: Actualiza el registro de seguimiento especificado para que los registros se entreguen a un bucket diferente.**
```
Update-CTTrail -Name "awscloudtrail-example" -S3BucketName "otherlogs"
```
+ Para obtener más información sobre la API, consulte [UpdateTrail](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# CloudWatch ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CloudWatch
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-CWDashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CWDashboard`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: devuelve el arn al cuerpo del panel especificado.**
```
Get-CWDashboard -DashboardName Dashboard1
```
**Salida:**
```
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
```
+ Para obtener más información sobre la API, consulte [GetDashboard](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CWDashboardList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CWDashboardList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve el conjunto de paneles de su cuenta.**
```
Get-CWDashboardList
```
**Salida:**
```
DashboardArn DashboardName LastModified Size
------------ ------------- ------------ ----
arn:... Dashboard1 7/6/2017 8:14:15 PM 252
```
**Ejemplo 2: devuelve el conjunto de paneles de su cuenta cuyos nombres comienzan con el prefijo “dev”.**
```
Get-CWDashboardList -DashboardNamePrefix dev
```
+ Para obtener más información sobre la API, consulte [ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CWDashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CWDashboard`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina el panel especificado y lo confirma antes de continuar. Para omitir la confirmación, agregue el modificador -Force al comando.**
```
Remove-CWDashboard -DashboardName Dashboard1
```
+ Para obtener más información sobre la API, consulte [DeleteDashboards](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-CWDashboard`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-CWDashboard`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea o actualiza el panel denominado “Dashboard1” para incluir dos widgets de métricas uno al lado del otro.**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**Ejemplo 2: crea o actualiza el panel y canaliza el contenido que describe el panel al cmdlet.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ Para obtener más información sobre la API, consulte [PutDashboard](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-CWMetricData`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-CWMetricData`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un MetricDatum objeto nuevo y lo escribe en Amazon Web Services CloudWatch Metrics.**
```
### Create a MetricDatum .NET object
$Metric = New-Object -TypeName Amazon.CloudWatch.Model.MetricDatum
$Metric.Timestamp = [DateTime]::UtcNow
$Metric.MetricName = 'CPU'
$Metric.Value = 50
### Write the metric data to the CloudWatch service
Write-CWMetricData -Namespace instance1 -MetricData $Metric
```
+ Para obtener más información sobre la API, consulte [PutMetricData Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
# CodeCommit ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CodeCommit
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-CCBranch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CCBranch`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se obtiene información sobre la rama especificada del repositorio especificado.**
```
Get-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch
```
**Salida:**
```
BranchName CommitId
---------- --------
MyNewBranch 7763222d...561fc9c9
```
+ Para obtener más información sobre la API, consulte [GetBranch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CCBranchList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CCBranchList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de nombre de ramas del repositorio especificado.**
```
Get-CCBranchList -RepositoryName MyDemoRepo
```
**Salida:**
```
master
MyNewBranch
```
+ Para obtener más información sobre la API, consulte [ListBranches](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CCRepository`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CCRepository`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre el repositorio especificado.**
```
Get-CCRepository -RepositoryName MyDemoRepo
```
**Salida:**
```
AccountId : 80398EXAMPLE
Arn : arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
CloneUrlHttp : https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CloneUrlSsh : ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CreationDate : 9/8/2015 3:21:33 PM
DefaultBranch :
LastModifiedDate : 9/8/2015 3:21:33 PM
RepositoryDescription : This is a repository for demonstration purposes.
RepositoryId : c7d0d2b0-ce40-4303-b4c3-38529EXAMPLE
RepositoryName : MyDemoRepo
```
+ Para obtener más información sobre la API, consulte [GetRepository](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CCRepositoryBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CCRepositoryBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo confirma cuáles de los repositorios especificados se encuentran y cuáles no.**
```
Get-CCRepositoryBatch -RepositoryName MyDemoRepo, MyNewRepo, AMissingRepo
```
**Salida:**
```
Repositories RepositoriesNotFound
------------ --------------------
{MyDemoRepo, MyNewRepo} {AMissingRepo}
```
+ Para obtener más información sobre la API, consulte [BatchGetRepositories](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CCRepositoryList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CCRepositoryList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran todos los repositorios en orden ascendente por nombre de repositorio.**
```
Get-CCRepositoryList -Order Ascending -SortBy RepositoryName
```
**Salida:**
```
RepositoryId RepositoryName
------------ --------------
c7d0d2b0-ce40-4303-b4c3-38529EXAMPLE MyDemoRepo
05f30c66-e3e3-4f91-a0cd-1c84aEXAMPLE MyNewRepo
```
+ Para obtener más información sobre la API, consulte [ListRepositories](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CCBranch`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CCBranch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una rama nueva con el nombre especificado para el repositorio especificado y el ID de confirmación especificado.**
```
New-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch -CommitId 7763222d...561fc9c9
```
+ Para obtener más información sobre la API, consulte [CreateBranch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CCRepository`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CCRepository`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un repositorio nuevo con el nombre y la descripción especificados.**
```
New-CCRepository -RepositoryName MyDemoRepo -RepositoryDescription "This is a repository for demonstration purposes."
```
**Salida:**
```
AccountId : 80398EXAMPLE
Arn : arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
CloneUrlHttp : https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CloneUrlSsh : ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CreationDate : 9/18/2015 4:13:25 PM
DefaultBranch :
LastModifiedDate : 9/18/2015 4:13:25 PM
RepositoryDescription : This is a repository for demonstration purposes.
RepositoryId : 43ef2443-3372-4b12-9e78-65c27EXAMPLE
RepositoryName : MyDemoRepo
```
+ Para obtener más información sobre la API, consulte [CreateRepository](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CCRepository`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CCRepository`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina a la fuerza el repositorio especificado. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar el repositorio sin una petición.**
```
Remove-CCRepository -RepositoryName MyDemoRepo
```
**Salida:**
```
43ef2443-3372-4b12-9e78-65c27EXAMPLE
```
+ Para obtener más información sobre la API, consulte [DeleteRepository](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CCDefaultBranch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CCDefaultBranch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia la rama predeterminada del repositorio especificado por la rama especificada.**
```
Update-CCDefaultBranch -RepositoryName MyDemoRepo -DefaultBranchName MyNewBranch
```
+ Para obtener más información sobre la API, consulte [UpdateDefaultBranch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CCRepositoryDescription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CCRepositoryDescription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia la descripción del repositorio especificado.**
```
Update-CCRepositoryDescription -RepositoryName MyDemoRepo -RepositoryDescription "This is an updated description."
```
+ Para obtener más información sobre la API, consulte [UpdateRepositoryDescription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CCRepositoryName`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CCRepositoryName`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el nombre del repositorio especificado.**
```
Update-CCRepositoryName -NewName MyDemoRepo2 -OldName MyDemoRepo
```
+ Para obtener más información sobre la API, consulte [UpdateRepositoryName](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# CodeDeploy ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CodeDeploy
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-CDOnPremiseInstanceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-CDOnPremiseInstanceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se añade una etiqueta de instancia local con la clave y el valor especificados para la instancia local especificada.**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ Para obtener más información sobre la API, consulte [AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDApplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDApplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre la aplicación especificada.**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**Salida:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ Para obtener más información sobre la API, consulte [GetApplication](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDApplicationBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDApplicationBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre las aplicaciones especificadas.**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**Salida:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
1ecfd602-62f1-4038-8f0d-06688EXAMPLE CodePipelineDemoApplication 8/13/2015 5:53:26 PM False
```
+ Para obtener más información sobre la API, consulte [BatchGetApplications](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDApplicationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDApplicationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de las aplicaciones disponibles.**
```
Get-CDApplicationList
```
**Salida:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ Para obtener más información sobre la API, consulte [ListApplications](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDApplicationRevision`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDApplicationRevision`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre la revisión de la aplicación especificada.**
```
$revision = Get-CDApplicationRevision -ApplicationName CodeDeployDemoApplication -S3Location_Bucket amzn-s3-demo-bucket -Revision_RevisionType S3 -S3Location_Key 5xd27EX.zip -S3Location_BundleType zip -S3Location_ETag 4565c1ac97187f190c1a90265EXAMPLE
Write-Output ("Description = " + $revision.RevisionInfo.Description + ", RegisterTime = " + $revision.RevisionInfo.RegisterTime)
```
**Salida:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ Para obtener más información sobre la API, consulte [GetApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDApplicationRevisionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDApplicationRevisionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre las revisiones disponibles de la aplicación especificada.**
```
ForEach ($revision in (Get-CDApplicationRevisionList -ApplicationName CodeDeployDemoApplication -Deployed Ignore)) {
>> If ($revision.RevisionType -Eq "S3") {
>> Write-Output ("Type = S3, Bucket = " + $revision.S3Location.Bucket + ", BundleType = " + $revision.S3Location.BundleType + ", ETag = " + $revision.S3Location.ETag + ", Key = " + $revision.S3Location.Key)
>> }
>> If ($revision.RevisionType -Eq "GitHub") {
>> Write-Output ("Type = GitHub, CommitId = " + $revision.GitHubLocation.CommitId + ", Repository = " + $revision.GitHubLocation.Repository)
>> }
>> }
>>
```
**Salida:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ Para obtener más información sobre la API, consulte [ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeployment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeployment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre la implementación especificada.**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**Salida:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
**Ejemplo 2: En este ejemplo se obtiene información sobre el estado de las instancias que participan en la implementación especificada.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**Salida:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**Ejemplo 3: En este ejemplo se obtiene información sobre la revisión de la aplicación para la implementación especificada.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**Salida:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ Para obtener más información sobre la API, consulte [GetDeployment](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre las implementaciones especificadas.**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**Salida:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
ApplicationName : CodePipelineDemoApplication
CompleteTime : 7/23/2015 6:07:30 PM
CreateTime : 7/23/2015 6:06:29 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodePipelineDemoFleet
DeploymentId : d-RR0T5KTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
+ Para obtener más información sobre la API, consulte [BatchGetDeployments](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información resumida sobre la configuración de implementación.**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**Salida:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**Ejemplo 2: En este ejemplo se obtiene información sobre la definición de la configuración de implementación especificada.**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**Salida:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ Para obtener más información sobre la API, consulte [GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentConfigList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentConfigList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de las configuraciones de implementación disponibles.**
```
Get-CDDeploymentConfigList
```
**Salida:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ Para obtener más información sobre la API, consulte [ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre el grupo de implementación especificado.**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Salida:**
```
ApplicationName : CodeDeployDemoApplication
AutoScalingGroups : {}
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupId : 7d7c098a-b444-4b27-96ef-22791EXAMPLE
DeploymentGroupName : CodeDeployDemoFleet
Ec2TagFilters : {Name}
OnPremisesInstanceTagFilters : {}
ServiceRoleArn : arn:aws:iam::80398EXAMPLE:role/CodeDeploySampleStack-4ph6EX-CodeDeployTrustRole-O9MWP7XTL8EX
TargetRevision : Amazon.CodeDeploy.Model.RevisionLocation
```
+ Para obtener más información sobre la API, consulte [GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentGroupList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentGroupList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de grupos de implementación para la aplicación especificada.**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**Salida:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ Para obtener más información sobre la API, consulte [ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre la instancia especificada de la implementación especificada.**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**Salida:**
```
DeploymentId : d-QZMRGSTEX
InstanceId : arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-254e22EX
LastUpdatedAt : 7/23/2015 11:25:24 PM
LifecycleEvents : {ApplicationStop, DownloadBundle, BeforeInstall, Install...}
Status : Succeeded
```
+ Para obtener más información sobre la API, consulte [GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDDeploymentInstanceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentInstanceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtiene una lista de instancias IDs para la implementación especificada.**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**Salida:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ Para obtener más información sobre la API, consulte [ListDeploymentInstances Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CDDeploymentList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDDeploymentList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtiene una lista de despliegues IDs para la aplicación y el grupo de despliegues especificados.**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Salida:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ Para obtener más información sobre la API, consulte [ListDeployments Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CDOnPremiseInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDOnPremiseInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre la instancia local especificada.**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**Salida:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ Para obtener más información sobre la API, consulte [GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDOnPremiseInstanceBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDOnPremiseInstanceBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre las instancias locales especificadas.**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**Salida:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployFRWUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX-2_XmeSz18rEX
InstanceName : AssetTag12010298EX-2
RegisterTime : 4/3/2015 6:38:52 PM
Tags : {Name}
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ Para obtener más información sobre la API, consulte [BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CDOnPremiseInstanceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CDOnPremiseInstanceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de los nombres de instancias locales disponibles.**
```
Get-CDOnPremiseInstanceList
```
**Salida:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ Para obtener más información sobre la API, consulte [ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CDApplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CDApplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una cola con el nombre especificado.**
```
New-CDApplication -ApplicationName MyNewApplication
```
**Salida:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ Para obtener más información sobre la API, consulte [CreateApplication](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CDDeployment`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CDDeployment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva implementación para la aplicación y el grupo de implementación especificados con la configuración de implementación y la revisión de la aplicación especificadas.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3
```
**Salida:**
```
d-ZHROG7UEX
```
**Ejemplo 2: En este ejemplo se muestra cómo especificar grupos de etiquetas de instancias de EC2 con las que se debe identificar una instancia para poder incluirla en el entorno de reemplazo de una blue/green implementación.**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Salida:**
```
d-ZHROG7UEX
```
+ Para obtener más información sobre la API, consulte [CreateDeployment Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-CDDeploymentConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CDDeploymentConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva configuración de implementación con el nombre y el comportamiento especificados.**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**Salida:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ Para obtener más información sobre la API, consulte [CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CDDeploymentGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CDDeploymentGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un grupo de implementación con el nombre especificado, el grupo de escalado automático, la configuración de implementación, la etiqueta y el rol de servicio para la aplicación especificada.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo
```
**Salida:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**Ejemplo 2: En este ejemplo se muestra cómo especificar grupos de etiquetas de instancias de EC2 con las que se debe identificar una instancia para poder incluirla en el entorno de reemplazo de una blue/green implementación.**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**Salida:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ Para obtener más información sobre la API, consulte [CreateDeploymentGroup Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Register-CDApplicationRevision`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-CDApplicationRevision`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra una revisión de aplicación en la ubicación de Amazon S3 especificada para la aplicación especificada.**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ Para obtener más información sobre la API, consulte [RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-CDOnPremiseInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-CDOnPremiseInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra una instancia local con el nombre y el usuario de IAM especificados.**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ Para obtener más información sobre la API, consulte [RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CDApplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CDApplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la aplicación con el nombre especificado. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar la aplicación sin una petición.**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ Para obtener más información sobre la API, consulte [DeleteApplication](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CDDeploymentConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CDDeploymentConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la configuración de implementación con el nombre especificado. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar la configuración de implementación sin una petición.**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ Para obtener más información sobre la API, consulte [DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CDDeploymentGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CDDeploymentGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de implementación con el nombre especificado para la aplicación especificada. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar el grupo de implementación sin una petición.**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ Para obtener más información sobre la API, consulte [DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CDOnPremiseInstanceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CDOnPremiseInstanceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta especificada para la instancia local con el nombre especificado. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar la etiqueta sin una petición.**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ Para obtener más información sobre la API, consulte [RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-CDDeployment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-CDDeployment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se intenta detener la implementación con el ID de implementación especificado.**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**Salida:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ Para obtener más información sobre la API, consulte [StopDeployment](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-CDOnPremiseInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-CDOnPremiseInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se anula el registro de la instancia local con el nombre especificado.**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ Para obtener más información sobre la API, consulte [DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CDApplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CDApplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el nombre de la aplicación especificada.**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ Para obtener más información sobre la API, consulte [UpdateApplication](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CDDeploymentGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CDDeploymentGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el nombre del grupo de implementación especificado para la aplicación especificada.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**Ejemplo 2: En este ejemplo se muestra cómo especificar grupos de etiquetas de instancias de EC2 con las que se debe identificar una instancia para poder incluirla en el entorno de reemplazo de una blue/green implementación.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
+ Para obtener más información sobre la API, consulte [UpdateDeploymentGroup Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
# CodePipeline ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. CodePipeline
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Confirm-CPJob`
En el siguiente ejemplo de código, se muestra cómo utilizar `Confirm-CPJob`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se obtiene el estado de un comando específico.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Salida:**
```
Value
-----
InProgress
```
+ Para obtener más información sobre la API, consulte [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-CPStageTransition`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-CPStageTransition`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se deshabilita la transición de entrada para la etapa especificada en la canalización especificada.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ Para obtener más información sobre la API, consulte [DisableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-CPStageTransition`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-CPStageTransition`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la transición de entrada para la etapa especificada en la canalización especificada.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ Para obtener más información sobre la API, consulte [EnableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPActionType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPActionType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre las acciones disponibles para el propietario especificado.**
```
ForEach ($actionType in (Get-CPActionType -ActionOwnerFilter AWS)) {
Write-Output ("For Category = " + $actionType.Id.Category + ", Owner = " + $actionType.Id.Owner + ", Provider = " + $actionType.Id.Provider + ", Version = " + $actionType.Id.Version + ":")
Write-Output (" ActionConfigurationProperties:")
ForEach ($acp in $actionType.ActionConfigurationProperties) {
Write-Output (" For " + $acp.Name + ":")
Write-Output (" Description = " + $acp.Description)
Write-Output (" Key = " + $acp.Key)
Write-Output (" Queryable = " + $acp.Queryable)
Write-Output (" Required = " + $acp.Required)
Write-Output (" Secret = " + $acp.Secret)
}
Write-Output (" InputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.InputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.InputArtifactDetails.MinimumCount)
Write-Output (" OutputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.OutputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.OutputArtifactDetails.MinimumCount)
Write-Output (" Settings:")
Write-Output (" EntityUrlTemplate = " + $actionType.Settings.EntityUrlTemplate)
Write-Output (" ExecutionUrlTemplate = " + $actionType.Settings.ExecutionUrlTemplate)
}
```
**Salida:**
```
For Category = Deploy, Owner = AWS, Provider = ElasticBeanstalk, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS Elastic Beanstalk Application name
Key = True
Queryable = False
Required = True
Secret = False
For EnvironmentName:
Description = The AWS Elastic Beanstalk Environment name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
ExecutionUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
For Category = Deploy, Owner = AWS, Provider = CodeDeploy, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS CodeDeploy Application name
Key = True
Queryable = False
Required = True
Secret = False
For DeploymentGroupName:
Description = The AWS CodeDeploy Deployment Group name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}
ExecutionUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/deployments/{ExternalExecutionId}
```
+ Para obtener más información sobre la API, consulte [ListActionTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPActionableJobList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPActionableJobList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información sobre todos los trabajos procesables para la categoría de acción, el propietario, el proveedor, la versión y los parámetros de consulta especificados.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Salida:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ Para obtener más información sobre la API, consulte [PollForJobs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPJobDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPJobDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información general sobre el trabajo especificado.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Salida:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Ejemplo 2: En este ejemplo se obtiene información detallada sobre el trabajo especificado.**
```
$jobDetails = Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
Write-Output ("For Job " + $jobDetails.Id + ":")
Write-Output (" AccountId = " + $jobDetails.AccountId)
$jobData = $jobDetails.Data
Write-Output (" Configuration:")
ForEach ($key in $jobData.ActionConfiguration.Keys) {
$value = $jobData.ActionConfiguration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" ActionTypeId:")
Write-Output (" Category = " + $jobData.ActionTypeId.Category)
Write-Output (" Owner = " + $jobData.ActionTypeId.Owner)
Write-Output (" Provider = " + $jobData.ActionTypeId.Provider)
Write-Output (" Version = " + $jobData.ActionTypeId.Version)
Write-Output (" ArtifactCredentials:")
Write-Output (" AccessKeyId = " + $jobData.ArtifactCredentials.AccessKeyId)
Write-Output (" SecretAccessKey = " + $jobData.ArtifactCredentials.SecretAccessKey)
Write-Output (" SessionToken = " + $jobData.ArtifactCredentials.SessionToken)
Write-Output (" InputArtifacts:")
ForEach ($ia in $jobData.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
Write-Output (" OutputArtifacts:")
ForEach ($oa in $jobData.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" PipelineContext:")
$context = $jobData.PipelineContext
Write-Output (" Name = " + $context.Action.Name)
Write-Output (" PipelineName = " + $context.PipelineName)
Write-Output (" Stage = " + $context.Stage.Name)
```
**Salida:**
```
For Job f570dc12-5ef3-44bc-945a-6e133EXAMPLE:
AccountId = 80398EXAMPLE
Configuration:
ActionTypeId:
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
ArtifactCredentials:
AccessKeyId = ASIAIEI3...IXI6YREX
SecretAccessKey = cqAFDhEi...RdQyfa2u
SessionToken = AQoDYXdz...5u+lsAU=
InputArtifacts:
MyApp
OutputArtifacts:
MyAppBuild
PipelineContext:
Name = Build
PipelineName = CodePipelineDemo
Stage = Build
```
+ Para obtener más información sobre la API, consulte [GetJobDetails](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPPipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPPipeline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información general sobre la canalización especificada.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Salida:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Ejemplo 2: En este ejemplo se obtiene información detallada sobre la canalización especificada.**
```
$pipeline = Get-CPPipeline -Name CodePipelineDemo
Write-Output ("Name = " + $pipeline.Name)
Write-Output ("RoleArn = " + $pipeline.RoleArn)
Write-Output ("Version = " + $pipeline.Version)
Write-Output ("ArtifactStore:")
Write-Output (" Location = " + $pipeline.ArtifactStore.Location)
Write-Output (" Type = " + $pipeline.ArtifactStore.Type.Value)
Write-Output ("Stages:")
ForEach ($stage in $pipeline.Stages) {
Write-Output (" Name = " + $stage.Name)
Write-Output (" Actions:")
ForEach ($action in $stage.Actions) {
Write-Output (" Name = " + $action.Name)
Write-Output (" Category = " + $action.ActionTypeId.Category)
Write-Output (" Owner = " + $action.ActionTypeId.Owner)
Write-Output (" Provider = " + $action.ActionTypeId.Provider)
Write-Output (" Version = " + $action.ActionTypeId.Version)
Write-Output (" Configuration:")
ForEach ($key in $action.Configuration.Keys) {
$value = $action.Configuration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" InputArtifacts:")
ForEach ($ia in $action.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
ForEach ($oa in $action.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" RunOrder = " + $action.RunOrder)
}
}
```
**Salida:**
```
Name = CodePipelineDemo
RoleArn = arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Version = 3
ArtifactStore:
Location = amzn-s3-demo-bucket
Type = S3
Stages:
Name = Source
Actions:
Name = Source
Category = Source
Owner = ThirdParty
Provider = GitHub
Version = 1
Configuration:
Branch = master
OAuthToken = ****
Owner = my-user-name
Repo = MyRepoName
InputArtifacts:
MyApp
RunOrder = 1
Name = Build
Actions:
Name = Build
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
Configuration:
ProjectName = MyProjectName
InputArtifacts:
MyApp
MyAppBuild
RunOrder = 1
Name = Beta
Actions:
Name = CodePipelineDemoFleet
Category = Deploy
Owner = AWS
Provider = CodeDeploy
Version = 1
Configuration:
ApplicationName = CodePipelineDemoApplication
DeploymentGroupName = CodePipelineDemoFleet
InputArtifacts:
MyAppBuild
RunOrder = 1
Name = TestStage
Actions:
Name = MyJenkinsTestAction
Category = Test
Owner = Custom
Provider = MyCustomTestProvider
Version = 1
Configuration:
ProjectName = MyJenkinsProjectName
InputArtifacts:
MyAppBuild
RunOrder = 1
```
+ Para obtener más información sobre la API, consulte [GetPipeline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPPipelineList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPPipelineList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una lista de las canalizaciones disponibles.**
```
Get-CPPipelineList
```
**Salida:**
```
Created Name Updated Version
------- ---- ------- -------
8/13/2015 10:17:54 PM CodePipelineDemo 8/13/2015 10:17:54 PM 3
7/8/2015 2:41:53 AM MyFirstPipeline 7/22/2015 9:06:37 PM 7
```
+ Para obtener más información sobre la API, consulte [ListPipelines](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CPPipelineState`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CPPipelineState`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene información general sobre las etapas de la canalización especificada.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Salida:**
```
Created : 8/13/2015 10:17:54 PM
PipelineName : CodePipelineDemo
PipelineVersion : 1
StageStates : {Source, Build, Beta, TestStage}
Updated : 8/13/2015 10:17:54 PM
```
**Ejemplo 2: En este ejemplo se obtiene información detallada sobre las etapas de la canalización especificada.**
```
ForEach ($stageState in (Get-CPPipelineState -Name $arg).StageStates) {
Write-Output ("For " + $stageState.StageName + ":")
Write-Output (" InboundTransitionState:")
Write-Output (" DisabledReason = " + $stageState.InboundTransitionState.DisabledReason)
Write-Output (" Enabled = " + $stageState.InboundTransitionState.Enabled)
Write-Output (" LastChangedAt = " + $stageState.InboundTransitionState.LastChangedAt)
Write-Output (" LastChangedBy = " + $stageState.InboundTransitionState.LastChangedBy)
Write-Output (" ActionStates:")
ForEach ($actionState in $stageState.ActionStates) {
Write-Output (" For " + $actionState.ActionName + ":")
Write-Output (" CurrentRevision:")
Write-Output (" Created = " + $actionState.CurrentRevision.Created)
Write-Output (" RevisionChangeId = " + $actionState.CurrentRevision.RevisionChangeId)
Write-Output (" RevisionId = " + $actionState.CurrentRevision.RevisionId)
Write-Output (" EntityUrl = " + $actionState.EntityUrl)
Write-Output (" LatestExecution:")
Write-Output (" ErrorDetails:")
Write-Output (" Code = " + $actionState.LatestExecution.ErrorDetails.Code)
Write-Output (" Message = " + $actionState.LatestExecution.ErrorDetails.Message)
Write-Output (" ExternalExecutionId = " + $actionState.LatestExecution.ExternalExecutionId)
Write-Output (" ExternalExecutionUrl = " + $actionState.LatestExecution.ExternalExecutionUrl)
Write-Output (" LastStatusChange = " + $actionState.LatestExecution.LastStatusChange)
Write-Output (" PercentComplete = " + $actionState.LatestExecution.PercentComplete)
Write-Output (" Status = " + $actionState.LatestExecution.Status)
Write-Output (" Summary = " + $actionState.LatestExecution.Summary)
Write-Output (" RevisionUrl = " + $actionState.RevisionUrl)
}
}
```
**Salida:**
```
For Source:
InboundTransitionState:
DisabledReason =
Enabled =
LastChangedAt =
LastChangedBy =
ActionStates:
For Source:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://github.com/my-user-name/MyRepoName/tree/master
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/20/2015 23:28:45
PercentComplete = 0
Status = Succeeded
Summary =
RevisionUrl =
For Build:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For Build:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code = TimeoutError
Message = The action failed because a job worker exceeded its time limit. If this is a custom action, make sure that the job worker is configured correctly.
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/21/2015 00:29:29
PercentComplete = 0
Status = Failed
Summary =
RevisionUrl =
For Beta:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For CodePipelineDemoFleet:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = d-D5LTCZXEX
ExternalExecutionUrl = https://console.aws.amazon.com/codedeploy/home?#/deployments/d-D5LTCZXEX
LastStatusChange = 07/08/2015 22:07:42
PercentComplete = 0
Status = Succeeded
Summary = Deployment Succeeded
RevisionUrl =
For TestStage:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For MyJenkinsTestAction25:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = 5
ExternalExecutionUrl = http://54.174.131.1EX/job/MyJenkinsDemo/5
LastStatusChange = 07/08/2015 22:09:03
PercentComplete = 0
Status = Succeeded
Summary = Finished
RevisionUrl =
```
+ Para obtener más información sobre la API, consulte [GetPipelineState](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CPCustomActionType`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CPCustomActionType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva acción personalizada con las propiedades especificadas.**
```
New-CPCustomActionType -Category Build -ConfigurationProperty @{"Description" = "The name of the build project must be provided when this action is added to the pipeline."; "Key" = $True; "Name" = "ProjectName"; "Queryable" = $False; "Required" = $True; "Secret" = $False; "Type" = "String"} -Settings_EntityUrlTemplate "https://my-build-instance/job/{Config:ProjectName}/" -Settings_ExecutionUrlTemplate "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild{ExternalExecutionId}/" -InputArtifactDetails_MaximumCount 1 -OutputArtifactDetails_MaximumCount 1 -InputArtifactDetails_MinimumCount 0 -OutputArtifactDetails_MinimumCount 0 -Provider "MyBuildProviderName" -Version 1
```
**Salida:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ Para obtener más información sobre la API, consulte [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CPPipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CPPipeline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva canalización con la configuración especificada.**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "Source"
$deployStage.Name = "Beta"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
New-CPPipeline -Pipeline $pipeline
```
**Salida:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ Para obtener más información sobre la API, consulte [CreatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CPCustomActionType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CPCustomActionType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la acción personalizada especificada. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar la acción personalizada sin una petición.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ Para obtener más información sobre la API, consulte [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CPPipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CPPipeline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la canalización especificada. El comando solicitará una confirmación antes de continuar. Añada el parámetro -Force para eliminar la canalización sin una petición.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ Para obtener más información sobre la API, consulte [DeletePipeline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-CPPipelineExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-CPPipelineExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se empieza a ejecutar la canalización especificada.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ Para obtener más información sobre la API, consulte [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CPPipeline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CPPipeline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza la canalización existente especificada con la configuración especificada.**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "MyInputFiles"
$deployStage.Name = "MyTestDeployment"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
Update-CPPipeline -Pipeline $pipeline
```
**Salida:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ Para obtener más información sobre la API, consulte [UpdatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon Cognito Identity con herramientas para la versión 5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon Cognito Identity.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-CGIIdentityPool`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CGIIdentityPool`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recuperación de información sobre un grupo de identidades específico mediante el identificador.**
```
Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Salida:**
```
LoggedAt : 8/12/2015 4:29:40 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : CommonTests1
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 142
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [DescribeIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CGIIdentityPoolList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CGIIdentityPoolList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recuperación de una lista de grupos de identidades existentes.**
```
Get-CGIIdentityPoolList
```
**Salida:**
```
IdentityPoolId IdentityPoolName
-------------- ----------------
us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 CommonTests1
us-east-1:118d242d-204e-4b88-b803-EXAMPLEGUID2 Tests2
us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 CommonTests13
```
+ Para obtener más información sobre la API, consulte [ListIdentityPools](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CGIIdentityPoolRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CGIIdentityPoolRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Obtención de información sobre los roles de un grupo de identidades específico.**
```
Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Salida:**
```
LoggedAt : 8/12/2015 4:33:51 PM
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
Roles : {[unauthenticated, arn:aws:iam::123456789012:role/CommonTests1Role]}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 165
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [GetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-CGIIdentityPool`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-CGIIdentityPool`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Creación de un nuevo grupo de identidades que permite identidades no autenticadas.**
```
New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13
```
**Salida:**
```
LoggedAt : 8/12/2015 4:56:07 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3
IdentityPoolName : CommonTests13
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 136
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [CreateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CGIIdentityPool`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CGIIdentityPool`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Eliminación de un grupo de identidades específico.**
```
Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
+ Para obtener más información sobre la API, consulte [DeleteIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-CGIIdentityPoolRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-CGIIdentityPoolRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Configuración del grupo de identidades específico para que tenga un rol de IAM no autenticado.**
```
Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }
```
+ Para obtener más información sobre la API, consulte [SetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-CGIIdentityPool`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-CGIIdentityPool`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Actualización de algunas de las propiedades del grupo de identidades, en este caso el nombre del grupo de identidades.**
```
Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName
```
**Salida:**
```
LoggedAt : 8/12/2015 4:53:33 PM
AllowUnauthenticatedIdentities : False
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : NewPoolName
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 135
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [UpdateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS Config ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS Config
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-CFGResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-CFGResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este ejemplo asocia la etiqueta especificada al ARN del recurso, que es config-rule/config-rule-16iyn0 en este caso. **
```
Add-CFGResourceTag -ResourceArn arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-16iyn0 -Tag @{Key="Release";Value="Beta"}
```
+ Para obtener más información sobre la API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGAggregateComplianceByConfigRuleList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateComplianceByConfigRuleList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se obtienen los detalles del filtrado ConfigurationAggregator «kaju» para la regla de configuración dada y el «cumplimiento» de expands/returns la regla.**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK | Select-Object -ExpandProperty Compliance
```
**Salida:**
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
Amazon.ConfigService.Model.ComplianceContributorCount NON_COMPLIANT
```
**Ejemplo 2: En este ejemplo, se obtienen los detalles de lo indicado ConfigurationAggregator, se filtran para la cuenta en cuestión para todas las regiones incluidas en el agregador y, además, se devuelve el cumplimiento de todas las reglas.**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_AccountId 123456789012 | Select-Object ConfigRuleName, @{N="Compliance";E={$_.Compliance.ComplianceType}}
```
**Salida:**
```
ConfigRuleName Compliance
-------------- ----------
ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK NON_COMPLIANT
ec2-instance-no-public-ip NON_COMPLIANT
desired-instance-type NON_COMPLIANT
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeAggregateComplianceByConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-CFGAggregateComplianceDetailsByConfigRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateComplianceDetailsByConfigRule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelven los resultados de la evaluación y se selecciona la salida con el identificador de recurso y el tipo de recurso para la regla de AWS Config «desired-instance-type», que están en estado «CONFORME» para la cuenta, el agregador, la región y la regla de configuración determinados**
```
Get-CFGAggregateComplianceDetailsByConfigRule -AccountId 123456789012 -AwsRegion eu-west-1 -ComplianceType COMPLIANT -ConfigRuleName desired-instance-type -ConfigurationAggregatorName raju | Select-Object -ExpandProperty EvaluationResultIdentifier | Select-Object -ExpandProperty EvaluationResultQualifier
```
**Salida:**
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
desired-instance-type i-0f1bf2f34c5678d12 AWS::EC2::Instance
desired-instance-type i-0fd12dd3456789123 AWS::EC2::Instance
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet* Reference ([GetAggregateComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)V5).
### `Get-CFGAggregateConfigRuleComplianceSummary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateConfigRuleComplianceSummary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve el número de reglas no conformes del agregador especificado.**
```
(Get-CFGAggregateConfigRuleComplianceSummary -ConfigurationAggregatorName raju).AggregateComplianceCounts.ComplianceSummary.NonCompliantResourceCount
```
**Salida:**
```
CapExceeded CappedCount
----------- -----------
False 5
```
+ Para obtener más información sobre la API, consulte [GetAggregateConfigRuleComplianceSummary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGAggregateDiscoveredResourceCount`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateDiscoveredResourceCount`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve el número de recursos del agregador especificado filtrado para la región us-east-1.**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1
```
**Salida:**
```
GroupByKey GroupedResourceCounts NextToken TotalDiscoveredResources
---------- --------------------- --------- ------------------------
{} 455
```
**Ejemplo 2: Este ejemplo devuelve el número de recursos agrupados por RESOURCE\$1TYPE de la región filtrada para el agregador especificado.**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1 -GroupByKey RESOURCE_TYPE |
Select-Object -ExpandProperty GroupedResourceCounts
```
**Salida:**
```
GroupName ResourceCount
--------- -------------
AWS::CloudFormation::Stack 12
AWS::CloudFront::Distribution 1
AWS::CloudTrail::Trail 1
AWS::DynamoDB::Table 1
AWS::EC2::EIP 2
AWS::EC2::FlowLog 2
AWS::EC2::InternetGateway 4
AWS::EC2::NatGateway 2
AWS::EC2::NetworkAcl 4
AWS::EC2::NetworkInterface 12
AWS::EC2::RouteTable 13
AWS::EC2::SecurityGroup 18
AWS::EC2::Subnet 16
AWS::EC2::VPC 4
AWS::EC2::VPCEndpoint 2
AWS::EC2::VPCPeeringConnection 1
AWS::IAM::Group 2
AWS::IAM::Policy 51
AWS::IAM::Role 78
AWS::IAM::User 7
AWS::Lambda::Function 3
AWS::RDS::DBSecurityGroup 1
AWS::S3::Bucket 3
AWS::SSM::AssociationCompliance 107
AWS::SSM::ManagedInstanceInventory 108
```
+ Para obtener más información sobre la API, consulte [GetAggregateDiscoveredResourceCounts](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGAggregateDiscoveredResourceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateDiscoveredResourceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve los identificadores de recursos para el tipo de recurso especificado agregado en el agregador “Ireland”. Para ver la lista de tipos de recursos, consulte https://docs.aws.amazon.com/sdkfornet/ v4/ apidocs/index.html?page=ConfigService/TConfigServiceResourceType .html&tocid=Amazon\$1 \$1. ConfigService ResourceType**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName Ireland -ResourceType ([Amazon.ConfigService.ResourceType]::AWSAutoScalingAutoScalingGroup)
```
**Salida:**
```
ResourceId : arn:aws:autoscaling:eu-west-1:123456789012:autoScalingGroup:12e3b4fc-1234-1234-a123-1d2ba3c45678:autoScalingGroupName/asg-1
ResourceName : asg-1
ResourceType : AWS::AutoScaling::AutoScalingGroup
SourceAccountId : 123456789012
SourceRegion : eu-west-1
```
**Ejemplo 2: Este ejemplo devuelve el tipo de recurso `AwsEC2SecurityGroup` llamado “default” del agregador especificado filtrado con la región us-east-1.**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName raju -ResourceType ([Amazon.ConfigService.ResourceType]::AWSEC2SecurityGroup) -Filters_Region us-east-1 -Filters_ResourceName default
```
**Salida:**
```
ResourceId : sg-01234bd5dbfa67c89
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
ResourceId : sg-0123a4ebbf56789be
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
ResourceId : sg-4fc1d234
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
```
+ *Para obtener más información sobre la API, consulte la referencia de cmdlets (V5). [ListAggregateDiscoveredResources](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Get-CFGAggregateResourceConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateResourceConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve el elemento de configuración del recurso especificado agregado y se expande la configuración.**
```
(Get-CFGAggregateResourceConfig -ResourceIdentifier_SourceRegion us-east-1 -ResourceIdentifier_SourceAccountId 123456789012 -ResourceIdentifier_ResourceId sg-4fc1d234 -ResourceIdentifier_ResourceType ([Amazon.ConfigService.ResourceType]::AWSEC2SecurityGroup) -ConfigurationAggregatorName raju).Configuration | ConvertFrom-Json
```
**Salida:**
```
{"description":"default VPC security group","groupName":"default","ipPermissions":[{"ipProtocol":"-1","ipv6Ranges":[],"prefixListIds":[],"userIdGroupPairs":[{"groupId":"sg-4fc1d234","userId":"123456789012"}],"ipv4Ranges":[],"ipRanges":[]},{"fromPort":3389,"ipProtocol":"tcp","ipv6Ranges":[],"prefixListIds":[],"toPort":3389,"userIdGroupPairs":[],"ipv4Ranges":[{"cidrIp":"54.240.197.224/29","description":"office subnet"},{"cidrIp":"72.21.198.65/32","description":"home pc"}],"ipRanges":["54.240.197.224/29","72.21.198.65/32"]}],"ownerId":"123456789012","groupId":"sg-4fc1d234","ipPermissionsEgress":[{"ipProtocol":"-1","ipv6Ranges":[],"prefixListIds":[],"userIdGroupPairs":[],"ipv4Ranges":[{"cidrIp":"0.0.0.0/0"}],"ipRanges":["0.0.0.0/0"]}],"tags":[],"vpcId":"vpc-2d1c2e34"}
```
+ Para obtener más información sobre la API, consulte [GetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference* (V5).
### `Get-CFGAggregateResourceConfigBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregateResourceConfigBatch`.
** PowerShell Herramientas para la versión 5**
**Ejemplo 1: Este ejemplo busca el elemento de configuración actual del recurso (identificado) presente en el agregador especificado.**
```
$resIdentifier=[Amazon.ConfigService.Model.AggregateResourceIdentifier]@{
ResourceId= "i-012e3cb4df567e8aa"
ResourceName = "arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa"
ResourceType = [Amazon.ConfigService.ResourceType]::AWSEC2Instance
SourceAccountId = "123456789012"
SourceRegion = "eu-west-1"
}
Get-CFGAggregateResourceConfigBatch -ResourceIdentifier $resIdentifier -ConfigurationAggregatorName raju
```
**Salida:**
```
BaseConfigurationItems UnprocessedResourceIdentifiers
---------------------- ------------------------------
{} {arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa}
```
+ Para obtener más información sobre la API, consulte [BatchGetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference* (V5).
### `Get-CFGAggregationAuthorizationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGAggregationAuthorizationList`.
** PowerShell Herramientas para la versión 5**
**Ejemplo 1: Este ejemplo recupera las autorizaciones concedidas a los agregadores.**
```
Get-CFGAggregationAuthorizationList
```
**Salida:**
```
AggregationAuthorizationArn AuthorizedAccountId AuthorizedAwsRegion CreationTime
--------------------------- ------------------- ------------------- ------------
arn:aws:config-service:eu-west-1:123456789012:aggregation-authorization/123456789012/eu-west-1 123456789012 eu-west-1 8/26/2019 12:55:27 AM
```
+ Para obtener más información sobre la API, consulte [DescribeAggregationAuthorizations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGComplianceByConfigRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceByConfigRule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo recupera los detalles de conformidad de la regla ebs-optimized-instance, para los que no hay resultados de evaluación actuales, por lo que devuelve INSUFFICIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Salida:**
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Ejemplo 2: Este ejemplo devuelve el número de recursos no conformes para la regla ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Salida:**
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5 [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)).Herramientas de AWS para PowerShell *
### `Get-CFGComplianceByResource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceByResource`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se revisa el tipo de recurso `AWS::SSM::ManagedInstanceInventory` para el tipo de cumplimiento COMPLIANT.**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Salida:**
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Para obtener más información sobre la API, consulte [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGComplianceDetailsByConfigRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceDetailsByConfigRule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los resultados de la evaluación de la regla access-keys-rotated y se devuelve el resultado agrupado por tipo de conformidad**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Salida:**
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**Ejemplo 2: En este ejemplo se consultan los detalles de conformidad de la regla access-keys-rotated para los recursos de COMPLIANT.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Salida:**
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Para obtener más información sobre la API, consulte [GetComplianceDetailsByConfigRule Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-CFGComplianceDetailsByResource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceDetailsByResource`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve los resultados de la evaluación de un recurso determinado.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Salida:**
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ Para obtener más información sobre la API, consulte [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGComplianceSummaryByConfigRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceSummaryByConfigRule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve el número de reglas de Config que no son conformes.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Salida:**
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Para obtener más información sobre la API, consulte [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGComplianceSummaryByResourceType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGComplianceSummaryByResourceType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se devuelve el número de recursos conformes y no conformes, y se convierte el resultado en json.**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ Para obtener más información sobre la API, consulte [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigRule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se enumeran las reglas de configuración de la cuenta, con las propiedades seleccionadas.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Salida:**
```
ConfigRuleName ConfigRuleId ConfigRuleArn ConfigRuleState
-------------- ------------ ------------- ---------------
ALB_REDIRECTION_CHECK config-rule-12iyn3 arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-12iyn3 ACTIVE
access-keys-rotated config-rule-aospfr arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-aospfr ACTIVE
autoscaling-group-elb-healthcheck-required config-rule-cn1f2x arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-cn1f2x ACTIVE
```
+ Para obtener más información sobre la API, consulte [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigRuleEvaluationStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigRuleEvaluationStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve la información de estado de las reglas de configuración correspondientes.**
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Salida:**
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ Para obtener más información sobre la API, consulte [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigurationAggregatorList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigurationAggregatorList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve todos los agregadores de la región o cuenta.**
```
Get-CFGConfigurationAggregatorList
```
**Salida:**
```
AccountAggregationSources : {Amazon.ConfigService.Model.AccountAggregationSource}
ConfigurationAggregatorArn : arn:aws:config-service:eu-west-1:123456789012:config-aggregator/config-aggregator-xabca1me
ConfigurationAggregatorName : IrelandMaster
CreationTime : 8/25/2019 11:42:39 PM
LastUpdatedTime : 8/25/2019 11:42:39 PM
OrganizationAggregationSource :
AccountAggregationSources : {}
ConfigurationAggregatorArn : arn:aws:config-service:eu-west-1:123456789012:config-aggregator/config-aggregator-qubqabcd
ConfigurationAggregatorName : raju
CreationTime : 8/11/2019 8:39:25 AM
LastUpdatedTime : 8/11/2019 8:39:25 AM
OrganizationAggregationSource : Amazon.ConfigService.Model.OrganizationAggregationSource
```
+ Para obtener más información sobre la API, consulte [DescribeConfigurationAggregators](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigurationAggregatorSourcesStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigurationAggregatorSourcesStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los campos solicitados para las fuentes del agregador especificado.**
```
Get-CFGConfigurationAggregatorSourcesStatus -ConfigurationAggregatorName raju | select SourceType, LastUpdateStatus, LastUpdateTime, SourceId
```
**Salida:**
```
SourceType LastUpdateStatus LastUpdateTime SourceId
---------- ---------------- -------------- --------
ORGANIZATION SUCCEEDED 12/31/2019 7:45:06 AM Organization
ACCOUNT SUCCEEDED 12/31/2019 7:09:38 AM 612641234567
ACCOUNT SUCCEEDED 12/31/2019 7:12:53 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:18:10 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:25:17 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:25:49 AM 612641234567
ACCOUNT SUCCEEDED 12/31/2019 7:26:11 AM 612641234567
```
+ Para obtener más información sobre la API, consulte [DescribeConfigurationAggregatorSourcesStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigurationRecorder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigurationRecorder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve información sobre los registros de configuración.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Salida:**
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Para obtener más información sobre la API, consulte [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConfigurationRecorderStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConfigurationRecorderStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve el estado de los registros de configuración.**
```
Get-CFGConfigurationRecorderStatus
```
**Salida:**
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ Para obtener más información sobre la API, consulte [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGConformancePack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGConformancePack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran todos los paquetes de conformidad.**
```
Get-CFGConformancePack
```
**Salida:**
```
ConformancePackArn : arn:aws:config:eu-west-1:123456789012:conformance-pack/dono/conformance-pack-p0acq8bpz
ConformancePackId : conformance-pack-p0acabcde
ConformancePackInputParameters : {}
ConformancePackName : dono
CreatedBy :
DeliveryS3Bucket : kt-ps-examples
DeliveryS3KeyPrefix :
LastUpdateRequestedTime : 12/31/2019 8:45:31 AM
```
+ Para obtener más información sobre la API, consulte [DescribeConformancePacks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGDeliveryChannel`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGDeliveryChannel`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se recupera el canal de entrega de la región y se muestran los detalles.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Salida:**
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Para obtener más información sobre la API, consulte [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-CFGResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-CFGResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas asociadas del recurso especificado.**
```
Get-CFGResourceTag -ResourceArn $rules[0].ConfigRuleArn
```
**Salida:**
```
Key Value
--- -----
Version 1.3
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-CFGConformancePack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-CFGConformancePack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el paquete de conformidad indicado, junto con todas las reglas, las acciones correctivas y los resultados de la evaluación del paquete.**
```
Remove-CFGConformancePack -ConformancePackName dono
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-CFGConformancePack (DeleteConformancePack)" on target "dono".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-CFGConformancePack`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-CFGConformancePack`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un paquete de conformidad y se obtiene la plantilla del archivo yaml especificado. **
```
Write-CFGConformancePack -ConformancePackName dono -DeliveryS3Bucket amzn-s3-demo-bucket -TemplateBody (Get-Content C:\windows\temp\template.yaml -Raw)
```
+ Para obtener más información sobre la API, consulte [PutConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-CFGDeliveryChannel`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-CFGDeliveryChannel`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se cambia la propiedad deliveryFrequency de un canal de entrega existente.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Para obtener más información sobre la API, consulte [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Device Farm con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Device Farm.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `New-DFUpload`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DFUpload`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se crea una carga de AWS Device Farm para una aplicación de Android. Puede obtener el ARN del proyecto a partir de la salida de New- DFProject o Get- DFProject List. Usa la URL firmada en el DFUpload resultado Nuevo para cargar un archivo en Device Farm.**
```
New-DFUpload -ContentType "application/octet-stream" -ProjectArn "arn:aws:devicefarm:us-west-2:123456789012:project:EXAMPLEa-7ec1-4741-9c1f-d3e04EXAMPLE" -Name "app.apk" -Type ANDROID_APP
```
+ Para obtener más información sobre la API, consulte [CreateUpload Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
# Directory Service ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. Directory Service
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-DSIpRoute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DSIpRoute`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este comando elimina la etiqueta de recurso asignada al Directory-id especificado.**
```
Add-DSIpRoute -DirectoryId d-123456ijkl -IpRoute @{CidrIp ="203.0.113.5/32"} -UpdateSecurityGroupForDirectoryController $true
```
+ Para obtener más información sobre la API, consulte [AddIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-DSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando añade la etiqueta de recurso asignada al Directory-id especificado.**
```
Add-DSResourceTag -ResourceId d-123456ijkl -Tag @{Key="myTag"; Value="mytgValue"}
```
+ Para obtener más información sobre la API, consulte [AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Approve-DSTrust`
En el siguiente ejemplo de código, se muestra cómo utilizar `Approve-DSTrust`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo llama a la operación VerifyTrust API de AWS Directory Service para un Trustid especificado.**
```
Approve-DSTrust -TrustId t-9067157123
```
+ Para obtener más información sobre la API, consulte [VerifyTrust Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Confirm-DSSharedDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Confirm-DSSharedDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se acepta una solicitud de compartición de directorios enviada por el propietario Cuenta de AWS del directorio.**
```
Confirm-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**Salida:**
```
CreatedDateTime : 12/30/2019 4:20:27 AM
LastUpdatedDateTime : 12/30/2019 4:21:40 AM
OwnerAccountId : 123456781234
OwnerDirectoryId : d-123456ijkl
SharedAccountId : 123456784321
SharedDirectoryId : d-9067012345
ShareMethod :
ShareNotes : This is test sharing
ShareStatus : Sharing
```
+ Para obtener más información sobre la API, consulte [AcceptSharedDirectory Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Connect-DSDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Connect-DSDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un AD Connector para conectarse a un directorio en las instalaciones.**
```
Connect-DSDirectory -Name contoso.com -ConnectSettings_CustomerUserName Administrator -Password $Password -ConnectSettings_CustomerDnsIp 172.31.36.96 -ShortName CONTOSO -Size Small -ConnectSettings_VpcId vpc-123459da -ConnectSettings_SubnetId subnet-1234ccaa, subnet-5678ffbb
```
+ Para obtener más información sobre la API, consulte [ConnectDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Deny-DSSharedDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Deny-DSSharedDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se refleja una solicitud de uso compartido del directorio que se envió desde la cuenta del propietario del directorio. **
```
Deny-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**Salida:**
```
d-9067012345
```
+ Para obtener más información sobre la API, consulte [RejectSharedDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-DSDirectoryShare`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-DSDirectoryShare`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se detiene el uso compartido de directorio entre el propietario del directorio y la cuenta del consumidor. **
```
Disable-DSDirectoryShare -DirectoryId d-123456ijkl -UnshareTarget_Id 123456784321 -UnshareTarget_Type ACCOUNT
```
**Salida:**
```
d-9067012345
```
+ Para obtener más información sobre la API, consulte [UnshareDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-DSLDAPS`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-DSLDAPS`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desactivan las llamadas seguras LDAP para el directorio especificado.**
```
Disable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ Para obtener información sobre la API, consulte [DisableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Disable-DSRadius`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-DSRadius`.
**Herramientas para V5 PowerShell **
**Ejemplo 1: En este ejemplo se deshabilita el servidor RADIUS configurado para un directorio AD Connector o Microsoft AD.**
```
Disable-DSRadius -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [DisableRadius](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-DSSso`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-DSSso`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se deshabilita el inicio de sesión único en un directorio.**
```
Disable-DSSso -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [DisableSso](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-DSDirectoryShare`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-DSDirectoryShare`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo comparte un directorio específico de su AWS cuenta con otra AWS cuenta mediante el método Handshake.**
```
Enable-DSDirectoryShare -DirectoryId d-123456ijkl -ShareTarget_Id 123456784321 -ShareMethod HANDSHAKE -ShareTarget_Type ACCOUNT
```
**Salida:**
```
d-9067012345
```
+ Para obtener más información sobre la API, consulte [ShareDirectory Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Enable-DSLDAPS`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-DSLDAPS`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se activa el modificador para que el directorio específico utilice siempre llamadas LDAP seguras.**
```
Enable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ Para obtener información sobre la API, consulte [EnableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Enable-DSRadius`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-DSRadius`.
**Herramientas para V5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la autenticación multifactor (MFA) con la configuración de servidor RADIUS proporcionada para un directorio de AD Connector o Microsoft AD.**
```
Enable-DSRadius -DirectoryId d-123456ijkl
-RadiusSettings_AuthenticationProtocol PAP
-RadiusSettings_DisplayLabel Radius
-RadiusSettings_RadiusPort 1812
-RadiusSettings_RadiusRetry 4
-RadiusSettings_RadiusServer 10.4.185.113
-RadiusSettings_RadiusTimeout 50
-RadiusSettings_SharedSecret wJalrXUtnFEMI
```
+ Para obtener más información sobre la API, consulte [EnableRadius](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-DSSso`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-DSSso`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita el inicio de sesión único en un directorio.**
```
Enable-DSSso -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [EnableSso](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra información sobre el certificado registrado para una conexión LDAP segura.**
```
Get-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
**Salida:**
```
CertificateId : c-906731e34f
CommonName : contoso-EC2AMAZ-CTGG2NM-CA
ExpiryDateTime : 4/15/2025 6:34:15 PM
RegisteredDateTime : 4/15/2020 6:38:56 PM
State : Registered
StateReason : Certificate registered successfully.
```
+ Para obtener más información sobre la API, consulte [DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSCertificateList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSCertificateList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran todos los certificados registrados para una conexión LDAP segura para el directorio especificado.**
```
Get-DSCertificateList -DirectoryId d-123456ijkl
```
**Salida:**
```
CertificateId CommonName ExpiryDateTime State
------------- ---------- -------------- -----
c-906731e34f contoso-EC2AMAZ-CTGG2NM-CA 4/15/2025 6:34:15 PM Registered
```
+ Para obtener más información sobre la API, consulte [ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSConditionalForwarder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSConditionalForwarder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene todos los reenviadores condicionales configurados con un Directory-id determinado.**
```
Get-DSConditionalForwarder -DirectoryId d-123456ijkl
```
**Salida:**
```
DnsIpAddrs RemoteDomainName ReplicationScope
---------- ---------------- ----------------
{172.31.77.239} contoso.com Domain
```
+ Para obtener más información sobre la API, consulte [DescribeConditionalForwarders](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene información acerca de los directorios que pertenecen a esta cuenta.**
```
Get-DSDirectory | Select-Object DirectoryId, Name, DnsIpAddrs, Type
```
**Salida:**
```
DirectoryId Name DnsIpAddrs Type
----------- ---- ---------- ----
d-123456abcd abcd.example.com {172.31.74.189, 172.31.13.145} SimpleAD
d-123456efgh wifi.example.com {172.31.16.108, 172.31.10.56} ADConnector
d-123456ijkl lan2.example.com {172.31.10.56, 172.31.16.108} MicrosoftAD
```
+ Para obtener más información sobre la API, consulte [DescribeDirectories](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSDirectoryLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSDirectoryLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la información de límite de directorio de la región us-east-1.**
```
Get-DSDirectoryLimit -Region us-east-1
```
**Salida:**
```
CloudOnlyDirectoriesCurrentCount : 1
CloudOnlyDirectoriesLimit : 10
CloudOnlyDirectoriesLimitReached : False
CloudOnlyMicrosoftADCurrentCount : 1
CloudOnlyMicrosoftADLimit : 20
CloudOnlyMicrosoftADLimitReached : False
ConnectedDirectoriesCurrentCount : 1
ConnectedDirectoriesLimit : 10
```
+ Para obtener más información sobre la API, consulte [GetDirectoryLimits](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSDomainControllerList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSDomainControllerList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene la lista detallada de los controladores de dominio lanzados para el directory-id especificado.**
```
Get-DSDomainControllerList -DirectoryId d-123456ijkl
```
**Salida:**
```
AvailabilityZone : us-east-1b
DirectoryId : d-123456ijkl
DnsIpAddr : 172.31.16.108
DomainControllerId : dc-1234567aa6
LaunchTime : 4/4/2019 4:53:43 AM
Status : Active
StatusLastUpdatedDateTime : 4/24/2019 1:37:54 PM
StatusReason :
SubnetId : subnet-1234kkaa
VpcId : vpc-123459d
AvailabilityZone : us-east-1d
DirectoryId : d-123456ijkl
DnsIpAddr : 172.31.10.56
DomainControllerId : dc-1234567aa7
LaunchTime : 4/4/2019 4:53:43 AM
Status : Active
StatusLastUpdatedDateTime : 4/4/2019 5:14:31 AM
StatusReason :
SubnetId : subnet-5678ffbb
VpcId : vpc-123459d
```
+ Para obtener más información sobre la API, consulte [DescribeDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSEventTopic`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSEventTopic`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando muestra información sobre el tema de SNS configurado para su notificación cuando el estado del directorio cambie.**
```
Get-DSEventTopic -DirectoryId d-123456ijkl
```
**Salida:**
```
CreatedDateTime : 12/13/2019 11:15:32 AM
DirectoryId : d-123456ijkl
Status : Registered
TopicArn : arn:aws:sns:us-east-1:123456781234:snstopicname
TopicName : snstopicname
```
+ Para obtener más información sobre la API, consulte [DescribeEventTopics](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSIpRouteList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSIpRouteList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene los bloques de direcciones IP públicas configurados en el enrutamiento IP de directorios.**
```
Get-DSIpRouteList -DirectoryId d-123456ijkl
```
**Salida:**
```
AddedDateTime : 12/13/2019 12:27:22 PM
CidrIp : 203.0.113.5/32
Description : Public IP of On-Prem DNS Server
DirectoryId : d-123456ijkl
IpRouteStatusMsg : Added
IpRouteStatusReason :
```
+ Para obtener más información sobre la API, consulte [ListIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSLDAPSSetting`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSLDAPSSetting`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el estado de la seguridad LDAP para el directorio especificado.**
```
Get-DSLDAPSSetting -DirectoryId d-123456ijkl
```
**Salida:**
```
LastUpdatedDateTime LDAPSStatus LDAPSStatusReason
------------------- ----------- -----------------
4/15/2020 6:51:03 PM Enabled LDAPS is enabled successfully.
```
+ Para obtener información detallada sobre la API, consulte la sección [Describe LDAPSSettings](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Get-DSLogSubscriptionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSLogSubscriptionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene la información de registro de suscripciones del directory-id especificado. **
```
Get-DSLogSubscriptionList -DirectoryId d-123456ijkl
```
**Salida:**
```
DirectoryId LogGroupName SubscriptionCreatedDateTime
----------- ------------ ---------------------------
d-123456ijkl /aws/directoryservice/d-123456ijkl-lan2.example.com 12/14/2019 9:05:23 AM
```
+ Para obtener más información sobre la API, consulte [ListLogSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene todas las etiquetas del directorio especificado.**
```
Get-DSResourceTag -ResourceId d-123456ijkl
```
**Salida:**
```
Key Value
--- -----
myTag myTagValue
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSSchemaExtension`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSSchemaExtension`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo muestra todas las extensiones de esquema que se aplican a un directorio de Microsoft AD.**
```
Get-DSSchemaExtension -DirectoryId d-123456ijkl
```
**Salida:**
```
Description : ManagedADSchemaExtension
DirectoryId : d-123456ijkl
EndDateTime : 4/12/2020 10:30:49 AM
SchemaExtensionId : e-9067306643
SchemaExtensionStatus : Completed
SchemaExtensionStatusReason : Schema updates are complete.
StartDateTime : 4/12/2020 10:28:42 AM
```
+ Para obtener más información sobre la API, consulte [ListSchemaExtensions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSSharedDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSSharedDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los directorios compartidos de su cuenta AWS **
```
Get-DSSharedDirectory -OwnerDirectoryId d-123456ijkl -SharedDirectoryId d-9067012345
```
**Salida:**
```
CreatedDateTime : 12/30/2019 4:34:37 AM
LastUpdatedDateTime : 12/30/2019 4:35:22 AM
OwnerAccountId : 123456781234
OwnerDirectoryId : d-123456ijkl
SharedAccountId : 123456784321
SharedDirectoryId : d-9067012345
ShareMethod : HANDSHAKE
ShareNotes : This is a test Sharing
ShareStatus : Shared
```
+ Para obtener más información sobre la API, consulte [DescribeSharedDirectories Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-DSSnapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSSnapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene información acerca de las instancias de directorio especificadas que pertenecen a esta cuenta.**
```
Get-DSSnapshot -DirectoryId d-123456ijkl
```
**Salida:**
```
DirectoryId : d-123456ijkl
Name :
SnapshotId : s-9064bd1234
StartTime : 12/13/2019 6:33:01 PM
Status : Completed
Type : Auto
DirectoryId : d-123456ijkl
Name :
SnapshotId : s-9064bb4321
StartTime : 12/9/2019 9:48:11 PM
Status : Completed
Type : Auto
```
+ Para obtener más información sobre la API, consulte [DescribeSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSSnapshotLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSSnapshotLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene los límites de instantáneas manuales de un directorio especificado.**
```
Get-DSSnapshotLimit -DirectoryId d-123456ijkl
```
**Salida:**
```
ManualSnapshotsCurrentCount ManualSnapshotsLimit ManualSnapshotsLimitReached
--------------------------- -------------------- ---------------------------
0 5 False
```
+ Para obtener más información sobre la API, consulte [GetSnapshotLimits](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DSTrust`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DSTrust`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando obtiene la información de las relaciones de confianza creadas para el directory-id especificado.**
```
Get-DSTrust -DirectoryId d-123456abcd
```
**Salida:**
```
CreatedDateTime : 7/5/2019 4:55:42 AM
DirectoryId : d-123456abcd
LastUpdatedDateTime : 7/5/2019 4:56:04 AM
RemoteDomainName : contoso.com
SelectiveAuth : Disabled
StateLastUpdatedDateTime : 7/5/2019 4:56:04 AM
TrustDirection : One-Way: Incoming
TrustId : t-9067157123
TrustState : Created
TrustStateReason :
TrustType : Forest
```
+ Para obtener más información sobre la API, consulte [DescribeTrusts](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-DSAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando crea un alias para un directorio y lo asigna al directory-id especificado.**
```
New-DSAlias -DirectoryId d-123456ijkl -Alias MyOrgName
```
**Salida:**
```
Alias DirectoryId
----- -----------
myorgname d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-DSComputer`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSComputer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo objeto de equipo de Active Directory.**
```
New-DSComputer -DirectoryId d-123456ijkl -ComputerName ADMemberServer -Password $Password
```
**Salida:**
```
ComputerAttributes ComputerId ComputerName
------------------ ---------- ------------
{WindowsSamName, DistinguishedName} S-1-5-21-1191241402-978882507-2717148213-1662 ADMemberServer
```
+ Para obtener más información sobre la API, consulte [CreateComputer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-DSConditionalForwarder`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSConditionalForwarder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea un reenviador condicional en el ID de directorio especificado AWS .**
```
New-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.10.56 -RemoteDomainName contoso.com
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [CreateConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `New-DSDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo directorio Simple AD.**
```
New-DSDirectory -Name corp.example.com -Password $Password -Size Small -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ Para obtener más información sobre la API, consulte [CreateDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-DSLogSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSLogSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea una suscripción para reenviar los registros de seguridad del controlador de dominio de Directory Service en tiempo real al grupo de registros de Amazon CloudWatch especificado en su Cuenta de AWS.**
```
New-DSLogSubscription -DirectoryId d-123456ijkl -LogGroupName /aws/directoryservice/d-123456ijkl-lan2.example.com
```
+ Para obtener más información sobre la API, consulte [CreateLogSubscription Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-DSMicrosoftAD`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSMicrosoftAD`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo directorio de Microsoft AD en Nube de AWS.**
```
New-DSMicrosoftAD -Name corp.example.com -Password $Password -edition Standard -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ Para obtener más información sobre la API, consulte [CreateMicrosoftAD](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (V5)*.
### `New-DSSnapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSSnapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una instantánea del directorio.**
```
New-DSSnapshot -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-DSTrust`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DSTrust`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea una confianza bidireccional en todo el bosque entre el directorio administrado de AWS Microsoft AD y el Microsoft Active Directory local existente.**
```
New-DSTrust -DirectoryId d-123456ijkl -RemoteDomainName contoso.com -TrustDirection Two-Way -TrustType Forest -TrustPassword $Password -ConditionalForwarderIpAddr 172.31.36.96
```
**Salida:**
```
t-9067157123
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [CreateTrust](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Register-DSCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-DSCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra un certificado para una conexión LDAP segura.**
```
$Certificate = Get-Content contoso.cer -Raw
Register-DSCertificate -DirectoryId d-123456ijkl -CertificateData $Certificate
```
**Salida:**
```
c-906731e350
```
+ Para obtener más información sobre la API, consulte [RegisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-DSEventTopic`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-DSEventTopic`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia un directorio como publicador a un tema de SNS.**
```
Register-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ Para obtener más información sobre la API, consulte [RegisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DSConditionalForwarder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSConditionalForwarder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el reenviador condicional que se ha configurado para su AWS directorio.**
```
Remove-DSConditionalForwarder -DirectoryId d-123456ijkl -RemoteDomainName contoso.com
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DeleteConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Remove-DSDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina un AWS directorio de servicios de directorio (conector AD/Microsoft AD/AD simple)**
```
Remove-DSDirectory -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DeleteDirectory](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Remove-DSIpRoute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSIpRoute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando elimina la IP especificada de las rutas IP configuradas de Directory-id. **
```
Remove-DSIpRoute -DirectoryId d-123456ijkl -CidrIp 203.0.113.5/32
```
+ Para obtener más información sobre la API, consulte [RemoveIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DSLogSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSLogSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando elimina la suscripción del registro del Directory-id especificado.**
```
Remove-DSLogSubscription -DirectoryId d-123456ijkl
```
+ Para obtener más información sobre la API, consulte [DeleteLogSubscription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando elimina la etiqueta de recurso asignada al Directory-id especificado.**
```
Remove-DSResourceTag -ResourceId d-123456ijkl -TagKey myTag
```
+ Para obtener más información sobre la API, consulte [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DSSnapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSSnapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la instantánea creada manualmente.**
```
Remove-DSSnapshot -SnapshotId s-9068b488kc
```
+ Para obtener más información sobre la API, consulte [DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DSTrust`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DSTrust`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la relación de confianza existente entre el directorio de AD AWS administrado y un dominio externo.**
```
Get-DSTrust -DirectoryId d-123456ijkl -Select Trusts.TrustId | Remove-DSTrust
```
**Salida:**
```
t-9067157123
```
+ Para obtener más información sobre la API, consulte [DeleteTrust](https://docs.aws.amazon.com/powershell/v5/reference)la referencia de *Herramientas de AWS para PowerShell cmdlets (*V5).
### `Reset-DSUserPassword`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-DSUserPassword`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se restablece la contraseña del usuario de Active Directory nombrado ADUser en el directorio AWS administrado de Microsoft AD o en el directorio Simple AD**
```
Reset-DSUserPassword -UserName ADuser -DirectoryId d-123456ijkl -NewPassword $Password
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ResetUserPassword](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Restore-DSFromSnapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Restore-DSFromSnapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se restaura un directorio utilizando una instantánea de directorio existente.**
```
Restore-DSFromSnapshot -SnapshotId s-9068b488kc
```
+ Para obtener más información sobre la API, consulte [RestoreFromSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-DSDomainControllerCount`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-DSDomainControllerCount`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se establece el número de controladores de dominio en 3 para el directory-id especificado.**
```
Set-DSDomainControllerCount -DirectoryId d-123456ijkl -DesiredNumber 3
```
+ Para obtener más información sobre la API, consulte [UpdateNumberOfDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-DSSchemaExtension`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-DSSchemaExtension`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se aplica una extensión de esquema a un directorio de Microsoft AD.**
```
$ldif = Get-Content D:\Users\Username\Downloads\ExtendedSchema.ldf -Raw
Start-DSSchemaExtension -DirectoryId d-123456ijkl -CreateSnapshotBeforeSchemaExtension $true -Description ManagedADSchemaExtension -LdifContent $ldif
```
**Salida:**
```
e-9067306643
```
+ Para obtener más información sobre la API, consulte [StartSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-DSSchemaExtension`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-DSSchemaExtension`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela una extensión de esquema en curso a un directorio de Microsoft AD.**
```
Stop-DSSchemaExtension -DirectoryId d-123456ijkl -SchemaExtensionId e-9067306643
```
+ Para obtener más información sobre la API, consulte [CancelSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-DSCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-DSCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina del sistema el certificado registrado para una conexión LDAP segura.**
```
Unregister-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
+ Para obtener más información sobre la API, consulte [DeregisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-DSEventTopic`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-DSEventTopic`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el directorio especificado como publicador en el tema de SNS especificado. **
```
Unregister-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ Para obtener más información sobre la API, consulte [DeregisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-DSConditionalForwarder`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DSConditionalForwarder`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza un reenviador condicional que se ha configurado para su AWS directorio.**
```
Update-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.16.108 -RemoteDomainName contoso.com
```
+ Para obtener más información sobre la API, consulte [UpdateConditionalForwarder Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Update-DSRadius`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DSRadius`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualizar la información del servidor RADIUS para un directorio AD Connector o Microsoft AD.**
```
Update-DSRadius -DirectoryId d-123456ijkl -RadiusSettings_RadiusRetry 3
```
+ Para obtener más información sobre la API, consulte [UpdateRadius](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-DSTrust`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DSTrust`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el SelectiveAuth parámetro del identificador de confianza especificado de desactivado a activado.**
```
Update-DSTrust -TrustId t-9067157123 -SelectiveAuth Enabled
```
**Salida:**
```
RequestId TrustId
--------- -------
138864a7-c9a8-4ad1-a828-eae479e85b45 t-9067157123
```
+ Para obtener más información sobre la API, consulte [UpdateTrust Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
# AWS DMS ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS DMS
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `New-DMSReplicationTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DMSReplicationTask`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se crea una nueva tarea de replicación del AWS Database Migration Service que utiliza CdcStartTime en lugar de CdcStartPosition. El MigrationType valor está establecido en full-load-and-cdc ««, lo que significa que la tabla de destino debe estar vacía. La nueva tarea se marca con una etiqueta que tiene la clave Stage y el valor de clave Test. Para obtener más información acerca de los valores que utiliza este cmdlet, consulte Creación de una tarea (https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Tasks.Creating.html) en la Guía del usuario de Database Migration Service. AWS **
```
New-DMSReplicationTask -ReplicationInstanceArn "arn:aws:dms:us-east-1:123456789012:rep:EXAMPLE66XFJUWATDJGBEXAMPLE"`
-CdcStartTime "2019-08-08T12:12:12"`
-CdcStopPosition "server_time:2019-08-09T12:12:12"`
-MigrationType "full-load-and-cdc"`
-ReplicationTaskIdentifier "task1"`
-ReplicationTaskSetting ""`
-SourceEndpointArn "arn:aws:dms:us-east-1:123456789012:endpoint:EXAMPLEW5UANC7Y3P4EEXAMPLE"`
-TableMapping "file:////home/testuser/table-mappings.json"`
-Tag @{"Key"="Stage";"Value"="Test"}`
-TargetEndpointArn "arn:aws:dms:us-east-1:123456789012:endpoint:EXAMPLEJZASXWHTWCLNEXAMPLE"
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference ([CreateReplicationTask](https://docs.aws.amazon.com/powershell/v5/reference)V5).Herramientas de AWS para PowerShell *
# Ejemplos de DynamoDB con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con DynamoDB.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-DDBIndexSchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DDBIndexSchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío y le añade una nueva definición de índice secundario local antes de escribir el TableSchema objeto en la canalización.**
```
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema = New-DDBTableSchema
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
**Ejemplo 2: Añade una nueva definición de índice secundario local al TableSchema objeto suministrado antes de volver a escribir el TableSchema objeto en la canalización. El TableSchema objeto también se puede proporcionar mediante el parámetro -Scheme.**
```
New-DDBTableSchema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
+ Para obtener información sobre la API, consulte [Add- DDBIndex Schema](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Add-DDBKeySchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-DDBKeySchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío y le añade entradas de definición de claves y atributos utilizando los datos clave especificados antes de escribir el TableSchema objeto en la canalización. El tipo de clave se declara «HASH» de forma predeterminada; utilice el KeyType parámetro - con el valor «RANGE» para declarar una clave de rango.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
**Ejemplo 2: añade nuevas entradas de definición de atributos y claves al TableSchema objeto suministrado antes de escribir el TableSchema objeto en la canalización. El tipo de clave se declara «HASH» de forma predeterminada; utilice el KeyType parámetro - con el valor «RANGE» para declarar una clave de rango. El TableSchema objeto también se puede proporcionar mediante el parámetro -Scheme.**
```
New-DDBTableSchema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
+ Para obtener información sobre la API, consulte [Add- DDBKey Schema](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `ConvertFrom-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `ConvertFrom-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: ConvertFrom - DDBItem se usa para convertir el resultado de Get-DDBItem una tabla hash de AttributeValues DynamoDB en una tabla hash de tipos comunes como string y double.**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener más información sobre la API, consulte [ConvertFrom- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet* Reference (V5).
### `ConvertTo-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `ConvertTo-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Ejemplo de conversión de una tabla hash en un diccionario de valores de atributos de DynamoDB.**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Key Value
--- -----
SongTitle Amazon.DynamoDBv2.Model.AttributeValue
Artist Amazon.DynamoDBv2.Model.AttributeValue
```
**Ejemplo 2: Ejemplo de conversión de una tabla hash en un diccionario de valores de atributos de DynamoDB.**
```
@{
MyMap = @{
MyString = 'my string'
}
MyStringSet = [System.Collections.Generic.HashSet[String]]@('my', 'string')
MyNumericSet = [System.Collections.Generic.HashSet[Int]]@(1, 2, 3)
MyBinarySet = [System.Collections.Generic.HashSet[System.IO.MemoryStream]]@(
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('my'))),
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('string')))
)
MyList1 = @('my', 'string')
MyList2 = [System.Collections.Generic.List[Int]]@(1, 2)
MyList3 = [System.Collections.ArrayList]@('one', 2, $true)
} | ConvertTo-DDBItem
```
**Salida:**
```
Key Value
--- -----
MyStringSet Amazon.DynamoDBv2.Model.AttributeValue
MyList1 Amazon.DynamoDBv2.Model.AttributeValue
MyNumericSet Amazon.DynamoDBv2.Model.AttributeValue
MyList2 Amazon.DynamoDBv2.Model.AttributeValue
MyBinarySet Amazon.DynamoDBv2.Model.AttributeValue
MyMap Amazon.DynamoDBv2.Model.AttributeValue
MyList3 Amazon.DynamoDBv2.Model.AttributeValue
```
+ Para obtener más información sobre la API, consulte [ConvertTo- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Get-DDBBatchItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBBatchItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Obtiene el elemento SongTitle «Somewhere Down The Road» de las tablas «Music» y «Songs» de DynamoDB.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$keysAndAttributes = New-Object Amazon.DynamoDBv2.Model.KeysAndAttributes
$list = New-Object 'System.Collections.Generic.List[System.Collections.Generic.Dictionary[String, Amazon.DynamoDBv2.Model.AttributeValue]]'
$list.Add($key)
$keysAndAttributes.Keys = $list
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
'Songs' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
}
$batchItems = Get-DDBBatchItem -RequestItem $requestItem
$batchItems.GetEnumerator() | ForEach-Object {$PSItem.Value} | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [BatchGetItem](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve el elemento de DynamoDB con la clave de partición y la SongTitle clave de clasificación Artist.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
SongTitle Somewhere Down The Road
Price 1.94
Artist No One You Know
CriticRating 9
AlbumTitle Somewhat Famous
```
+ Para obtener más información sobre la API, consulte [GetItem Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve información detallada de la tabla especificada.**
```
Get-DDBTable -TableName "myTable"
```
+ Para obtener más información sobre la API, consulte [DescribeTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-DDBTableList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-DDBTableList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve los detalles de todas las tablas y se itera automáticamente hasta que el servicio indique que no existen más tablas.**
```
Get-DDBTableList
```
+ Para obtener más información sobre la API, consulte [ListTables](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Invoke-DDBQuery`
En el siguiente ejemplo de código, se muestra cómo utilizar `Invoke-DDBQuery`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Invoca una consulta que devuelve elementos de DynamoDB con el identificador y el artista especificados. SongTitle **
```
$invokeDDBQuery = @{
TableName = 'Music'
KeyConditionExpression = ' SongTitle = :SongTitle and Artist = :Artist'
ExpressionAttributeValues = @{
':SongTitle' = 'Somewhere Down The Road'
':Artist' = 'No One You Know'
} | ConvertTo-DDBItem
}
Invoke-DDBQuery @invokeDDBQuery | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener detalles de la API, consulte [Query](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Invoke-DDBScan`
En el siguiente ejemplo de código, se muestra cómo utilizar `Invoke-DDBScan`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve todos los elementos de la tabla Music.**
```
Invoke-DDBScan -TableName 'Music' | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
Genre Country
Artist No One You Know
Price 1.98
CriticRating 8.4
SongTitle My Dog Spot
AlbumTitle Hey Now
```
**Ejemplo 2: Devuelve los elementos de la tabla Música con un valor CriticRating mayor o igual a nueve.**
```
$scanFilter = @{
CriticRating = [Amazon.DynamoDBv2.Model.Condition]@{
AttributeValueList = @(@{N = '9'})
ComparisonOperator = 'GE'
}
}
Invoke-DDBScan -TableName 'Music' -ScanFilter $scanFilter | ConvertFrom-DDBItem
```
**Salida:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obtener detalles de la API, consulte [Scan](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `New-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DDBTable`.
**Herramientas para la PowerShell versión 5**
**Ejemplo 1: En este ejemplo se crea una tabla denominada Thread que tiene una clave principal compuesta por «ForumName» (tipo clave hash) y «Subject» (rango de tipos de clave). El esquema utilizado para construir la tabla se puede canalizar hacia cada cmdlet tal como se muestra o se especifica con el parámetro -Schema.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyType RANGE -KeyDataType "S"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {}
```
**Ejemplo 2: en este ejemplo se crea una tabla denominada Thread que tiene una clave principal compuesta por «ForumName» (tipo hash de clave) y «Asunto» (rango de tipos de clave). También se define un índice secundario local. La clave del índice secundario local se establecerá automáticamente a partir de la clave hash principal de la tabla (ForumName). El esquema utilizado para construir la tabla se puede canalizar hacia cada cmdlet tal como se muestra o se especifica con el parámetro -Schema.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S"
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
**Ejemplo 3: En este ejemplo se muestra cómo utilizar una canalización única para crear una tabla denominada Thread que tenga una clave principal compuesta por «ForumName» (hash de tipo de clave) y «Asunto» (rango de tipos de clave) y un índice secundario local. Los comandos Add- DDBKey DDBIndex Schema y Add-Schema crean un TableSchema objeto nuevo si no lo proporcionan la canalización o el parámetro -Scheme.**
```
New-DDBTableSchema |
Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S" |
Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S" |
Add-DDBIndexSchema -IndexName "LastPostIndex" `
-RangeKeyName "LastPostDateTime" `
-RangeKeyDataType "S" `
-ProjectionType "keys_only" |
New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**Salida:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
+ Para obtener más información sobre la API, consulte [CreateTable Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-DDBTableSchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-DDBTableSchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un TableSchema objeto vacío listo para aceptar definiciones de claves e índices para su uso en la creación de una nueva tabla de Amazon DynamoDB. El objeto devuelto puede canalizarse a los DDBTable cmdlets Add- DDBKey Schema, Add- DDBIndex Schema y New- o pasarse a ellos mediante el parámetro -Scheme de cada cmdlet.**
```
New-DDBTableSchema
```
**Salida:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{} {} {}
```
+ *Para obtener información sobre la API, consulte [New- DDBTable Schema](https://docs.aws.amazon.com/powershell/v5/reference) in Herramientas de AWS para PowerShell Cmdlet Reference (V5).*
### `Remove-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina el elemento DynamoDB que coincide con la clave proporcionada.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false
```
+ Para obtener más información sobre la API, consulte [DeleteItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina la tabla especificada. Se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-DDBTable -TableName "myTable"
```
**Ejemplo 2: elimina la tabla especificada. No se le solicitará una confirmación antes de continuar con la operación.**
```
Remove-DDBTable -TableName "myTable" -Force
```
+ Para obtener más información sobre la API, consulte [DeleteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-DDBBatchItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-DDBBatchItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un nuevo elemento o sustituye un elemento existente por uno nuevo en las tablas Music y Songs de DynamoDB.**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 10.0
} | ConvertTo-DDBItem
$writeRequest = New-Object Amazon.DynamoDBv2.Model.WriteRequest
$writeRequest.PutRequest = [Amazon.DynamoDBv2.Model.PutRequest]$item
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
'Songs' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
}
Set-DDBBatchItem -RequestItem $requestItem
```
+ Para obtener más información sobre la API, consulte [BatchWriteItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea un nuevo elemento o sustituye un elemento existente por uno nuevo.**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 9.0
} | ConvertTo-DDBItem
Set-DDBItem -TableName 'Music' -Item $item
```
+ Para obtener más información sobre la API, consulte [PutItem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-DDBItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DDBItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Establece el atributo de género en «Rap» en el elemento de DynamoDB con la clave de partición y la SongTitle clave de clasificación Artist.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$updateDdbItem = @{
TableName = 'Music'
Key = $key
UpdateExpression = 'set Genre = :val1'
ExpressionAttributeValue = (@{
':val1' = ([Amazon.DynamoDBv2.Model.AttributeValue]'Rap')
})
}
Update-DDBItem @updateDdbItem
```
**Salida:**
```
Name Value
---- -----
Genre Rap
```
+ Para obtener más información sobre la API, consulte [UpdateItem Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Update-DDBTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-DDBTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: actualiza el rendimiento aprovisionado de la tabla en cuestión.**
```
Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5
```
+ Para obtener más información sobre la API, consulte [UpdateTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon EC2 con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon EC2.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-EC2CapacityReservation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EC2CapacityReservation`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva reserva de capacidad con los atributos especificados.**
```
Add-EC2CapacityReservation -InstanceType m4.xlarge -InstanceCount 2 -AvailabilityZone eu-west-1b -EbsOptimized True -InstancePlatform Windows
```
**Salida:**
```
AvailabilityZone : eu-west-1b
AvailableInstanceCount : 2
CapacityReservationId : cr-0c1f2345db6f7cdba
CreateDate : 3/28/2019 9:29:41 AM
EbsOptimized : True
EndDate : 1/1/0001 12:00:00 AM
EndDateType : unlimited
EphemeralStorage : False
InstanceMatchCriteria : open
InstancePlatform : Windows
InstanceType : m4.xlarge
State : active
Tags : {}
Tenancy : default
TotalInstanceCount : 2
```
+ Para obtener más información sobre la API, consulte [CreateCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-EC2InternetGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EC2InternetGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la puerta de enlace de Internet especificada a la VPC especificada.**
```
Add-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
**Ejemplo 2: En este ejemplo se crean una VPC y una puerta de enlace de Internet y, a continuación, se asocia la puerta de enlace de Internet a la VPC.**
```
$vpc = New-EC2Vpc -CidrBlock 10.0.0.0/16
New-EC2InternetGateway | Add-EC2InternetGateway -VpcId $vpc.VpcId
```
+ Para obtener más información sobre la API, consulte [AttachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-EC2NetworkInterface`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EC2NetworkInterface`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la interfaz de red especificada a la instancia especificada.**
```
Add-EC2NetworkInterface -NetworkInterfaceId eni-12345678 -InstanceId i-1a2b3c4d -DeviceIndex 1
```
**Salida:**
```
eni-attach-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [AttachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-EC2Volume`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EC2Volume`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia el volumen especificado a la instancia especificada y se expone con el nombre de dispositivo especificado.**
```
Add-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
**Salida:**
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : attaching
VolumeId : vol-12345678
```
+ Para obtener más información sobre la API, consulte [AttachVolume Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Add-EC2VpnGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EC2VpnGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la puerta de enlace privada virtual especificada a la VPC especificada.**
```
Add-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
**Salida:**
```
State VpcId
----- -----
attaching vpc-12345678
```
+ Para obtener más información sobre la API, consulte [AttachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Approve-EC2VpcPeeringConnection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Approve-EC2VpcPeeringConnection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo aprueba el pcx-1dfad234b56ff78be solicitado VpcPeeringConnectionId **
```
Approve-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-1dfad234b56ff78be
```
**Salida:**
```
AccepterVpcInfo : Amazon.EC2.Model.VpcPeeringConnectionVpcInfo
ExpirationTime : 1/1/0001 12:00:00 AM
RequesterVpcInfo : Amazon.EC2.Model.VpcPeeringConnectionVpcInfo
Status : Amazon.EC2.Model.VpcPeeringConnectionStateReason
Tags : {}
VpcPeeringConnectionId : pcx-1dfad234b56ff78be
```
+ *Para obtener información sobre la API, consulte Cmdlet Reference (V5). [AcceptVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Confirm-EC2ProductInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Confirm-EC2ProductInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se determina si el código de producto especificado está asociado a la instancia especificada.**
```
Confirm-EC2ProductInstance -ProductCode 774F4FF8 -InstanceId i-12345678
```
+ Para obtener más información sobre la API, consulte [ConfirmProductInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Copy-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Copy-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se copia la AMI especificada de la región “UE (Irlanda)” en la región “Oeste de EE. UU. (Oregón)”. Si no se especifica -Region, la región predeterminada actual se utiliza como región de destino.**
```
Copy-EC2Image -SourceRegion eu-west-1 -SourceImageId ami-12345678 -Region us-west-2 -Name "Copy of ami-12345678"
```
**Salida:**
```
ami-87654321
```
+ Para obtener más información sobre la API, consulte [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Copy-EC2Snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Copy-EC2Snapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se copia la instantánea especificada de la región “UE (Irlanda)” en la región “Oeste de EE. UU. (Oregón)”.**
```
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678 -Region us-west-2
```
**Ejemplo 2: Si establece una región predeterminada y omite el parámetro Region, la región de destino predeterminada será la región predeterminada.**
```
Set-DefaultAWSRegion us-west-2
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678
```
+ Para obtener más información sobre la API, consulte [CopySnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Deny-EC2VpcPeeringConnection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Deny-EC2VpcPeeringConnection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El ejemplo anterior deniega la solicitud del identificador de solicitud VpcPeering pcx-01a2b3ce45fe67eb8**
```
Deny-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-01a2b3ce45fe67eb8
```
+ *Para obtener información [RejectVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)sobre Herramientas de AWS para PowerShell la API, consulte* Cmdlet Reference (V5).
### `Disable-EC2VgwRoutePropagation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-EC2VgwRoutePropagation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo impide que el VGW propague automáticamente las rutas a la tabla de enrutamiento especificada.**
```
Disable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DisableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-EC2VpcClassicLink`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-EC2VpcClassicLink`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo se desactiva EC2 VpcClassicLink para el vpc-01e23c4a5d6db78e9. Devuelve True o False.**
```
Disable-EC2VpcClassicLink -VpcId vpc-01e23c4a5d6db78e9
```
+ *Herramientas de AWS para PowerShell Para obtener más información [DisableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)sobre la API, consulte Cmdlet Reference (V5).*
### `Disable-EC2VpcClassicLinkDnsSupport`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-EC2VpcClassicLinkDnsSupport`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo deshabilita la compatibilidad con ClassicLink DNS para el vpc-0b12d3456a7e8910d**
```
Disable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d
```
+ *Para obtener más información [DisableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)sobre Herramientas de AWS para PowerShell la API, consulte Cmdlet Reference (V5).*
### `Dismount-EC2InternetGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-EC2InternetGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desvincula la puerta de enlace de Internet especificada a la VPC específica.**
```
Dismount-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
+ Para obtener más información sobre la API, consulte [DetachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-EC2NetworkInterface`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-EC2NetworkInterface`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la conexión especificada entre una interfaz de red y una instancia.**
```
Dismount-EC2NetworkInterface -AttachmentId eni-attach-1a2b3c4d -Force
```
+ Para obtener más información sobre la API, consulte [DetachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-EC2Volume`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-EC2Volume`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desconecta el volumen especificado.**
```
Dismount-EC2Volume -VolumeId vol-12345678
```
**Salida:**
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : detaching
VolumeId : vol-12345678
```
**Ejemplo 2: También puede especificar el ID de la instancia y el nombre del dispositivo para asegurarse de que está desconectando el volumen correcto.**
```
Dismount-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
+ Para obtener más información sobre la API, consulte [DetachVolume](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-EC2VpnGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-EC2VpnGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desvincula la puerta de enlace privada virtual especificada de la VPC especificada.**
```
Dismount-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
+ Para obtener más información sobre la API, consulte [DetachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2CapacityReservation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2CapacityReservation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo modifica el CapacityReservationId cr-0c1f2345db6f7cdba cambiando el recuento de instancias a 1**
```
Edit-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba -InstanceCount 1
```
**Salida:**
```
True
```
+ Para obtener más [ModifyCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)información sobre *Herramientas de AWS para PowerShell la API, consulte Cmdlet Reference (V5*).
### `Edit-EC2Host`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2Host`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo modifica la AutoPlacement configuración a desactivada para el host dedicado h-01e23f4cd567890f3**
```
Edit-EC2Host -HostId h-03e09f8cd681609f3 -AutoPlacement off
```
**Salida:**
```
Successful Unsuccessful
---------- ------------
{h-01e23f4cd567890f3} {}
```
+ *Para obtener más [ModifyHosts](https://docs.aws.amazon.com/powershell/v5/reference)información sobre Herramientas de AWS para PowerShell la API*, consulte Cmdlet Reference (V5).
### `Edit-EC2IdFormat`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2IdFormat`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita el formato de ID largo para el recurso especificado.**
```
Edit-EC2IdFormat -Resource instance -UseLongId $true
```
**Ejemplo 2: En este ejemplo se deshabilita el formato de ID largo para el recurso especificado.**
```
Edit-EC2IdFormat -Resource instance -UseLongId $false
```
+ Para obtener más información sobre la API, consulte [ModifyIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2ImageAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2ImageAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza la descripción de la AMI especificada.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Description "New description"
```
**Ejemplo 2: en este ejemplo se hace pública la AMI (por ejemplo, para que cualquiera Cuenta de AWS pueda utilizarla).**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserGroup all
```
**Ejemplo 3: En este ejemplo se hace privada la AMI (por ejemplo, para que solo usted, como propietario, pueda utilizarla).**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserGroup all
```
**Ejemplo 4: en este ejemplo se concede el permiso de lanzamiento a la persona especificada Cuenta de AWS.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserId 111122223333
```
**Ejemplo 5: Este ejemplo elimina el permiso de lanzamiento del especificado Cuenta de AWS.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserId 111122223333
```
+ Para obtener más información sobre la API, consulte [ModifyImageAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Edit-EC2InstanceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2InstanceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifica el tipo de instancia de la instancia especificada.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceType m3.medium
```
**Ejemplo 2: Este ejemplo permite mejorar las redes para la instancia especificada, especificando «simple» como el valor del parámetro de soporte de red de I/O virtualización de raíz única (SR-IOV), -.. SriovNetSupport**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SriovNetSupport "simple"
```
**Ejemplo 3: En este ejemplo se modifican los grupos de seguridad para la instancia especificada. La instancia debe encontrarse en una VPC. Debe especificar el ID de cada grupo de seguridad, no su nombre.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -Group @( "sg-12345678", "sg-45678901" )
```
**Ejemplo 4: Este ejemplo permite la I/O optimización de EBS para la instancia especificada. Esta característica no está disponible con todos los tipos de instancia. Se aplicarán cargos por uso adicionales al utilizar una instancia optimizada para EBS.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -EbsOptimized $true
```
**Ejemplo 5: Este ejemplo permite source/destination comprobar la instancia especificada. Para que una instancia de NAT se ejecute, el valor debe ser “false”.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SourceDestCheck $true
```
**Ejemplo 6: En este ejemplo se deshabilita la terminación de la instancia especificada.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -DisableApiTermination $true
```
**Ejemplo 7: En este ejemplo se cambia la instancia especificada para que termine cuando se inicie el cierre desde la instancia.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceInitiatedShutdownBehavior terminate
```
+ Para obtener más información sobre la API, consulte [ModifyInstanceAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Edit-EC2InstanceCreditSpecification`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2InstanceCreditSpecification`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Esto habilita créditos ilimitados de T2, por ejemplo, i-01234567890abcdef.**
```
$Credit = New-Object -TypeName Amazon.EC2.Model.InstanceCreditSpecificationRequest
$Credit.InstanceId = "i-01234567890abcdef"
$Credit.CpuCredits = "unlimited"
Edit-EC2InstanceCreditSpecification -InstanceCreditSpecification $Credit
```
+ Para obtener más información sobre la API, consulte [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2NetworkInterfaceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2NetworkInterfaceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifica la interfaz de red especificada para que la conexión especificada se elimine al terminar.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Attachment_AttachmentId eni-attach-1a2b3c4d -Attachment_DeleteOnTermination $true
```
**Ejemplo 2: En este ejemplo se modifica la descripción de la interfaz de red especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Description "my description"
```
**Ejemplo 3: En este ejemplo se modifica el grupo de seguridad de la interfaz de red especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Groups sg-1a2b3c4d
```
**Ejemplo 4: En este ejemplo se deshabilita la source/destination comprobación de la interfaz de red especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck $false
```
+ Para obtener más información sobre la API, consulte [ModifyNetworkInterfaceAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Edit-EC2ReservedInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2ReservedInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifica la zona de disponibilidad, el número de instancias y la plataforma de las instancias reservadas especificadas.**
```
$config = New-Object Amazon.EC2.Model.ReservedInstancesConfiguration
$config.AvailabilityZone = "us-west-2a"
$config.InstanceCount = 1
$config.Platform = "EC2-VPC"
Edit-EC2ReservedInstance `
-ReservedInstancesId @("FE32132D-70D5-4795-B400-AE435EXAMPLE", "0CC556F3-7AB8-4C00-B0E5-98666EXAMPLE") `
-TargetConfiguration $config
```
+ Para obtener más información sobre la API, consulte [ModifyReservedInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2SnapshotAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2SnapshotAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo, se hace pública la instantánea especificada mediante la configuración de su CreateVolumePermission atributo.**
```
Edit-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission -OperationType Add -GroupName all
```
+ Para obtener más información sobre la API, consulte [ModifySnapshotAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Edit-EC2SpotFleetRequest`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2SpotFleetRequest`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza la capacidad de destino de la solicitud de flota de spot especificada.**
```
Edit-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TargetCapacity 10
```
**Salida:**
```
True
```
+ Para obtener más información sobre la API, consulte [ModifySpotFleetRequest](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2SubnetAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2SubnetAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita el direccionamiento IP público para la subred especificada.**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $true
```
**Ejemplo 2: En este ejemplo se deshabilita el direccionamiento IP público para la subred especificada.**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $false
```
+ Para obtener más información sobre la API, consulte [ModifySubnetAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-EC2VolumeAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2VolumeAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo modifica el atributo especificado del volumen especificado. I/O Las operaciones del volumen se reanudan automáticamente tras su suspensión debido a la posible incoherencia de los datos**.
```
Edit-EC2VolumeAttribute -VolumeId vol-12345678 -AutoEnableIO $true
```
+ Para obtener más información sobre la API, consulte [ModifyVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (V5)*.
### `Edit-EC2VpcAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EC2VpcAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la compatibilidad con los nombres de host DNS para la VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $true
```
**Ejemplo 2: En este ejemplo se deshabilita la compatibilidad con los nombres de host DNS para la VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $false
```
**Ejemplo 3: En este ejemplo se habilita la compatibilidad con la resolución DNS para la VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $true
```
**Ejemplo 4: En este ejemplo se deshabilita la compatibilidad con la resolución DNS para la VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $false
```
+ Para obtener más información sobre la API, consulte [ModifyVpcAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-EC2VgwRoutePropagation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-EC2VgwRoutePropagation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo impide que el VGW especificado propague automáticamente las rutas a la tabla de enrutamiento especificada.**
```
Enable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [EnableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-EC2VolumeIO`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-EC2VolumeIO`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo habilita I/O las operaciones para el volumen especificado, si I/O las operaciones estaban deshabilitadas.**
```
Enable-EC2VolumeIO -VolumeId vol-12345678
```
+ Para obtener más información sobre la API, consulte [EnableVolumeIo Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Enable-EC2VpcClassicLink`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-EC2VpcClassicLink`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo habilita la VPC vpc-0123456b789b0d12f para ClassicLink**
```
Enable-EC2VpcClassicLink -VpcId vpc-0123456b789b0d12f
```
**Salida:**
```
True
```
+ *Para obtener información sobre la API, consulte Cmdlet Reference (V5). [EnableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Enable-EC2VpcClassicLinkDnsSupport`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-EC2VpcClassicLinkDnsSupport`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo permite que vpc-0b12d3456a7e8910d admita la resolución de nombres de host DNS para ClassicLink**
```
Enable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
+ Para obtener más [EnableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)información sobre *Herramientas de AWS para PowerShell la API, consulte Cmdlet Reference (V5)*.
### `Get-EC2AccountAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2AccountAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe si se pueden lanzar instancias en EC2-Classic y EC2-VPC en la región o solo en EC2-VPC.**
```
(Get-EC2AccountAttribute -AttributeName supported-platforms).AttributeValues
```
**Salida:**
```
AttributeValue
--------------
EC2
VPC
```
**Ejemplo 2: En este ejemplo se describe la VPC predeterminada; es “none” si no tiene una VPC predeterminada en la región.**
```
(Get-EC2AccountAttribute -AttributeName default-vpc).AttributeValues
```
**Salida:**
```
AttributeValue
--------------
vpc-12345678
```
**Ejemplo 3: En este ejemplo se describe el número máximo de instancias bajo demanda que puede ejecutar.**
```
(Get-EC2AccountAttribute -AttributeName max-instances).AttributeValues
```
**Salida:**
```
AttributeValue
--------------
20
```
+ Para obtener más información sobre la API, consulte [DescribeAccountAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Address`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Address`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la dirección IP elástica especificada para las instancias de EC2-Classic.**
```
Get-EC2Address -AllocationId eipalloc-12345678
```
**Salida:**
```
AllocationId : eipalloc-12345678
AssociationId : eipassoc-12345678
Domain : vpc
InstanceId : i-87654321
NetworkInterfaceId : eni-12345678
NetworkInterfaceOwnerId : 12345678
PrivateIpAddress : 10.0.2.172
PublicIp : 198.51.100.2
```
**Ejemplo 2: En este ejemplo se describen las direcciones IP elásticas para las instancias de una VPC. Esta sintaxis requiere la PowerShell versión 3 o posterior.**
```
Get-EC2Address -Filter @{ Name="domain";Values="vpc" }
```
**Ejemplo 3: En este ejemplo se describe la dirección IP elástica especificada para las instancias de EC2-Classic.**
```
Get-EC2Address -PublicIp 203.0.113.17
```
**Salida:**
```
AllocationId :
AssociationId :
Domain : standard
InstanceId : i-12345678
NetworkInterfaceId :
NetworkInterfaceOwnerId :
PrivateIpAddress :
PublicIp : 203.0.113.17
```
**Ejemplo 4: En este ejemplo se describen las direcciones IP elásticas para las instancias de EC2-Classic. Esta sintaxis requiere PowerShell la versión 3 o posterior.**
```
Get-EC2Address -Filter @{ Name="domain";Values="standard" }
```
**Ejemplo 5: En este ejemplo se describen todas las direcciones IP elásticas.**
```
Get-EC2Address
```
**Ejemplo 6: En este ejemplo se devuelve la IP pública y privada del identificador de instancia proporcionado en el filtro.**
```
Get-EC2Address -Region eu-west-1 -Filter @{Name="instance-id";Values="i-0c12d3f4f567ffb89"} | Select-Object PrivateIpAddress, PublicIp
```
**Salida:**
```
PrivateIpAddress PublicIp
---------------- --------
10.0.0.99 63.36.5.227
```
**Ejemplo 7: Este ejemplo recupera todo el Elastic IPs con su identificador de asignación, identificador de asociación e identificador de instancia**
```
Get-EC2Address -Region eu-west-1 | Select-Object InstanceId, AssociationId, AllocationId, PublicIp
```
**Salida:**
```
InstanceId AssociationId AllocationId PublicIp
---------- ------------- ------------ --------
eipalloc-012e3b456789e1fad 17.212.120.178
i-0c123dfd3415bac67 eipassoc-0e123456bb7890bdb eipalloc-01cd23ebf45f7890c 17.212.124.77
eipalloc-012345678eeabcfad 17.212.225.7
i-0123d405c67e89a0c eipassoc-0c123b456783966ba eipalloc-0123cdd456a8f7892 37.216.52.173
i-0f1bf2f34c5678d09 eipassoc-0e12934568a952d96 eipalloc-0e1c23e4d5e6789e4 37.218.222.278
i-012e3cb4df567e8aa eipassoc-0d1b2fa4d67d03810 eipalloc-0123f456f78a01b58 37.210.82.27
i-0123bcf4b567890e1 eipassoc-01d2345f678903fb1 eipalloc-0e1db23cfef5c45c7 37.215.222.270
```
**Ejemplo 8: En este ejemplo se obtiene la lista de direcciones IP de EC2 que coinciden con la clave de etiqueta “Category” con el valor “Prod”.**
```
Get-EC2Address -Filter @{Name="tag:Category";Values="Prod"}
```
**Salida:**
```
AllocationId : eipalloc-0123f456f81a01b58
AssociationId : eipassoc-0d1b23a456d103810
CustomerOwnedIp :
CustomerOwnedIpv4Pool :
Domain : vpc
InstanceId : i-012e3cb4df567e1aa
NetworkBorderGroup : eu-west-1
NetworkInterfaceId : eni-0123f41d5a60d5f40
NetworkInterfaceOwnerId : 123456789012
PrivateIpAddress : 192.168.1.84
PublicIp : 34.250.81.29
PublicIpv4Pool : amazon
Tags : {Category, Name}
```
+ Para obtener más información sobre la API, consulte [DescribeAddresses Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-EC2AvailabilityZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2AvailabilityZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las zonas de disponibilidad de la región actual que están disponibles.**
```
Get-EC2AvailabilityZone
```
**Salida:**
```
Messages RegionName State ZoneName
-------- ---------- ----- --------
{} us-west-2 available us-west-2a
{} us-west-2 available us-west-2b
{} us-west-2 available us-west-2c
```
**Ejemplo 2: En este ejemplo se describe cualquier zona de disponibilidad que se encuentre en un estado dañado. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
Get-EC2AvailabilityZone -Filter @{ Name="state";Values="impaired" }
```
**Ejemplo 3: Con la PowerShell versión 2, debe usar New-Object para crear el filtro.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = "impaired"
Get-EC2AvailabilityZone -Filter $filter
```
+ Para obtener más información sobre la API, consulte [DescribeAvailabilityZones Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2BundleTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2BundleTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la tarea de agrupación especificada.**
```
Get-EC2BundleTask -BundleId bun-12345678
```
**Ejemplo 2: En este ejemplo se describen las tareas del agrupación cuyo estado es “completado” o “con error”.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "complete", "failed" )
Get-EC2BundleTask -Filter $filter
```
+ Para obtener más información sobre la API, consulte [DescribeBundleTasks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2CapacityReservation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2CapacityReservation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe una o varias de sus reservas de capacidad para la región.**
```
Get-EC2CapacityReservation -Region eu-west-1
```
**Salida:**
```
AvailabilityZone : eu-west-1b
AvailableInstanceCount : 2
CapacityReservationId : cr-0c1f2345db6f7cdba
CreateDate : 3/28/2019 9:29:41 AM
EbsOptimized : True
EndDate : 1/1/0001 12:00:00 AM
EndDateType : unlimited
EphemeralStorage : False
InstanceMatchCriteria : open
InstancePlatform : Windows
InstanceType : m4.xlarge
State : active
Tags : {}
Tenancy : default
TotalInstanceCount : 2
```
+ Para obtener más información sobre la API, consulte [DescribeCapacityReservations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2ConsoleOutput`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ConsoleOutput`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene la salida de la consola para la instancia de Linux especificada. La salida de la consola está codificada.**
```
Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456
```
**Salida:**
```
InstanceId Output
---------- ------
i-0e194d3c47c123637 WyAgICAwLjAwMDAwMF0gQ29tbW...bGU9dHR5UzAgc2Vs
```
**Ejemplo 2: Este ejemplo almacena la salida de la consola codificada en una variable y, a continuación, la descodifica.**
```
$Output_encoded = (Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456).Output
[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Output_encoded))
```
+ Para obtener más información sobre la API, consulte [GetConsoleOutput](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2CustomerGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2CustomerGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la puerta de enlace de cliente especificada.**
```
Get-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**Salida:**
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
**Ejemplo 2: En este ejemplo se describen todas las puertas de enlace de cliente cuyo estado sea pendiente o disponible.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2CustomerGateway -Filter $filter
```
**Ejemplo 3: En este ejemplo se describen sus puertas de enlace de cliente.**
```
Get-EC2CustomerGateway
```
+ Para obtener más información sobre la API, consulte [DescribeCustomerGateways](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2DhcpOption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2DhcpOption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los conjuntos de opciones de DHCP.**
```
Get-EC2DhcpOption
```
**Salida:**
```
DhcpConfigurations DhcpOptionsId Tag
------------------ ------------- ---
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
{domain-name-servers} dopt-3a4b5c6d {}
```
**Ejemplo 2: En este ejemplo se obtienen los detalles de configuración del conjunto de opciones de DHCP especificado.**
```
(Get-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d).DhcpConfigurations
```
**Salida:**
```
Key Values
--- ------
domain-name {abc.local}
domain-name-servers {10.0.0.101, 10.0.0.102}
```
+ Para obtener más información sobre la API, consulte [DescribeDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2FlowLog`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2FlowLog`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen uno o más registros de flujo con el tipo de destino de registro “s3”.**
```
Get-EC2FlowLog -Filter @{Name="log-destination-type";Values="s3"}
```
**Salida:**
```
CreationTime : 2/25/2019 9:07:36 PM
DeliverLogsErrorMessage :
DeliverLogsPermissionArn :
DeliverLogsStatus : SUCCESS
FlowLogId : fl-01b2e3d45f67f8901
FlowLogStatus : ACTIVE
LogDestination : arn:aws:s3:::amzn-s3-demo-bucket-dd-tata
LogDestinationType : s3
LogGroupName :
ResourceId : eni-01d2dda3456b7e890
TrafficType : ALL
```
+ Para obtener más información sobre la API, consulte [DescribeFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Host`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Host`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelven los detalles del host de EC2.**
```
Get-EC2Host
```
**Salida:**
```
AllocationTime : 3/23/2019 4:55:22 PM
AutoPlacement : off
AvailabilityZone : eu-west-1b
AvailableCapacity : Amazon.EC2.Model.AvailableCapacity
ClientToken :
HostId : h-01e23f4cd567890f1
HostProperties : Amazon.EC2.Model.HostProperties
HostReservationId :
Instances : {}
ReleaseTime : 1/1/0001 12:00:00 AM
State : available
Tags : {}
```
**Ejemplo 2: En este ejemplo se consulta el servidor AvailableInstanceCapacity h-01e23f4cd567899f1**
```
Get-EC2Host -HostId h-01e23f4cd567899f1 | Select-Object -ExpandProperty AvailableCapacity | Select-Object -expand AvailableInstanceCapacity
```
**Salida:**
```
AvailableCapacity InstanceType TotalCapacity
----------------- ------------ -------------
11 m4.xlarge 11
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5). [DescribeHosts](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Get-EC2HostReservationOffering`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2HostReservationOffering`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las reservas de hosts dedicados que se pueden adquirir para el filtro «familia de instancias» determinado, donde está «» PaymentOption NoUpfront**
```
Get-EC2HostReservationOffering -Filter @{Name="instance-family";Values="m4"} | Where-Object PaymentOption -eq NoUpfront
```
**Salida:**
```
CurrencyCode :
Duration : 94608000
HourlyPrice : 1.307
InstanceFamily : m4
OfferingId : hro-0c1f234567890d9ab
PaymentOption : NoUpfront
UpfrontPrice : 0.000
CurrencyCode :
Duration : 31536000
HourlyPrice : 1.830
InstanceFamily : m4
OfferingId : hro-04ad12aaaf34b5a67
PaymentOption : NoUpfront
UpfrontPrice : 0.000
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeHostReservationOfferings](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EC2HostReservationPurchasePreview`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2HostReservationPurchasePreview`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene una vista previa de una compra de reserva con configuraciones que coinciden con las de su host dedicado h-01e23f4cd567890f1.**
```
Get-EC2HostReservationPurchasePreview -OfferingId hro-0c1f23456789d0ab -HostIdSet h-01e23f4cd567890f1
```
**Salida:**
```
CurrencyCode Purchase TotalHourlyPrice TotalUpfrontPrice
------------ -------- ---------------- -----------------
{} 1.307 0.000
```
+ Para obtener más información sobre la API, consulte [GetHostReservationPurchasePreview](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2IdFormat`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2IdFormat`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el formato de ID del tipo de recurso especificado.**
```
Get-EC2IdFormat -Resource instance
```
**Salida:**
```
Resource UseLongIds
-------- ----------
instance False
```
**Ejemplo 2: en este ejemplo se describen los formatos de ID de todos los tipos de recursos que admiten versiones más largas IDs.**
```
Get-EC2IdFormat
```
**Salida:**
```
Resource UseLongIds
-------- ----------
reservation False
instance False
```
+ Para obtener información sobre la API, consulte [DescribeIdFormat Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-EC2IdentityIdFormat`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2IdentityIdFormat`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve el formato de ID del recurso “image” para el rol especificado.**
```
Get-EC2IdentityIdFormat -PrincipalArn arn:aws:iam::123456789511:role/JDBC -Resource image
```
**Salida:**
```
Deadline Resource UseLongIds
-------- -------- ----------
8/2/2018 11:30:00 PM image True
```
+ Para obtener más información sobre la API, consulte [DescribeIdentityIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la AMI especificada.**
```
Get-EC2Image -ImageId ami-12345678
```
**Salida:**
```
Architecture : x86_64
BlockDeviceMappings : {/dev/xvda}
CreationDate : 2014-10-20T00:56:28.000Z
Description : My image
Hypervisor : xen
ImageId : ami-12345678
ImageLocation : 123456789012/my-image
ImageOwnerAlias :
ImageType : machine
KernelId :
Name : my-image
OwnerId : 123456789012
Platform :
ProductCodes : {}
Public : False
RamdiskId :
RootDeviceName : /dev/xvda
RootDeviceType : ebs
SriovNetSupport : simple
State : available
StateReason :
Tags : {Name}
VirtualizationType : hvm
```
**Ejemplo 2: En este ejemplo se describe lo AMIs que tienes.**
```
Get-EC2Image -owner self
```
**Ejemplo 3: En este ejemplo se describe el público AMIs que ejecuta Microsoft Windows Server.**
```
Get-EC2Image -Filter @{ Name="platform"; Values="windows" }
```
**Ejemplo 4: En este ejemplo se describen todos los públicos AMIs de la región «us-west-2".**
```
Get-EC2Image -Region us-west-2
```
+ Para obtener más información sobre la API, consulte [DescribeImages Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2ImageAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ImageAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene la descripción de la AMI especificada.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute description
```
**Salida:**
```
BlockDeviceMappings : {}
Description : My image description
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**Ejemplo 2: En este ejemplo se describen los permisos de lanzamiento de la AMI especificada.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
**Salida:**
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {all}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**Ejemplo 3: En este ejemplo se comprueba si las redes mejoradas están habilitadas.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute sriovNetSupport
```
**Salida:**
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport : simple
```
+ Para obtener más información sobre la API, consulte [DescribeImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2ImportImageTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ImportImageTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la tarea de importación de imágenes especificada.**
```
Get-EC2ImportImageTask -ImportTaskId import-ami-hgfedcba
```
**Salida:**
```
Architecture : x86_64
Description : Windows Image 2
Hypervisor :
ImageId : ami-1a2b3c4d
ImportTaskId : import-ami-hgfedcba
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {/dev/sda1}
Status : completed
StatusMessage :
```
**Ejemplo 2: En este ejemplo se describen todas las tareas de importación de imágenes.**
```
Get-EC2ImportImageTask
```
**Salida:**
```
Architecture :
Description : Windows Image 1
Hypervisor :
ImageId :
ImportTaskId : import-ami-abcdefgh
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {}
Status : deleted
StatusMessage : User initiated task cancelation
Architecture : x86_64
Description : Windows Image 2
Hypervisor :
ImageId : ami-1a2b3c4d
ImportTaskId : import-ami-hgfedcba
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {/dev/sda1}
Status : completed
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [DescribeImportImageTasks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2ImportSnapshotTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ImportSnapshotTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la tarea de importación de instantáneas especificada.**
```
Get-EC2ImportSnapshotTask -ImportTaskId import-snap-abcdefgh
```
**Salida:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import 1 import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
**Ejemplo 2: En este ejemplo se describen todas las tareas de importación de instantáneas.**
```
Get-EC2ImportSnapshotTask
```
**Salida:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import 1 import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
Disk Image Import 2 import-snap-hgfedcba Amazon.EC2.Model.SnapshotTaskDetail
```
+ Para obtener más información sobre la API, consulte [DescribeImportSnapshotTasks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la instancia especificada.**
```
(Get-EC2Instance -InstanceId i-12345678).Instances
```
**Salida:**
```
AmiLaunchIndex : 0
Architecture : x86_64
BlockDeviceMappings : {/dev/sda1}
ClientToken : TleEy1448154045270
EbsOptimized : False
Hypervisor : xen
IamInstanceProfile : Amazon.EC2.Model.IamInstanceProfile
ImageId : ami-12345678
InstanceId : i-12345678
InstanceLifecycle :
InstanceType : t2.micro
KernelId :
KeyName : my-key-pair
LaunchTime : 12/4/2015 4:44:40 PM
Monitoring : Amazon.EC2.Model.Monitoring
NetworkInterfaces : {ip-10-0-2-172.us-west-2.compute.internal}
Placement : Amazon.EC2.Model.Placement
Platform : Windows
PrivateDnsName : ip-10-0-2-172.us-west-2.compute.internal
PrivateIpAddress : 10.0.2.172
ProductCodes : {}
PublicDnsName :
PublicIpAddress :
RamdiskId :
RootDeviceName : /dev/sda1
RootDeviceType : ebs
SecurityGroups : {default}
SourceDestCheck : True
SpotInstanceRequestId :
SriovNetSupport :
State : Amazon.EC2.Model.InstanceState
StateReason :
StateTransitionReason :
SubnetId : subnet-12345678
Tags : {Name}
VirtualizationType : hvm
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describen todas las instancias de la región actual, agrupadas por reserva. Para ver los detalles de la instancia, amplíe la colección de instancias dentro de cada objeto de reserva.**
```
Get-EC2Instance
```
**Salida:**
```
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 226008221399
ReservationId : r-c5df370c
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 854251627541
ReservationId : r-63e65bab
...
```
**Ejemplo 3: Este ejemplo ilustra el uso de un filtro para consultar instancias de EC2 en una subred específica de una VPC.**
```
(Get-EC2Instance -Filter @{Name="vpc-id";Values="vpc-1a2bc34d"},@{Name="subnet-id";Values="subnet-1a2b3c4d"}).Instances
```
**Salida:**
```
InstanceId InstanceType Platform PrivateIpAddress PublicIpAddress SecurityGroups SubnetId VpcId
---------- ------------ -------- ---------------- --------------- -------------- -------- -----
i-01af...82cf180e19 t2.medium Windows 10.0.0.98 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0374...7e9d5b0c45 t2.xlarge Windows 10.0.0.53 ... subnet-1a2b3c4d vpc-1a2b3c4d
```
**Ejemplo 4: Este ejemplo ilustra el uso de un filtro con varios valores para consultar las instancias de EC2 que están en ejecución y detenidas**
```
$InstanceParams = @{
Filter = @(
@{'Name' = 'instance-state-name';'Values' = @("running","stopped")}
)
}
(Get-EC2Instance @InstanceParams).Instances
```
**Salida:**
```
InstanceId InstanceType Platform PrivateIpAddress PublicIpAddress SecurityGroups SubnetId VpcId
---------- ------------ -------- ---------------- --------------- -------------- -------- -----
i-05a9...f6c5f46e18 t3.medium 10.0.1.7 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-02cf...945c4fdd07 t3.medium Windows 10.0.1.8 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0ac0...c037f9f3a1 t3.xlarge Windows 10.0.1.10 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-066b...57b7b08888 t3.medium Windows 10.0.1.11 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0fee...82e83ccd72 t3.medium Windows 10.0.1.5 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0a68...274cc5043b t3.medium Windows 10.0.1.6 ... subnet-1a2b3c4d vpc-1a2b3c4d
```
**Ejemplo 5: Este ejemplo ilustra el uso de un filtro con varios valores para consultar las instancias de EC2 que están en ejecución y el uso del cmdlet Select-Object para elegir valores específicos en la salida.**
```
$InstanceParams = @{
Filter = @(
@{'Name' = 'instance-state-name';'Values' = @("running","stopped")}
)
}
$SelectParams = @{
Property = @(
"InstanceID", "InstanceType", "Platform", "PrivateIpAddress",
@{Name="Name";Expression={$_.Tags[$_.Tags.Key.IndexOf("Name")].Value}},
@{Name="State";Expression={$_.State.Name}}
)
}
$result = Get-EC2Instance @InstanceParams
$result.Instances | Select-Object @SelectParams | Format-Table -AutoSize
```
**Salida:**
```
InstanceId InstanceType Platform PrivateIpAddress Name State
---------- ------------ -------- ---------------- ---- -----
i-05a9...f6c5f46e18 t3.medium 10.0.1.7 ec2-name-01 running
i-02cf...945c4fdd07 t3.medium Windows 10.0.1.8 ec2-name-02 stopped
i-0ac0...c037f9f3a1 t3.xlarge Windows 10.0.1.10 ec2-name-03 running
i-066b...57b7b08888 t3.medium Windows 10.0.1.11 ec2-name-04 stopped
i-0fee...82e83ccd72 t3.medium Windows 10.0.1.5 ec2-name-05 running
i-0a68...274cc5043b t3.medium Windows 10.0.1.6 ec2-name-06 stopped
```
**Ejemplo 6: en este ejemplo se validan los permisos para obtener instancias de EC2 mediante el DryRun parámetro sin obtenerlas realmente. Nota: Si se realiza correctamente, se produce una excepción, que es el comportamiento esperado.**
```
Get-EC2Tag -DryRun $true
```
**Salida:**
```
Get-EC2Instance: Request would have succeeded, but DryRun flag is set.
```
+ Para obtener información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeInstances](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EC2InstanceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2InstanceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el tipo de instancia de la instancia especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceType
```
**Salida:**
```
InstanceType : t2.micro
```
**Ejemplo 2: En este ejemplo se describe si la conexión en red mejorada está habilitada para la instancia especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**Salida:**
```
SriovNetSupport : simple
```
**Ejemplo 3: En este ejemplo se describen los grupos de seguridad para la instancia especificada.**
```
(Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute groupSet).Groups
```
**Salida:**
```
GroupId
-------
sg-12345678
sg-45678901
```
**Ejemplo 4: En este ejemplo se describe si la optimización de EBS está habilitada para la instancia especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**Salida:**
```
EbsOptimized : False
```
**Ejemplo 5: en este ejemplo se describe el atributo disableApiTermination '' de la instancia especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**Salida:**
```
DisableApiTermination : False
```
**Ejemplo 6: En este ejemplo se describe el atributo 'instanceInitiatedShutdownBehavior' de la instancia especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
**Salida:**
```
InstanceInitiatedShutdownBehavior : stop
```
+ Para obtener más información sobre la API, consulte [DescribeInstanceAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2InstanceMetadata`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2InstanceMetadata`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Muestra las categorías disponibles de metadatos de instancia que se pueden consultar.**
```
Get-EC2InstanceMetadata -ListCategory
```
**Salida:**
```
AmiId
LaunchIndex
ManifestPath
AncestorAmiId
BlockDeviceMapping
InstanceId
InstanceType
LocalHostname
LocalIpv4
KernelId
AvailabilityZone
ProductCode
PublicHostname
PublicIpv4
PublicKey
RamdiskId
Region
ReservationId
SecurityGroup
UserData
InstanceMonitoring
IdentityDocument
IdentitySignature
IdentityPkcs7
```
**Ejemplo 2: Devuelve el ID de Imagen de máquina de Amazon (AMI) que se utilizó para lanzar la instancia.**
```
Get-EC2InstanceMetadata -Category AmiId
```
**Salida:**
```
ami-b2e756ca
```
**Ejemplo 3: En este ejemplo se consulta el documento de identidad con formato JSON de la instancia.**
```
Get-EC2InstanceMetadata -Category IdentityDocument
{
"availabilityZone" : "us-west-2a",
"devpayProductCodes" : null,
"marketplaceProductCodes" : null,
"version" : "2017-09-30",
"instanceId" : "i-01ed50f7e2607f09e",
"billingProducts" : [ "bp-6ba54002" ],
"instanceType" : "t2.small",
"pendingTime" : "2018-03-07T16:26:04Z",
"imageId" : "ami-b2e756ca",
"privateIp" : "10.0.0.171",
"accountId" : "111122223333",
"architecture" : "x86_64",
"kernelId" : null,
"ramdiskId" : null,
"region" : "us-west-2"
}
```
**Ejemplo 4: En este ejemplo se utiliza una consulta de ruta para obtener los macs de la interfaz de red de la instancia.**
```
Get-EC2InstanceMetadata -Path "/network/interfaces/macs"
```
**Salida:**
```
02:80:7f:ef:4c:e0/
```
**Ejemplo 5: Si hay un rol de IAM asociado a la instancia, devuelve información sobre la última vez que se actualizó el perfil de la instancia, incluida la LastUpdated fecha de la instancia InstanceProfileArn, y. InstanceProfileId**
```
Get-EC2InstanceMetadata -Path "/iam/info"
```
**Salida:**
```
{
"Code" : "Success",
"LastUpdated" : "2018-03-08T03:38:40Z",
"InstanceProfileArn" : "arn:aws:iam::111122223333:instance-profile/MyLaunchRole_Profile",
"InstanceProfileId" : "AIPAI4...WVK2RW"
}
```
+ Para obtener más información sobre la API, consulte [Get-EC2InstanceMetadata Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-EC2InstanceStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2InstanceStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el estado de la instancia especificada.**
```
Get-EC2InstanceStatus -InstanceId i-12345678
```
**Salida:**
```
AvailabilityZone : us-west-2a
Events : {}
InstanceId : i-12345678
InstanceState : Amazon.EC2.Model.InstanceState
Status : Amazon.EC2.Model.InstanceStatusSummary
SystemStatus : Amazon.EC2.Model.InstanceStatusSummary
```
```
$status = Get-EC2InstanceStatus -InstanceId i-12345678
$status.InstanceState
```
**Salida:**
```
Code Name
---- ----
16 running
```
```
$status.Status
```
**Salida:**
```
Details Status
------- ------
{reachability} ok
```
```
$status.SystemStatus
```
**Salida:**
```
Details Status
------- ------
{reachability} ok
```
+ Para obtener más información sobre la API, consulte [DescribeInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2InternetGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2InternetGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la puerta de enlace de Internet especificada.**
```
Get-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**Salida:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
```
**Ejemplo 2: En este ejemplo se describen todas las puertas de enlace de Internet.**
```
Get-EC2InternetGateway
```
**Salida:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
{} igw-2a3b4c5d {}
```
+ Para obtener más información sobre la API, consulte [DescribeInternetGateways](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2KeyPair`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2KeyPair`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el par de claves especificado.**
```
Get-EC2KeyPair -KeyName my-key-pair
```
**Salida:**
```
KeyFingerprint KeyName
-------------- -------
1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f my-key-pair
```
**Ejemplo 2: En este ejemplo se describen todos los pares de claves.**
```
Get-EC2KeyPair
```
+ Para obtener más información sobre la API, consulte [DescribeKeyPairs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2NetworkAcl`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2NetworkAcl`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la ACL de red especificada.**
```
Get-EC2NetworkAcl -NetworkAclId acl-12345678
```
**Salida:**
```
Associations : {aclassoc-1a2b3c4d}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {Name}
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describen las reglas para la ACL de red especificada.**
```
(Get-EC2NetworkAcl -NetworkAclId acl-12345678).Entries
```
**Salida:**
```
CidrBlock : 0.0.0.0/0
Egress : True
IcmpTypeCode :
PortRange :
Protocol : -1
RuleAction : deny
RuleNumber : 32767
CidrBlock : 0.0.0.0/0
Egress : False
IcmpTypeCode :
PortRange :
Protocol : -1
RuleAction : deny
RuleNumber : 32767
```
**Ejemplo 3: En este ejemplo se describe toda la red ACLs.**
```
Get-EC2NetworkAcl
```
+ Para obtener información sobre la API, consulte [DescribeNetworkAcls Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-EC2NetworkInterface`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2NetworkInterface`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la interfaz de red especificada.**
```
Get-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**Salida:**
```
Association :
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
AvailabilityZone : us-west-2c
Description :
Groups : {my-security-group}
MacAddress : 0a:e9:a6:19:4c:7f
NetworkInterfaceId : eni-12345678
OwnerId : 123456789012
PrivateDnsName : ip-10-0-0-107.us-west-2.compute.internal
PrivateIpAddress : 10.0.0.107
PrivateIpAddresses : {ip-10-0-0-107.us-west-2.compute.internal}
RequesterId :
RequesterManaged : False
SourceDestCheck : True
Status : in-use
SubnetId : subnet-1a2b3c4d
TagSet : {}
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describen todas las interfaces de red.**
```
Get-EC2NetworkInterface
```
+ Para obtener más información sobre la API, consulte [DescribeNetworkInterfaces](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2NetworkInterfaceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2NetworkInterfaceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la interfaz de red especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Attachment
```
**Salida:**
```
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
```
**Ejemplo 2: En este ejemplo se describe la interfaz de red especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Description
```
**Salida:**
```
Description : My description
```
**Ejemplo 3: En este ejemplo se describe la interfaz de red especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute GroupSet
```
**Salida:**
```
Groups : {my-security-group}
```
**Ejemplo 4: En este ejemplo se describe la interfaz de red especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute SourceDestCheck
```
**Salida:**
```
SourceDestCheck : True
```
+ Para obtener más información sobre la API, consulte [DescribeNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2PasswordData`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2PasswordData`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se descifra la contraseña que Amazon EC2 asignó a la cuenta de administrador de la instancia de Windows especificada. Cuando se especificó un archivo pem, se asumió automáticamente la configuración del modificador -Decrypt.**
```
Get-EC2PasswordData -InstanceId i-12345678 -PemFile C:\path\my-key-pair.pem
```
**Salida:**
```
mYZ(PA9?C)Q
```
**Ejemplo 2: ( PowerShell solo en Windows) Inspecciona la instancia para determinar el nombre del par de claves utilizado para lanzar la instancia y, a continuación, intenta buscar los datos del par de claves correspondientes en el almacén de configuración del AWS Toolkit for Visual Studio. Si se encuentran los datos del par de claves, se descifra la contraseña.**
```
Get-EC2PasswordData -InstanceId i-12345678 -Decrypt
```
**Salida:**
```
mYZ(PA9?C)Q
```
**Ejemplo 3: Devuelve los datos de contraseña cifrados de la instancia.**
```
Get-EC2PasswordData -InstanceId i-12345678
```
**Salida:**
```
iVz3BAK/WAXV.....dqt8WeMA==
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [GetPasswordData](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-EC2PlacementGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2PlacementGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el grupo de ubicación especificado.**
```
Get-EC2PlacementGroup -GroupName my-placement-group
```
**Salida:**
```
GroupName State Strategy
--------- ----- --------
my-placement-group available cluster
```
+ Para obtener más información sobre la API, consulte [DescribePlacementGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2PrefixList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2PrefixList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene lo disponible Servicios de AWS en un formato de lista de prefijos para la región**
```
Get-EC2PrefixList
```
**Salida:**
```
Cidrs PrefixListId PrefixListName
----- ------------ --------------
{52.94.5.0/24, 52.119.240.0/21, 52.94.24.0/23} pl-6fa54006 com.amazonaws.eu-west-1.dynamodb
{52.218.0.0/17, 54.231.128.0/19} pl-6da54004 com.amazonaws.eu-west-1.s3
```
+ Para obtener más información sobre la API, consulte [DescribePrefixLists Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2Region`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Region`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las regiones que están disponibles.**
```
Get-EC2Region
```
**Salida:**
```
Endpoint RegionName
-------- ----------
ec2.eu-west-1.amazonaws.com eu-west-1
ec2.ap-southeast-1.amazonaws.com ap-southeast-1
ec2.ap-southeast-2.amazonaws.com ap-southeast-2
ec2.eu-central-1.amazonaws.com eu-central-1
ec2.ap-northeast-1.amazonaws.com ap-northeast-1
ec2.us-east-1.amazonaws.com us-east-1
ec2.sa-east-1.amazonaws.com sa-east-1
ec2.us-west-1.amazonaws.com us-west-1
ec2.us-west-2.amazonaws.com us-west-2
```
+ Para obtener más información sobre la API, consulte [DescribeRegions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2RouteTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2RouteTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen todas las tablas de enrutamiento.**
```
Get-EC2RouteTable
```
**Salida:**
```
DestinationCidrBlock : 10.0.0.0/16
DestinationPrefixListId :
GatewayId : local
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRouteTable
State : active
VpcPeeringConnectionId :
DestinationCidrBlock : 0.0.0.0/0
DestinationPrefixListId :
GatewayId : igw-1a2b3c4d
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRoute
State : active
VpcPeeringConnectionId :
```
**Ejemplo 2: En este ejemplo se devuelven los detalles de la tabla de enrutamiento especificada.**
```
Get-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**Ejemplo 3: En este ejemplo se describen las tablas de enrutamiento para la VPC especificada.**
```
Get-EC2RouteTable -Filter @{ Name="vpc-id"; Values="vpc-1a2b3c4d" }
```
**Salida:**
```
Associations : {rtbassoc-12345678}
PropagatingVgws : {}
Routes : {, }
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DescribeRouteTables](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2ScheduledInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ScheduledInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la instancia programada especificada.**
```
Get-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012
```
**Salida:**
```
AvailabilityZone : us-west-2b
CreateDate : 1/25/2016 1:43:38 PM
HourlyPrice : 0.095
InstanceCount : 1
InstanceType : c4.large
NetworkPlatform : EC2-VPC
NextSlotStartTime : 1/31/2016 1:00:00 AM
Platform : Linux/UNIX
PreviousSlotEndTime :
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
ScheduledInstanceId : sci-1234-1234-1234-1234-123456789012
SlotDurationInHours : 32
TermEndDate : 1/31/2017 1:00:00 AM
TermStartDate : 1/31/2016 1:00:00 AM
TotalScheduledInstanceHours : 1696
```
**Ejemplo 2: En este ejemplo se describen todas las instancias programadas.**
```
Get-EC2ScheduledInstance
```
+ Para obtener más información sobre la API, consulte [DescribeScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2ScheduledInstanceAvailability`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2ScheduledInstanceAvailability`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe una programación que tiene lugar todos los domingos a partir de la fecha especificada.**
```
Get-EC2ScheduledInstanceAvailability -Recurrence_Frequency Weekly -Recurrence_Interval 1 -Recurrence_OccurrenceDay 1 -FirstSlotStartTimeRange_EarliestTime 2016-01-31T00:00:00Z -FirstSlotStartTimeRange_LatestTime 2016-01-31T04:00:00Z
```
**Salida:**
```
AvailabilityZone : us-west-2b
AvailableInstanceCount : 20
FirstSlotStartTime : 1/31/2016 8:00:00 AM
HourlyPrice : 0.095
InstanceType : c4.large
MaxTermDurationInDays : 366
MinTermDurationInDays : 366
NetworkPlatform : EC2-VPC
Platform : Linux/UNIX
PurchaseToken : eyJ2IjoiMSIsInMiOjEsImMiOi...
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
SlotDurationInHours : 23
TotalScheduledInstanceHours : 1219
...
```
**Ejemplo 2: Para delimitar los resultados, puede añadir filtros para criterios como el sistema operativo, la red y el tipo de instancia.**
```
-Filter @{ Name="platform";Values="Linux/UNIX" },@{ Name="network-platform";Values="EC2-VPC" },@{ Name="instance-type";Values="c4.large" }
```
+ Para obtener más información sobre la API, consulte [DescribeScheduledInstanceAvailability](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SecurityGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el grupo de seguridad para la VPC especificada. Al trabajar con grupos de seguridad que pertenecen a una VPC, debe usar el ID del grupo de seguridad (GroupId parámetro -), no el nombre (GroupName parámetro -), para hacer referencia al grupo.**
```
Get-EC2SecurityGroup -GroupId sg-12345678
```
**Salida:**
```
Description : default VPC security group
GroupId : sg-12345678
GroupName : default
IpPermissions : {Amazon.EC2.Model.IpPermission}
IpPermissionsEgress : {Amazon.EC2.Model.IpPermission}
OwnerId : 123456789012
Tags : {}
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describe el grupo de seguridad especificado para EC2-Classic. Al trabajar con grupos de seguridad para EC2-Classic, puede utilizar el nombre del grupo (GroupName parámetro -) o el ID del grupo (GroupId parámetro -) para hacer referencia al grupo de seguridad.**
```
Get-EC2SecurityGroup -GroupName my-security-group
```
**Salida:**
```
Description : my security group
GroupId : sg-45678901
GroupName : my-security-group
IpPermissions : {Amazon.EC2.Model.IpPermission, Amazon.EC2.Model.IpPermission}
IpPermissionsEgress : {}
OwnerId : 123456789012
Tags : {}
VpcId :
```
**Ejemplo 3: En este ejemplo se recuperan todos los grupos de seguridad de vpc-0fc1ff23456b789eb.**
```
Get-EC2SecurityGroup -Filter @{Name="vpc-id";Values="vpc-0fc1ff23456b789eb"}
```
+ Para obtener más información sobre la API, consulte [DescribeSecurityGroups Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2Snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Snapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la instantánea especificada.**
```
Get-EC2Snapshot -SnapshotId snap-12345678
```
**Salida:**
```
DataEncryptionKeyId :
Description : Created by CreateImage(i-1a2b3c4d) for ami-12345678 from vol-12345678
Encrypted : False
KmsKeyId :
OwnerAlias :
OwnerId : 123456789012
Progress : 100%
SnapshotId : snap-12345678
StartTime : 10/23/2014 6:01:28 AM
State : completed
StateMessage :
Tags : {}
VolumeId : vol-12345678
VolumeSize : 8
```
**Ejemplo 2: En este ejemplo se describen las instantáneas que tienen la etiqueta “Name”.**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" }
```
**Ejemplo 3: En este ejemplo se describen las instantáneas que tienen una etiqueta de «Nombre» con el valor «». TestValue**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" -and $_.Tags.Value -eq "TestValue" }
```
**Ejemplo 4: En este ejemplo se describen todas las instantáneas.**
```
Get-EC2Snapshot -Owner self
```
+ Para obtener más información sobre la API, consulte [DescribeSnapshots Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-EC2SnapshotAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SnapshotAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el atributo especificado de la instantánea especificada.**
```
Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute ProductCodes
```
**Salida:**
```
CreateVolumePermissions ProductCodes SnapshotId
----------------------- ------------ ----------
{} {} snap-12345678
```
**Ejemplo 2: En este ejemplo se describe el atributo especificado de la instantánea especificada.**
```
(Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission).CreateVolumePermissions
```
**Salida:**
```
Group UserId
----- ------
all
```
+ Para obtener más información sobre la API, consulte [DescribeSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotDatafeedSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotDatafeedSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la fuente de datos de la instancia de spot.**
```
Get-EC2SpotDatafeedSubscription
```
**Salida:**
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ Para obtener más información sobre la API, consulte [DescribeSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotFleetInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotFleetInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las instancias asociadas a la solicitud de flota de spot especificada.**
```
Get-EC2SpotFleetInstance -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
```
**Salida:**
```
InstanceId InstanceType SpotInstanceRequestId
---------- ------------ ---------------------
i-f089262a c3.large sir-12345678
i-7e8b24a4 c3.large sir-87654321
```
+ Para obtener más información sobre la API, consulte [DescribeSpotFleetInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotFleetRequest`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotFleetRequest`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la solicitud de flota de spot especificada.**
```
Get-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE | format-list
```
**Salida:**
```
ConfigData : Amazon.EC2.Model.SpotFleetRequestConfigData
CreateTime : 12/26/2015 8:23:33 AM
SpotFleetRequestId : sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
SpotFleetRequestState : active
```
**Ejemplo 2: En este ejemplo se describen todas las solicitudes de flota de spot.**
```
Get-EC2SpotFleetRequest
```
+ Para obtener más información sobre la API, consulte [DescribeSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotFleetRequestHistory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotFleetRequestHistory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el historial de la solicitud de flota de spot especificada.**
```
Get-EC2SpotFleetRequestHistory -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -StartTime 2015-12-26T00:00:00Z
```
**Salida:**
```
HistoryRecords : {Amazon.EC2.Model.HistoryRecord, Amazon.EC2.Model.HistoryRecord...}
LastEvaluatedTime : 12/26/2015 8:29:11 AM
NextToken :
SpotFleetRequestId : sfr-088bc5f1-7e7b-451a-bd13-757f10672b93
StartTime : 12/25/2015 8:00:00 AM
```
```
(Get-EC2SpotFleetRequestHistory -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -StartTime 2015-12-26T00:00:00Z).HistoryRecords
```
**Salida:**
```
EventInformation EventType Timestamp
---------------- --------- ---------
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation launched 12/26/2015 8:25:34 AM
Amazon.EC2.Model.EventInformation launched 12/26/2015 8:25:05 AM
```
+ Para obtener más información sobre la API, consulte [DescribeSpotFleetRequestHistory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotInstanceRequest`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotInstanceRequest`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la solicitud de instancia de spot especificada.**
```
Get-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**Salida:**
```
ActualBlockHourlyPrice :
AvailabilityZoneGroup :
BlockDurationMinutes : 0
CreateTime : 4/8/2015 2:51:33 PM
Fault :
InstanceId : i-12345678
LaunchedAvailabilityZone : us-west-2b
LaunchGroup :
LaunchSpecification : Amazon.EC2.Model.LaunchSpecification
ProductDescription : Linux/UNIX
SpotInstanceRequestId : sir-12345678
SpotPrice : 0.020000
State : active
Status : Amazon.EC2.Model.SpotInstanceStatus
Tags : {Name}
Type : one-time
```
**Ejemplo 2: En este ejemplo se describen todas las solicitudes de instancia de spot.**
```
Get-EC2SpotInstanceRequest
```
+ Para obtener más información sobre la API, consulte [DescribeSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2SpotPriceHistory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2SpotPriceHistory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen las 10 últimas entradas del historial de precios de spot para el tipo de instancia y la zona de disponibilidad especificados. Tenga en cuenta que el valor especificado para el AvailabilityZone parámetro - debe ser válido para el valor de región proporcionado al parámetro -Region del cmdlet (no se muestra en el ejemplo) o estar establecido como predeterminado en el shell. En este comando se presupone que se ha establecido la región predeterminada “us-west-2” en el entorno.**
```
Get-EC2SpotPriceHistory -InstanceType c3.large -AvailabilityZone us-west-2a -MaxResult 10
```
**Salida:**
```
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:39:49 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017200
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:38:29 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 6:57:13 AM
...
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeSpotPriceHistory](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EC2Subnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Subnet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la subred especificada.**
```
Get-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**Salida:**
```
AvailabilityZone : us-west-2c
AvailableIpAddressCount : 251
CidrBlock : 10.0.0.0/24
DefaultForAz : False
MapPublicIpOnLaunch : False
State : available
SubnetId : subnet-1a2b3c4d
Tags : {}
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describen todas las subredes.**
```
Get-EC2Subnet
```
+ Para obtener más información sobre la API, consulte [DescribeSubnets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recuperan las etiquetas del tipo de recurso “image”.**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="image"}
```
**Salida:**
```
Key ResourceId ResourceType Value
--- ---------- ------------ -----
Name ami-0a123b4ccb567a8ea image Win7-Imported
auto-delete ami-0a123b4ccb567a8ea image never
```
**Ejemplo 2: En este ejemplo se buscan todas las etiquetas de todos los recursos y se agrupan por tipo de recurso.**
```
Get-EC2Tag | Group-Object resourcetype
```
**Salida:**
```
Count Name Group
----- ---- -----
9 subnet {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
53 instance {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
3 route-table {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
5 security-group {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
30 volume {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
1 internet-gateway {Amazon.EC2.Model.TagDescription}
3 network-interface {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
4 elastic-ip {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
1 dhcp-options {Amazon.EC2.Model.TagDescription}
2 image {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
3 vpc {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
```
**Ejemplo 3: Este ejemplo muestra todos los recursos con la etiqueta “auto-delete” con el valor “no” para la región especificada.**
```
Get-EC2Tag -Region eu-west-1 -Filter @{Name="tag:auto-delete";Values="no"}
```
**Salida:**
```
Key ResourceId ResourceType Value
--- ---------- ------------ -----
auto-delete i-0f1bce234d5dd678b instance no
auto-delete vol-01d234aa5678901a2 volume no
auto-delete vol-01234bfb5def6f7b8 volume no
auto-delete vol-01ccb23f4c5e67890 volume no
```
**Ejemplo 4: Este ejemplo obtiene todos los recursos con la etiqueta «eliminación automática» con el valor «no» y más filtros en el siguiente tubo para analizar solo los tipos de recursos de «instancia» y, finalmente, crea la etiqueta «ThisInstance» para cada recurso de la instancia, cuyo valor es el propio identificador de la instancia**
```
Get-EC2Tag -Region eu-west-1 -Filter @{Name="tag:auto-delete";Values="no"} | Where-Object ResourceType -eq "instance" | ForEach-Object {New-EC2Tag -ResourceId $_.ResourceId -Tag @{Key="ThisInstance";Value=$_.ResourceId}}
```
**Ejemplo 5: En este ejemplo se recuperan las etiquetas de todos los recursos de instancia, así como las claves “Name”, y las muestra en formato de tabla.**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="instance"},@{Name="key";Values="Name"} | Select-Object ResourceId, @{Name="Name-Tag";Expression={$PSItem.Value}} | Format-Table -AutoSize
```
**Salida:**
```
ResourceId Name-Tag
---------- --------
i-012e3cb4df567e1aa jump1
i-01c23a45d6fc7a89f repro-3
```
**Ejemplo 6: Este ejemplo valida los permisos para obtener etiquetas de EC2 mediante el DryRun parámetro sin obtenerlas realmente. Nota: Si se realiza correctamente, se produce una excepción, que es el comportamiento esperado.**
```
Get-EC2Tag -DryRun $true
```
**Salida:**
```
Get-EC2Tag: Request would have succeeded, but DryRun flag is set.
```
+ Para obtener información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EC2Volume`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Volume`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el volumen de EBS especificado.**
```
Get-EC2Volume -VolumeId vol-12345678
```
**Salida:**
```
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 7/17/2015 4:35:19 PM
Encrypted : False
Iops : 90
KmsKeyId :
Size : 30
SnapshotId : snap-12345678
State : in-use
Tags : {}
VolumeId : vol-12345678
VolumeType : standard
```
**Ejemplo 2: En este ejemplo se describen los volúmenes de EBS que tienen el estado “disponible”.**
```
Get-EC2Volume -Filter @{ Name="status"; Values="available" }
```
**Salida:**
```
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 12/21/2015 2:31:29 PM
Encrypted : False
Iops : 60
KmsKeyId :
Size : 20
SnapshotId : snap-12345678
State : available
Tags : {}
VolumeId : vol-12345678
VolumeType : gp2
...
```
**Ejemplo 3: En este ejemplo se describen todos los volúmenes de EBS.**
```
Get-EC2Volume
```
+ Para obtener más información sobre la API, consulte [DescribeVolumes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2VolumeAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VolumeAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el atributo especificado del volumen especificado.**
```
Get-EC2VolumeAttribute -VolumeId vol-12345678 -Attribute AutoEnableIO
```
**Salida:**
```
AutoEnableIO ProductCodes VolumeId
------------ ------------ --------
False {} vol-12345678
```
+ Para obtener más información sobre la API, consulte [DescribeVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2VolumeStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VolumeStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el estado del volumen especificado.**
```
Get-EC2VolumeStatus -VolumeId vol-12345678
```
**Salida:**
```
Actions : {}
AvailabilityZone : us-west-2a
Events : {}
VolumeId : vol-12345678
VolumeStatus : Amazon.EC2.Model.VolumeStatusInfo
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus
```
**Salida:**
```
Details Status
------- ------
{io-enabled, io-performance} ok
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus.Details
```
**Salida:**
```
Name Status
---- ------
io-enabled passed
io-performance not-applicable
```
+ Para obtener más información sobre la API, consulte [DescribeVolumeStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2Vpc`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2Vpc`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la VPC especificada.**
```
Get-EC2Vpc -VpcId vpc-12345678
```
**Salida:**
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : available
Tags : {Name}
VpcId : vpc-12345678
```
**Ejemplo 2: En este ejemplo se describe la VPC predeterminada (solo puede haber una por región). Si su cuenta es compatible con EC2-Classic en esta región, no hay una VPC predeterminada.**
```
Get-EC2Vpc -Filter @{Name="isDefault"; Values="true"}
```
**Salida:**
```
CidrBlock : 172.31.0.0/16
DhcpOptionsId : dopt-12345678
InstanceTenancy : default
IsDefault : True
State : available
Tags : {}
VpcId : vpc-45678901
```
**Ejemplo 3: En este ejemplo se describen las VPCs que coinciden con el filtro especificado (es decir, tienen un CIDR que coincide con el valor «10.0.0.0/16» y están en el estado «disponibles»).**
```
Get-EC2Vpc -Filter @{Name="cidr"; Values="10.0.0.0/16"},@{Name="state";Values="available"}
```
**Ejemplo 4: En este ejemplo se describen todos sus. VPCs**
```
Get-EC2Vpc
```
+ Para obtener más información sobre la API, consulte [DescribeVpcs Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-EC2VpcAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpcAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el atributo «enableDnsSupport».**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsSupport
```
**Salida:**
```
EnableDnsSupport
----------------
True
```
**Ejemplo 2: En este ejemplo se describe el atributo enableDnsHostnames «».**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsHostnames
```
**Salida:**
```
EnableDnsHostnames
------------------
True
```
+ Para obtener más información sobre la API, consulte [DescribeVpcAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-EC2VpcClassicLink`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpcClassicLink`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El ejemplo anterior devuelve todos los valores VPCs con su ClassicLinkEnabled estado para la región**
```
Get-EC2VpcClassicLink -Region eu-west-1
```
**Salida:**
```
ClassicLinkEnabled Tags VpcId
------------------ ---- -----
False {Name} vpc-0fc1ff23f45b678eb
False {} vpc-01e23c4a5d6db78e9
False {Name} vpc-0123456b078b9d01f
False {} vpc-12cf3b4f
False {Name} vpc-0b12d3456a7e8901d
```
+ Para obtener más información sobre la API, consulte [DescribeVpcClassicLink Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-EC2VpcClassicLinkDnsSupport`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpcClassicLinkDnsSupport`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el estado de soporte de ClassicLink DNS VPCs de la región eu-west-1**
```
Get-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
**Salida:**
```
ClassicLinkDnsSupported VpcId
----------------------- -----
False vpc-0b12d3456a7e8910d
False vpc-12cf3b4f
```
+ Para obtener información sobre la API, consulte [DescribeVpcClassicLinkDnsSupport Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EC2VpcEndpoint`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpcEndpoint`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen uno o varios de los puntos de conexión de VPC para la región eu-west-1. A continuación, canaliza el resultado al siguiente comando, que selecciona la VpcEndpointId propiedad y devuelve el ID de VPC de la matriz como matriz de cadenas**
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object -ExpandProperty VpcEndpointId
```
**Salida:**
```
vpce-01a2ab3f4f5cc6f7d
vpce-01d2b345a6787890b
vpce-0012e34d567890e12
vpce-0c123db4567890123
```
**Ejemplo 2: Este ejemplo describe todos los puntos finales de vpc de la región eu-west-1 y selecciona VpcEndpointId VpcId, ServiceName y PrivateDnsEnabled propiedades para presentarlos en formato tabular**
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object VpcEndpointId, VpcId, ServiceName, PrivateDnsEnabled | Format-Table -AutoSize
```
**Salida:**
```
VpcEndpointId VpcId ServiceName PrivateDnsEnabled
------------- ----- ----------- -----------------
vpce-02a2ab2f2f2cc2f2d vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ssm True
vpce-01d1b111a1114561b vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ec2 True
vpce-0011e23d45167e838 vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ec2messages True
vpce-0c123db4567890123 vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ssmmessages True
```
**Ejemplo 3: En este ejemplo se exporta el documento de política del punto de conexión de VPC vpce-01a2ab3f4f5cc6f7d a un archivo json.**
```
Get-EC2VpcEndpoint -Region eu-west-1 -VpcEndpointId vpce-01a2ab3f4f5cc6f7d | Select-Object -expand PolicyDocument | Out-File vpce_policyDocument.json
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet* Reference ([DescribeVpcEndpoints](https://docs.aws.amazon.com/powershell/v5/reference)V5).
### `Get-EC2VpcEndpointService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpcEndpointService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el servicio de punto de conexión de VPC de EC2 con el filtro indicado, en este caso, com.amazonaws.eu-west-1.ecs. Además, también amplía la ServiceDetails propiedad y muestra los detalles**
```
Get-EC2VpcEndpointService -Region eu-west-1 -MaxResult 5 -Filter @{Name="service-name";Values="com.amazonaws.eu-west-1.ecs"} | Select-Object -ExpandProperty ServiceDetails
```
**Salida:**
```
AcceptanceRequired : False
AvailabilityZones : {eu-west-1a, eu-west-1b, eu-west-1c}
BaseEndpointDnsNames : {ecs.eu-west-1.vpce.amazonaws.com}
Owner : amazon
PrivateDnsName : ecs.eu-west-1.amazonaws.com
ServiceName : com.amazonaws.eu-west-1.ecs
ServiceType : {Amazon.EC2.Model.ServiceTypeDetail}
VpcEndpointPolicySupported : False
```
**Ejemplo 2: Este ejemplo recupera todos los servicios de punto final de la VPC de EC2 y devuelve el ServiceNames «ssm» coincidente**
```
Get-EC2VpcEndpointService -Region eu-west-1 | Select-Object -ExpandProperty Servicenames | Where-Object { -match "ssm"}
```
**Salida:**
```
com.amazonaws.eu-west-1.ssm
com.amazonaws.eu-west-1.ssmmessages
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeVpcEndpointServices](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-EC2VpnConnection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpnConnection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la conexión VPN especificada.**
```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**Salida:**
```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId : cgw-1a2b3c4d
Options : Amazon.EC2.Model.VpnConnectionOptions
Routes : {Amazon.EC2.Model.VpnStaticRoute}
State : available
Tags : {}
Type : ipsec.1
VgwTelemetry : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId : vpn-12345678
VpnGatewayId : vgw-1a2b3c4d
```
**Ejemplo 2: En este ejemplo se describen todas las conexiones VPN cuyo estado sea pendiente o disponible.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnConnection -Filter $filter
```
**Ejemplo 3: En este ejemplo se describen todas las conexiones VPN.**
```
Get-EC2VpnConnection
```
+ Para obtener más información sobre la API, consulte [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EC2VpnGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EC2VpnGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe la puerta de enlace privada virtual especificada.**
```
Get-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**Salida:**
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {vpc-12345678}
VpnGatewayId : vgw-1a2b3c4d
```
**Ejemplo 2: En este ejemplo se describen todas las puertas de enlace privada virtuales cuyo estado sea pendiente o disponible.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnGateway -Filter $filter
```
**Ejemplo 3: En este ejemplo se describen las puertas de enlace privadas virtuales.**
```
Get-EC2VpnGateway
```
+ Para obtener más información sobre la API, consulte [DescribeVpnGateways](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Grant-EC2SecurityGroupEgress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Grant-EC2SecurityGroupEgress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se define una regla de salida para el grupo de seguridad especificado para EC2-VPC. La regla otorga acceso en el puerto TCP 80 al intervalo de direcciones IP especificado. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear el IpPermission objeto.**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 80
$ip.ToPort = 80
$ip.IpRanges.Add("203.0.113.0/24")
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 3: En este ejemplo se otorga acceso al grupo de seguridad de origen especificado en el puerto TCP 80.**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; UserIdGroupPairs=$ug } )
```
+ Para obtener más información sobre la API, consulte [AuthorizeSecurityGroupEgress Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Grant-EC2SecurityGroupIngress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Grant-EC2SecurityGroupIngress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se define una regla de entrada para un grupo de seguridad para EC2-VPC. Estas reglas otorgan acceso a una dirección IP específica para SSH (puerto 22) y RDC (puerto 3389). Además, debe identificar los grupos de seguridad de EC2-VPC mediante el ID del grupo de seguridad, en lugar del nombre del grupo de seguridad. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
$ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear los IpPermission objetos.**
```
$ip1 = New-Object Amazon.EC2.Model.IpPermission
$ip1.IpProtocol = "tcp"
$ip1.FromPort = 22
$ip1.ToPort = 22
$ip1.IpRanges.Add("203.0.113.25/32")
$ip2 = new-object Amazon.EC2.Model.IpPermission
$ip2.IpProtocol = "tcp"
$ip2.FromPort = 3389
$ip2.ToPort = 3389
$ip2.IpRanges.Add("203.0.113.25/32")
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
```
**Ejemplo 3: En este ejemplo se definen las regla de entrada para un grupo de seguridad de EC2-VPC. Estas reglas otorgan acceso a una dirección IP específica para SSH (puerto 22) y RDC (puerto 3389). La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
$ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }
Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
```
**Ejemplo 4: Con la PowerShell versión 2, debe usar New-Object para crear los IpPermission objetos.**
```
$ip1 = New-Object Amazon.EC2.Model.IpPermission
$ip1.IpProtocol = "tcp"
$ip1.FromPort = 22
$ip1.ToPort = 22
$ip1.IpRanges.Add("203.0.113.25/32")
$ip2 = new-object Amazon.EC2.Model.IpPermission
$ip2.IpProtocol = "tcp"
$ip2.FromPort = 3389
$ip2.ToPort = 3389
$ip2.IpRanges.Add("203.0.113.25/32")
Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
```
**Ejemplo 5: En este ejemplo se concede el acceso del puerto TCP 8081 desde el grupo de seguridad de origen especificado (sg-1a2b3c4d) al grupo de seguridad especificado (sg-12345678).**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="8081"; ToPort="8081"; UserIdGroupPairs=$ug } )
```
**Ejemplo 6: Este ejemplo añade el CIDR 5.5.5.5/32 a las reglas de entrada del grupo de seguridad sg-1234abcd para el tráfico del puerto TCP 22 con una descripción.**
```
$IpRange = New-Object -TypeName Amazon.EC2.Model.IpRange
$IpRange.CidrIp = "5.5.5.5/32"
$IpRange.Description = "SSH from Office"
$IpPermission = New-Object Amazon.EC2.Model.IpPermission
$IpPermission.IpProtocol = "tcp"
$IpPermission.ToPort = 22
$IpPermission.FromPort = 22
$IpPermission.Ipv4Ranges = $IpRange
Grant-EC2SecurityGroupIngress -GroupId sg-1234abcd -IpPermission $IpPermission
```
+ Para obtener más información sobre la API, consulte [AuthorizeSecurityGroupIngress Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Import-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Import-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se importa una imagen de máquina virtual de un solo disco del bucket de Amazon S3 especificado a Amazon EC2 con un token de idempotencia. El ejemplo requiere que exista un rol de servicio de VM Import con el nombre predeterminado “vmimport”, con una política que permita a Amazon EC2 acceder al bucket especificado, como se explica en el tema Requisitos previos de VM Import. Para usar un rol personalizado, especifique el nombre del rol mediante el parámetro `-RoleName`.**
```
$container = New-Object Amazon.EC2.Model.ImageDiskContainer
$container.Format="VMDK"
$container.UserBucket = New-Object Amazon.EC2.Model.UserBucket
$container.UserBucket.S3Bucket = "amzn-s3-demo-bucket"
$container.UserBucket.S3Key = "Win_2008_Server_Standard_SP2_64-bit-disk1.vmdk"
$parms = @{
"ClientToken"="idempotencyToken"
"Description"="Windows 2008 Standard Image Import"
"Platform"="Windows"
"LicenseType"="AWS"
}
Import-EC2Image -DiskContainer $container @parms
```
**Salida:**
```
Architecture :
Description : Windows 2008 Standard Image
Hypervisor :
ImageId :
ImportTaskId : import-ami-abcdefgh
LicenseType : AWS
Platform : Windows
Progress : 2
SnapshotDetails : {}
Status : active
StatusMessage : pending
```
+ Para obtener más información sobre la API, consulte [ImportImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Import-EC2KeyPair`
En el siguiente ejemplo de código, se muestra cómo utilizar `Import-EC2KeyPair`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se importa una clave pública a EC2. La primera línea almacena el contenido del archivo de clave pública (\$1.pub) en la variable `$publickey`. A continuación, el ejemplo convierte el UTF8 formato del archivo de clave pública en una cadena codificada en Base64 y almacena la cadena convertida en la variable. `$pkbase64` En la última línea, la clave pública convertida se importa a EC2. Como resultado, el cmdlet devuelve la huella digital y el nombre de la clave.**
```
$publickey=[Io.File]::ReadAllText("C:\Users\TestUser\.ssh\id_rsa.pub")
$pkbase64 = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($publickey))
Import-EC2KeyPair -KeyName Example-user-key -PublicKey $pkbase64
```
**Salida:**
```
KeyFingerprint KeyName
-------------- -------
do:d0:15:8f:79:97:12:be:00:fd:df:31:z3:b1:42:z1 Example-user-key
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ImportKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Import-EC2Snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Import-EC2Snapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se importa una imagen de disco de máquina virtual con el formato “VMDK” a una instantánea de Amazon EBS. El ejemplo requiere un rol de VM Import Service con el nombre predeterminado «vmimport», con una política que permita a Amazon EC2 acceder al bucket especificado, como se explica en el tema de http://docs.aws.amazon. `VM Import Prequisites` com/AWSEC2/latest/WindowsGuide/VMImportPrerequisites.html. Para usar un rol personalizado, especifique el nombre del rol mediante el parámetro `-RoleName`.**
```
$parms = @{
"ClientToken"="idempotencyToken"
"Description"="Disk Image Import"
"DiskContainer_Description" = "Data disk"
"DiskContainer_Format" = "VMDK"
"DiskContainer_S3Bucket" = "amzn-s3-demo-bucket"
"DiskContainer_S3Key" = "datadiskimage.vmdk"
}
Import-EC2Snapshot @parms
```
**Salida:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
+ Para obtener más información sobre la API, consulte [ImportSnapshot Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Move-EC2AddressToVpc`
En el siguiente ejemplo de código, se muestra cómo utilizar `Move-EC2AddressToVpc`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se mueve una instancia de EC2 con la dirección IP pública 12.345.67.89 a la plataforma de EC2-VPC en la región Este de EE. UU. (Norte de Virginia).**
```
Move-EC2AddressToVpc -PublicIp 12.345.67.89 -Region us-east-1
```
**Ejemplo 2: este ejemplo canaliza los resultados de un Get-EC2Instance comando al Move-EC2AddressToVpc cmdlet. El Get-EC2Instance comando obtiene una instancia que se especifica mediante el ID de la instancia y, a continuación, devuelve la propiedad de dirección IP pública de la instancia.**
```
(Get-EC2Instance -Instance i-12345678).Instances.PublicIpAddress | Move-EC2AddressToVpc
```
+ Para obtener más información sobre la API, consulte [MoveAddressToVpc Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-EC2Address`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Address`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asigna una dirección IP elástica para usarla con una instancia en una VPC.**
```
New-EC2Address -Domain Vpc
```
**Salida:**
```
AllocationId Domain PublicIp
------------ ------ --------
eipalloc-12345678 vpc 198.51.100.2
```
**Ejemplo 2: En este ejemplo se asigna una dirección IP elástica para usarla con una instancia en EC2-Classic.**
```
New-EC2Address
```
**Salida:**
```
AllocationId Domain PublicIp
------------ ------ --------
standard 203.0.113.17
```
+ Para obtener más información sobre la API, consulte [AllocateAddress](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2CustomerGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2CustomerGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la puerta de enlace de cliente especificada.**
```
New-EC2CustomerGateway -Type ipsec.1 -PublicIp 203.0.113.12 -BgpAsn 65534
```
**Salida:**
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
+ Para obtener más información sobre la API, consulte [CreateCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2DhcpOption`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2DhcpOption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea el conjunto especificado de opciones de DHCP. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
$options = @( @{Key="domain-name";Values=@("abc.local")}, @{Key="domain-name-servers";Values=@("10.0.0.101","10.0.0.102")})
New-EC2DhcpOption -DhcpConfiguration $options
```
**Salida:**
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear cada opción de DHCP.**
```
$option1 = New-Object Amazon.EC2.Model.DhcpConfiguration
$option1.Key = "domain-name"
$option1.Values = "abc.local"
$option2 = New-Object Amazon.EC2.Model.DhcpConfiguration
$option2.Key = "domain-name-servers"
$option2.Values = @("10.0.0.101","10.0.0.102")
New-EC2DhcpOption -DhcpConfiguration @($option1, $option2)
```
**Salida:**
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [CreateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `New-EC2FlowLog`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2FlowLog`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un registro de flujo de EC2 para la subred-1d234567 en la cloud-watch-log denominada «subnet1-log» para todo el tráfico de «REJECT» utilizando los permisos de la función de «Administrador»**
```
New-EC2FlowLog -ResourceId "subnet-1d234567" -LogDestinationType cloud-watch-logs -LogGroupName subnet1-log -TrafficType "REJECT" -ResourceType Subnet -DeliverLogsPermissionArn "arn:aws:iam::98765432109:role/Admin"
```
**Salida:**
```
ClientToken FlowLogIds Unsuccessful
----------- ---------- ------------
m1VN2cxP3iB4qo//VUKl5EU6cF7gQLOxcqNefvjeTGw= {fl-012fc34eed5678c9d} {}
```
+ *Para obtener Herramientas de AWS para PowerShell más información sobre la API, consulte Cmdlet* Reference (V5). [CreateFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)
### `New-EC2Host`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Host`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asigna un host dedicado a su cuenta para el tipo de instancia y la zona de disponibilidad especificados**
```
New-EC2Host -AutoPlacement on -AvailabilityZone eu-west-1b -InstanceType m4.xlarge -Quantity 1
```
**Salida:**
```
h-01e23f4cd567890f3
```
+ Para obtener más información sobre la API, consulte [AllocateHosts](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2HostReservation`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2HostReservation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se compra la oferta de reserva 0c1f23456789d0ab con configuraciones que coinciden con las de su host dedicado h-01e23f4cd567890f1.**
```
New-EC2HostReservation -OfferingId hro-0c1f23456789d0ab HostIdSet h-01e23f4cd567890f1
```
**Salida:**
```
ClientToken :
CurrencyCode :
Purchase : {hr-0123f4b5d67bedc89}
TotalHourlyPrice : 1.307
TotalUpfrontPrice : 0.000
```
+ Para obtener más información sobre la API, consulte [PurchaseHostReservation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una AMI con el nombre y la descripción especificados desde la instancia especificada. Amazon EC2 intenta cerrar la instancia de forma limpia antes de crear la imagen y la reinicia una vez finalizada.**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI"
```
**Ejemplo 2: En este ejemplo se crea una AMI con el nombre y la descripción especificados desde la instancia especificada. Amazon EC2 crea la imagen sin cerrar ni reiniciar la instancia; por lo tanto, no se puede garantizar la integridad del sistema de archivos de la imagen creada.**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI" -NoReboot $true
```
**Ejemplo 3: En este ejemplo se crea una AMI con tres volúmenes. El primer volumen se basa en una instantánea de Amazon EBS. El segundo volumen es un volumen de Amazon EBS vacío de 100 GiB. El tercer volumen es un volumen de almacén de instancias. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ebsBlock1 = @{SnapshotId="snap-1a2b3c4d"}
$ebsBlock2 = @{VolumeSize=100}
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI" -BlockDeviceMapping @( @{DeviceName="/dev/sdf";Ebs=$ebsBlock1}, @{DeviceName="/dev/sdg";Ebs=$ebsBlock2}, @{DeviceName="/dev/sdc";VirtualName="ephemeral0"})
```
+ Para obtener información sobre la API, consulte [CreateImage Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se lanza una sola instancia de la AMI especificada en EC2-Classic o en una VPC predeterminada.**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -InstanceType m3.medium -KeyName my-key-pair -SecurityGroup my-security-group
```
**Ejemplo 2: En este ejemplo se lanza una sola instancia de la AMI especificada en una VPC.**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -SubnetId subnet-12345678 -InstanceType t2.micro -KeyName my-key-pair -SecurityGroupId sg-12345678
```
**Ejemplo 3: Para añadir un volumen de EBS o un volumen de almacén de instancias, defina una asignación de dispositivos de bloques y añádala al comando. En este ejemplo se añade un volumen de almacén de instancias.**
```
$bdm = New-Object Amazon.EC2.Model.BlockDeviceMapping
$bdm.VirtualName = "ephemeral0"
$bdm.DeviceName = "/dev/sdf"
New-EC2Instance -ImageId ami-12345678 -BlockDeviceMapping $bdm ...
```
**Ejemplo 4: Para especificar uno de los Windows actuales AMIs, obtenga su ID de AMI mediante Get- SSMLatest EC2 Image. En este ejemplo se lanza una instancia desde la AMI base actual para Windows Server 2016.**
```
$ami = (Get-SSMLatestEC2Image -Path 'ami-windows-latest' -ImageName 'WINDOWS*2016*English*Core*BASE').Value
New-EC2Instance -ImageId $ami ...
```
**Ejemplo 5: Lanza una instancia en el entorno de host dedicado especificado.**
```
New-EC2Instance -ImageId ami-1a2b3c4d -InstanceType m4.large -KeyName my-key-pair -SecurityGroupId sg-1a2b3c4d -AvailabilityZone us-west-1a -Tenancy host -HostID h-1a2b3c4d5e6f1a2b3
```
**Ejemplo 6: Esta solicitud lanza dos instancias y aplica una etiqueta con una clave de servidor web y un valor de producción a las instancias. La solicitud también aplica una etiqueta con una clave de cost-center y un valor de cc123 a los volúmenes que se crean (en este caso, el volumen raíz de cada instancia).**
```
$tag1 = @{ Key="webserver"; Value="production" }
$tag2 = @{ Key="cost-center"; Value="cc123" }
$tagspec1 = new-object Amazon.EC2.Model.TagSpecification
$tagspec1.ResourceType = "instance"
$tagspec1.Tags.Add($tag1)
$tagspec2 = new-object Amazon.EC2.Model.TagSpecification
$tagspec2.ResourceType = "volume"
$tagspec2.Tags.Add($tag2)
New-EC2Instance -ImageId "ami-1a2b3c4d" -KeyName "my-key-pair" -MaxCount 2 -InstanceType "t2.large" -SubnetId "subnet-1a2b3c4d" -TagSpecification $tagspec1,$tagspec2
```
**Ejemplo 7: en este ejemplo se validan los permisos para lanzar una instancia EC2 mediante el DryRun parámetro sin crear realmente la instancia. Nota: Si se realiza correctamente, se produce una excepción, que es el comportamiento esperado. **
```
New-EC2Instance -ImageId 'ami-12345678' -InstanceType 't2.micro' -KeyName 'my-key-pair' -Region 'us-west-2' -DryRun $true
```
+ Para obtener más información sobre la API, consulte [RunInstances Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-EC2InstanceExportTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2InstanceExportTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se exporta una instancia detenida, `i-0800b00a00EXAMPLE`, como un disco duro virtual (VHD) al bucket de S3 `testbucket-export-instances-2019`. El entorno de destino es`Microsoft`, y el parámetro region se añade porque la instancia está en la `us-east-1` región, mientras que la AWS región predeterminada del usuario no es us-east-1. Para obtener el estado de la tarea de exportación, copie el valor de `ExportTaskId` de los resultados de este comando y ejecute `Get-EC2ExportTask -ExportTaskId export_task_ID_from_results.`**
```
New-EC2InstanceExportTask -InstanceId i-0800b00a00EXAMPLE -ExportToS3Task_DiskImageFormat VHD -ExportToS3Task_S3Bucket "amzn-s3-demo-bucket" -TargetEnvironment Microsoft -Region us-east-1
```
**Salida:**
```
Description :
ExportTaskId : export-i-077c73108aEXAMPLE
ExportToS3Task : Amazon.EC2.Model.ExportToS3Task
InstanceExportDetails : Amazon.EC2.Model.InstanceExportDetails
State : active
StatusMessage :
```
+ Para obtener más información sobre la API, consulte [CreateInstanceExportTask Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-EC2InternetGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2InternetGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una puerta de enlace de Internet.**
```
New-EC2InternetGateway
```
**Salida:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{} igw-1a2b3c4d {}
```
+ Para obtener más información sobre la API, consulte [CreateInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2KeyPair`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2KeyPair`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea un par de claves y captura la clave privada de RSA codificada en PEM en un archivo con el nombre especificado. Cuando se utiliza PowerShell, la codificación debe estar configurada en ascii para generar una clave válida. Para obtener más información, consulte Crear, mostrar y eliminar pares de claves de Amazon EC2 (https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-keypairs.html) en la Guía del usuario de la interfaz de línea de AWS comandos.**
```
(New-EC2KeyPair -KeyName "my-key-pair").KeyMaterial | Out-File -Encoding ascii -FilePath C:\path\my-key-pair.pem
```
+ Para obtener más información sobre la API, consulte [CreateKeyPair Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-EC2NetworkAcl`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2NetworkAcl`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una ACL de red para la VPC especificada.**
```
New-EC2NetworkAcl -VpcId vpc-12345678
```
**Salida:**
```
Associations : {}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {}
VpcId : vpc-12345678
```
+ Para obtener más información sobre la API, consulte [CreateNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2NetworkAclEntry`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2NetworkAclEntry`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una entrada para la ACL de red especificada. La regla permite la entrada de tráfico desde cualquier dirección (0.0.0.0/0) en el puerto UDP 53 (DNS) a cualquier subred asociada.**
```
New-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100 -Protocol 17 -PortRange_From 53 -PortRange_To 53 -CidrBlock 0.0.0.0/0 -RuleAction allow
```
+ Para obtener más información sobre la API, consulte [CreateNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2NetworkInterface`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2NetworkInterface`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la interfaz de red especificada.**
```
New-EC2NetworkInterface -SubnetId subnet-1a2b3c4d -Description "my network interface" -Group sg-12345678 -PrivateIpAddress 10.0.0.17
```
**Salida:**
```
Association :
Attachment :
AvailabilityZone : us-west-2c
Description : my network interface
Groups : {my-security-group}
MacAddress : 0a:72:bc:1a:cd:7f
NetworkInterfaceId : eni-12345678
OwnerId : 123456789012
PrivateDnsName : ip-10-0-0-17.us-west-2.compute.internal
PrivateIpAddress : 10.0.0.17
PrivateIpAddresses : {}
RequesterId :
RequesterManaged : False
SourceDestCheck : True
Status : pending
SubnetId : subnet-1a2b3c4d
TagSet : {}
VpcId : vpc-12345678
```
+ Para obtener más información sobre la API, consulte [CreateNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2PlacementGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2PlacementGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un grupo de ubicación con el nombre especificado.**
```
New-EC2PlacementGroup -GroupName my-placement-group -Strategy cluster
```
+ Para obtener más información sobre la API, consulte [CreatePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Route`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Route`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la ruta especificada para la tabla de enrutamiento especificada. La ruta coincide con todo el tráfico y lo dirige a la puerta de enlace de Internet especificada.**
```
New-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0 -GatewayId igw-1a2b3c4d
```
**Salida:**
```
True
```
+ Para obtener más información sobre la API, consulte [CreateRoute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2RouteTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2RouteTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una tabla de enrutamiento para la VPC especificada.**
```
New-EC2RouteTable -VpcId vpc-12345678
```
**Salida:**
```
Associations : {}
PropagatingVgws : {}
Routes : {}
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-12345678
```
+ Para obtener más información sobre la API, consulte [CreateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2ScheduledInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2ScheduledInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se lanza la instancia programada especificada.**
```
New-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012 -InstanceCount 1 `
-IamInstanceProfile_Name my-iam-role `
-LaunchSpecification_ImageId ami-12345678 `
-LaunchSpecification_InstanceType c4.large `
-LaunchSpecification_SubnetId subnet-12345678`
-LaunchSpecification_SecurityGroupId sg-12345678
```
+ Para obtener más información sobre la API, consulte [RunScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2ScheduledInstancePurchase`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2ScheduledInstancePurchase`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se compra una instancia programada.**
```
$request = New-Object Amazon.EC2.Model.PurchaseRequest
$request.InstanceCount = 1
$request.PurchaseToken = "eyJ2IjoiMSIsInMiOjEsImMiOi..."
New-EC2ScheduledInstancePurchase -PurchaseRequest $request
```
**Salida:**
```
AvailabilityZone : us-west-2b
CreateDate : 1/25/2016 1:43:38 PM
HourlyPrice : 0.095
InstanceCount : 1
InstanceType : c4.large
NetworkPlatform : EC2-VPC
NextSlotStartTime : 1/31/2016 1:00:00 AM
Platform : Linux/UNIX
PreviousSlotEndTime :
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
ScheduledInstanceId : sci-1234-1234-1234-1234-123456789012
SlotDurationInHours : 32
TermEndDate : 1/31/2017 1:00:00 AM
TermStartDate : 1/31/2016 1:00:00 AM
TotalScheduledInstanceHours : 1696
```
+ Para obtener más información sobre la API, consulte [PurchaseScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2SecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2SecurityGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un grupo de seguridad para la VPC especificada.**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group" -VpcId vpc-12345678
```
**Salida:**
```
sg-12345678
```
**Ejemplo 2: En este ejemplo se crea un grupo de seguridad para EC2-Classic.**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group"
```
**Salida:**
```
sg-45678901
```
+ Para obtener más información sobre la API, consulte [CreateSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Snapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una instantánea del volumen especificado.**
```
New-EC2Snapshot -VolumeId vol-12345678 -Description "This is a test"
```
**Salida:**
```
DataEncryptionKeyId :
Description : This is a test
Encrypted : False
KmsKeyId :
OwnerAlias :
OwnerId : 123456789012
Progress :
SnapshotId : snap-12345678
StartTime : 12/22/2015 1:28:42 AM
State : pending
StateMessage :
Tags : {}
VolumeId : vol-12345678
VolumeSize : 20
```
+ Para obtener más información sobre la API, consulte [CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2SpotDatafeedSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2SpotDatafeedSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la fuente de datos de una instancia de spot.**
```
New-EC2SpotDatafeedSubscription -Bucket amzn-s3-demo-bucket -Prefix spotdata
```
**Salida:**
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ Para obtener más información sobre la API, consulte [CreateSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Subnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Subnet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una subred para el CIDR especificado.**
```
New-EC2Subnet -VpcId vpc-12345678 -CidrBlock 10.0.0.0/24
```
**Salida:**
```
AvailabilityZone : us-west-2c
AvailableIpAddressCount : 251
CidrBlock : 10.0.0.0/24
DefaultForAz : False
MapPublicIpOnLaunch : False
State : pending
SubnetId : subnet-1a2b3c4d
Tag : {}
VpcId : vpc-12345678
```
+ Para obtener más información sobre la API, consulte [CreateSubnet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade una etiqueta única al recurso especificado. La clave de la etiqueta es 'myTag' y el valor de la etiqueta es ''. myTagValue La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
New-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag"; Value="myTagValue" }
```
**Ejemplo 2: En este ejemplo se actualizan o añaden las etiquetas especificadas al recurso especificado. La sintaxis utilizada en este ejemplo requiere PowerShell la versión 3 o superior.**
```
New-EC2Tag -Resource i-12345678 -Tag @( @{ Key="myTag"; Value="newTagValue" }, @{ Key="test"; Value="anotherTagValue" } )
```
**Ejemplo 3: Con la PowerShell versión 2, debe usar New-Object para crear la etiqueta para el parámetro Tag.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
New-EC2Tag -Resource i-12345678 -Tag $tag
```
+ Para obtener más información sobre la API, consulte [CreateTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-EC2Volume`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Volume`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea el volumen especificado.**
```
New-EC2Volume -Size 50 -AvailabilityZone us-west-2a -VolumeType gp2
```
**Salida:**
```
Attachments : {}
AvailabilityZone : us-west-2a
CreateTime : 12/22/2015 1:42:07 AM
Encrypted : False
Iops : 150
KmsKeyId :
Size : 50
SnapshotId :
State : creating
Tags : {}
VolumeId : vol-12345678
VolumeType : gp2
```
**Ejemplo 2: Esta solicitud de ejemplo crea un volumen y aplica una etiqueta con una clave de pila y un valor de producción.**
```
$tag = @{ Key="stack"; Value="production" }
$tagspec = new-object Amazon.EC2.Model.TagSpecification
$tagspec.ResourceType = "volume"
$tagspec.Tags.Add($tag)
New-EC2Volume -Size 80 -AvailabilityZone "us-west-2a" -TagSpecification $tagspec
```
+ Para obtener más información sobre la API, consulte [CreateVolume](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2Vpc`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2Vpc`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una VPC con el CIDR especificado. Amazon VPC también crea lo siguiente para la VPC: un conjunto de opciones de DHCP predeterminado, una tabla de enrutamiento principal y una ACL de red predeterminada.**
```
New-EC2VPC -CidrBlock 10.0.0.0/16
```
**Salida:**
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : pending
Tags : {}
VpcId : vpc-12345678
```
+ Para obtener más información sobre la API, consulte [CreateVpc](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2VpcEndpoint`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2VpcEndpoint`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo punto de conexión de VPC para el servicio com.amazonaws.eu-west-1.s3 en la VPC vpc-0fc1ff23f45b678eb**
```
New-EC2VpcEndpoint -ServiceName com.amazonaws.eu-west-1.s3 -VpcId vpc-0fc1ff23f45b678eb
```
**Salida:**
```
ClientToken VpcEndpoint
----------- -----------
Amazon.EC2.Model.VpcEndpoint
```
+ Para obtener más información sobre la API, consulte [CreateVpcEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2VpnConnection`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2VpnConnection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una conexión VPN entre la puerta de enlace privada virtual especificada y la puerta de enlace de cliente especificada. La salida incluye la información de configuración que el administrador de red necesita en formato XML.**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d
```
**Salida:**
```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId : cgw-1a2b3c4d
Options :
Routes : {}
State : pending
Tags : {}
Type :
VgwTelemetry : {}
VpnConnectionId : vpn-12345678
VpnGatewayId : vgw-1a2b3c4d
```
**Ejemplo 2: En este ejemplo se crea la conexión VPN y se captura la configuración en un archivo con el nombre especificado.**
```
(New-EC2VpnConnection -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d).CustomerGatewayConfiguration | Out-File C:\path\vpn-configuration.xml
```
**Ejemplo 3: En este ejemplo se crea una conexión VPN, con enrutamiento estático, entre la puerta de enlace privada virtual especificada y la puerta de enlace de cliente especificada.**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d -Options_StaticRoutesOnly $true
```
+ Para obtener más información sobre la API, consulte [CreateVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2VpnConnectionRoute`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2VpnConnectionRoute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la ruta estática especificada para la conexión VPN especificada.**
```
New-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
+ Para obtener más información sobre la API, consulte [CreateVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EC2VpnGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EC2VpnGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea la puerta de enlace privada virtual especificada.**
```
New-EC2VpnGateway -Type ipsec.1
```
**Salida:**
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {}
VpnGatewayId : vgw-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [CreateVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-EC2Address`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-EC2Address`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la dirección IP elástica especificada con la instancia especificada en una VPC.**
```
C:\> Register-EC2Address -InstanceId i-12345678 -AllocationId eipalloc-12345678
```
**Salida:**
```
eipassoc-12345678
```
**Ejemplo 2: En este ejemplo se asocia la dirección IP elástica especificada con la instancia especificada en EC2-Classic.**
```
C:\> Register-EC2Address -InstanceId i-12345678 -PublicIp 203.0.113.17
```
+ Para obtener más información sobre la API, consulte [AssociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-EC2DhcpOption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-EC2DhcpOption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia el conjunto de opciones de DHCP especificado a la VPC especificada.**
```
Register-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d -VpcId vpc-12345678
```
**Ejemplo 2: En este ejemplo se asocia el conjunto de opciones de DHCP predeterminado a la VPC especificada.**
```
Register-EC2DhcpOption -DhcpOptionsId default -VpcId vpc-12345678
```
+ Para obtener más información sobre la API, consulte [AssociateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra una AMI mediante el archivo de manifiesto especificado en Amazon S3.**
```
Register-EC2Image -ImageLocation amzn-s3-demo-bucket/my-web-server-ami/image.manifest.xml -Name my-web-server-ami
```
+ Para obtener más información sobre la API, consulte [RegisterImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-EC2PrivateIpAddress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-EC2PrivateIpAddress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asigna la dirección IP privada secundaria especificada a la interfaz de red especificada.**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
**Ejemplo 2: En este ejemplo se asignan dos direcciones IP privadas secundarias a la interfaz de red especificada.**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -SecondaryPrivateIpAddressCount 2
```
+ Para obtener más información sobre la API, consulte [AssignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-EC2RouteTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-EC2RouteTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la tabla de enrutamiento especificada a la subred especificada.**
```
Register-EC2RouteTable -RouteTableId rtb-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**Salida:**
```
rtbassoc-12345678
```
+ Para obtener más información sobre la API, consulte [AssociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Address`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Address`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se publica la dirección IP elástica especificada para las instancias de una VPC.**
```
Remove-EC2Address -AllocationId eipalloc-12345678 -Force
```
**Ejemplo 2: En este ejemplo se publica la dirección IP elástica especificada para las instancias de EC2-Classic.**
```
Remove-EC2Address -PublicIp 198.51.100.2 -Force
```
+ Para obtener más información sobre la API, consulte [ReleaseAddress](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2CapacityReservation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2CapacityReservation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela la reserva de capacidad cr-0c1f2345db6f7cdba**
```
Remove-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2CapacityReservation (CancelCapacityReservation)" on target "cr-0c1f2345db6f7cdba".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
True
```
+ Para obtener más información sobre la API, consulte [CancelCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2CustomerGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2CustomerGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la puerta de enlace de cliente especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2CustomerGateway (DeleteCustomerGateway)" on Target "cgw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2DhcpOption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2DhcpOption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el conjunto de opciones de DHCP especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2DhcpOption (DeleteDhcpOptions)" on Target "dopt-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2FlowLog`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2FlowLog`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina el fl-01a2b3456a789c01 dado FlowLogId **
```
Remove-EC2FlowLog -FlowLogId fl-01a2b3456a789c01
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2FlowLog (DeleteFlowLogs)" on target "fl-01a2b3456a789c01".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ *Para obtener información sobre la API, consulte Cmdlet Reference (V5). [DeleteFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Remove-EC2Host`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Host`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se publica el ID de host especificado h-0badafd1dcb2f3456.**
```
Remove-EC2Host -HostId h-0badafd1dcb2f3456
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Host (ReleaseHosts)" on target "h-0badafd1dcb2f3456".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Successful Unsuccessful
---------- ------------
{h-0badafd1dcb2f3456} {}
```
+ Para obtener más información sobre la API, consulte [ReleaseHosts](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo finaliza la instancia especificada (la instancia puede estar en ejecución o en estado “detenido”). El cmdlet pedirá confirmación antes de continuar con la operación; para suprimir la confirmación, utilice el modificador -Force.**
```
Remove-EC2Instance -InstanceId i-12345678
```
**Salida:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ Para obtener más información sobre la API, consulte [TerminateInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2InternetGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2InternetGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la puerta de enlace de Internet especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2InternetGateway (DeleteInternetGateway)" on Target "igw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2KeyPair`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2KeyPair`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el par de claves especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2KeyPair -KeyName my-key-pair
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2KeyPair (DeleteKeyPair)" on Target "my-key-pair".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2NetworkAcl`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2NetworkAcl`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la ACL de red especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2NetworkAcl -NetworkAclId acl-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkAcl (DeleteNetworkAcl)" on Target "acl-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2NetworkAclEntry`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2NetworkAclEntry`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la regla especificada de la ACL de red especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkAclEntry (DeleteNetworkAclEntry)" on Target "acl-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2NetworkInterface`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2NetworkInterface`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la interfaz de red especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkInterface (DeleteNetworkInterface)" on Target "eni-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2PlacementGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2PlacementGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de ubicación especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2PlacementGroup -GroupName my-placement-group
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2PlacementGroup (DeletePlacementGroup)" on Target "my-placement-group".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeletePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Route`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Route`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la ruta especificada de la tabla de enrutamiento especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Route (DeleteRoute)" on Target "rtb-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteRoute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2RouteTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2RouteTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la tabla de enrutamiento especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2RouteTable (DeleteRouteTable)" on Target "rtb-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2SecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2SecurityGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de seguridad especificado para EC2-VPC. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2SecurityGroup -GroupId sg-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2SecurityGroup (DeleteSecurityGroup)" on Target "sg-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: En este ejemplo se elimina el grupo de seguridad especificado para EC2-Classic.**
```
Remove-EC2SecurityGroup -GroupName my-security-group -Force
```
+ Para obtener más información sobre la API, consulte [DeleteSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Snapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Snapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la instantánea especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2Snapshot -SnapshotId snap-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Snapshot (DeleteSnapshot)" on target "snap-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2SpotDatafeedSubscription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2SpotDatafeedSubscription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la fuente de datos de la instancia de spot. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2SpotDatafeedSubscription
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2SpotDatafeedSubscription (DeleteSpotDatafeedSubscription)" on Target "".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Subnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Subnet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la subred especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Subnet (DeleteSubnet)" on Target "subnet-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteSubnet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta especificada del recurso especificado, independientemente del valor de la etiqueta. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag" } -Force
```
**Ejemplo 2: En este ejemplo se elimina la etiqueta especificada del recurso especificado, pero solo si coincide el valor de la etiqueta. La sintaxis utilizada en este ejemplo requiere PowerShell la versión 3 o posterior.**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag";Value="myTagValue" } -Force
```
**Ejemplo 3: En este ejemplo se elimina la etiqueta especificada del recurso especificado, independientemente del valor de la etiqueta.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
**Ejemplo 4: En este ejemplo se elimina la etiqueta especificada del recurso especificado, pero solo si coincide el valor de la etiqueta.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
+ Para obtener más información sobre la API, consulte [DeleteTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-EC2Volume`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Volume`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desconecta el volumen especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2Volume -VolumeId vol-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Volume (DeleteVolume)" on target "vol-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteVolume](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2Vpc`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2Vpc`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la VPC especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2Vpc -VpcId vpc-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Vpc (DeleteVpc)" on Target "vpc-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteVpc](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2VpnConnection`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2VpnConnection`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la conexión VPN especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnConnection (DeleteVpnConnection)" on Target "vpn-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2VpnConnectionRoute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2VpnConnectionRoute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la ruta estática especificada de la conexión VPN especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnConnectionRoute (DeleteVpnConnectionRoute)" on Target "vpn-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EC2VpnGateway`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EC2VpnGateway`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la puerta de enlace privada virtual especificada. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnGateway (DeleteVpnGateway)" on Target "vgw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Request-EC2SpotFleet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Request-EC2SpotFleet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una solicitud de flota de spot en la zona de disponibilidad con el precio más bajo para el tipo de instancia especificado. Si su cuenta admite EC2-VPC únicamente, la flota de spot lanza las instancias de spot en la zona de disponibilidad con el precio más bajo que tenga una subred predeterminada. Si su cuenta admite EC2-Classic, la flota de spot lanza las instancias en EC2-Classic en la zona de disponibilidad con el precio más bajo. Tenga en cuenta que el precio que pague no superará el precio de spot especificado para la solicitud.**
```
$sg = New-Object Amazon.EC2.Model.GroupIdentifier
$sg.GroupId = "sg-12345678"
$lc = New-Object Amazon.EC2.Model.SpotFleetLaunchSpecification
$lc.ImageId = "ami-12345678"
$lc.InstanceType = "m3.medium"
$lc.SecurityGroups.Add($sg)
Request-EC2SpotFleet -SpotFleetRequestConfig_SpotPrice 0.04 `
-SpotFleetRequestConfig_TargetCapacity 2 `
-SpotFleetRequestConfig_IamFleetRole arn:aws:iam::123456789012:role/my-spot-fleet-role `
-SpotFleetRequestConfig_LaunchSpecification $lc
```
+ Para obtener más información sobre la API, consulte [RequestSpotFleet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Request-EC2SpotInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Request-EC2SpotInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se solicita una instancia de spot única en la subred especificada. Tenga en cuenta que el grupo de seguridad debe crearse para la VPC que contiene la subred especificada y debe especificarse mediante un ID usando la interfaz de red. Si especifica una interfaz de red, debe incluir el ID de subred mediante la interfaz de red.**
```
$n = New-Object Amazon.EC2.Model.InstanceNetworkInterfaceSpecification
$n.DeviceIndex = 0
$n.SubnetId = "subnet-12345678"
$n.Groups.Add("sg-12345678")
Request-EC2SpotInstance -InstanceCount 1 -SpotPrice 0.050 -Type one-time `
-IamInstanceProfile_Arn arn:aws:iam::123456789012:instance-profile/my-iam-role `
-LaunchSpecification_ImageId ami-12345678 `
-LaunchSpecification_InstanceType m3.medium `
-LaunchSpecification_NetworkInterface $n
```
**Salida:**
```
ActualBlockHourlyPrice :
AvailabilityZoneGroup :
BlockDurationMinutes : 0
CreateTime : 12/26/2015 7:44:10 AM
Fault :
InstanceId :
LaunchedAvailabilityZone :
LaunchGroup :
LaunchSpecification : Amazon.EC2.Model.LaunchSpecification
ProductDescription : Linux/UNIX
SpotInstanceRequestId : sir-12345678
SpotPrice : 0.050000
State : open
Status : Amazon.EC2.Model.SpotInstanceStatus
Tags : {}
Type : one-time
```
+ Para obtener más información sobre la API, consulte [RequestSpotInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Reset-EC2ImageAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-EC2ImageAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se restablece el atributo “launchPermission” en su valor predeterminado. De forma predeterminada, AMIs son privadas.**
```
Reset-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
+ Para obtener más información sobre la API, consulte [ResetImageAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Reset-EC2InstanceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-EC2InstanceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se restablece el atributo 'sriovNetSupport' de la instancia especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**Ejemplo 2: En este ejemplo se restablece el atributo “ebsOptimized” de la instancia especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**Ejemplo 3: en este ejemplo se restablece el atributo 'sourceDestCheck' de la instancia especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sourceDestCheck
```
**Ejemplo 4: en este ejemplo se restablece el atributo 'disableApiTermination' de la instancia especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**Ejemplo 5: en este ejemplo se restablece el atributo 'instanceInitiatedShutdownBehavior' de la instancia especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ResetInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Reset-EC2NetworkInterfaceAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-EC2NetworkInterfaceAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se restablece la source/destination comprobación de la interfaz de red especificada.**
```
Reset-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck
```
+ Para obtener más información sobre la API, consulte [ResetNetworkInterfaceAttribute Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Reset-EC2SnapshotAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-EC2SnapshotAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se restablece el atributo especificado de la instantánea especificada.**
```
Reset-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission
```
+ Para obtener más información sobre la API, consulte [ResetSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Restart-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Restart-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reinicia la instancia especificada.**
```
Restart-EC2Instance -InstanceId i-12345678
```
+ Para obtener más información sobre la API, consulte [RebootInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Revoke-EC2SecurityGroupEgress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Revoke-EC2SecurityGroupEgress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la regla del grupo de seguridad especificado para EC2-VPC. Esto revoca el acceso en el puerto TCP 80 al intervalo de direcciones IP especificado. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear el IpPermission objeto.**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 80
$ip.ToPort = 80
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 3: En este ejemplo se revoca el acceso al grupo de seguridad de origen especificado en el puerto TCP 80.**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; UserIdGroupPairs=$ug } )
```
+ Para obtener más información sobre la API, consulte [RevokeSecurityGroupEgress Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Revoke-EC2SecurityGroupIngress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Revoke-EC2SecurityGroupIngress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se revoca el acceso al puerto TCP 22 desde el intervalo de direcciones especificado para el grupo de seguridad especificado para EC2-VPC. Además, debe identificar los grupos de seguridad de EC2-VPC mediante el ID del grupo de seguridad, en lugar del nombre del grupo de seguridad. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear el IpPermission objeto.**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 22
$ip.ToPort = 22
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission $ip
```
**Ejemplo 3: En este ejemplo se revoca el acceso al puerto TCP 22 desde el intervalo de direcciones especificado para el grupo de seguridad especificado para EC2-Classic. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission $ip
```
**Ejemplo 4: Con la PowerShell versión 2, debe usar New-Object para crear el IpPermission objeto.**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 22
$ip.ToPort = 22
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission $ip
```
+ Para obtener más información sobre la API, consulte [RevokeSecurityGroupIngress Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Send-EC2InstanceStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-EC2InstanceStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registran los comentarios de estado de la instancia especificada.**
```
Send-EC2InstanceStatus -Instance i-12345678 -Status impaired -ReasonCode unresponsive
```
+ Para obtener más información sobre la API, consulte [ReportInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-EC2NetworkAclAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-EC2NetworkAclAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la ACL de red especificada a la subred para la asociación de ACL de red especificada.**
```
Set-EC2NetworkAclAssociation -NetworkAclId acl-12345678 -AssociationId aclassoc-1a2b3c4d
```
**Salida:**
```
aclassoc-87654321
```
+ Para obtener más información sobre la API, consulte [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-EC2NetworkAclEntry`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-EC2NetworkAclEntry`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reemplaza la entrada especificada para la ACL de red especificada. La nueva regla permite el tráfico entrante desde la dirección especificada a cualquier subred asociada.**
```
Set-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100 -Protocol 17 -PortRange_From 53 -PortRange_To 53 -CidrBlock 203.0.113.12/24 -RuleAction allow
```
+ Para obtener más información sobre la API, consulte [ReplaceNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-EC2Route`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-EC2Route`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reemplaza la ruta especificada para la tabla de enrutamiento especificada. La nueva ruta envía el tráfico especificado a la puerta de enlace privada virtual especificada.**
```
Set-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 10.0.0.0/24 -GatewayId vgw-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [ReplaceRoute](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-EC2RouteTableAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-EC2RouteTableAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la tabla de enrutamiento especificada a la subred para la asociación de tabla de enrutamiento especificada.**
```
Set-EC2RouteTableAssociation -RouteTableId rtb-1a2b3c4d -AssociationId rtbassoc-12345678
```
**Salida:**
```
rtbassoc-87654321
```
+ Para obtener más información sobre la API, consulte [ReplaceRouteTableAssociation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se inicia la instancia especificada.**
```
Start-EC2Instance -InstanceId i-12345678
```
**Salida:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
**Ejemplo 2: En este ejemplo se inician las instancias especificadas.**
```
@("i-12345678", "i-76543210") | Start-EC2Instance
```
**Ejemplo 3: En este ejemplo se inicia el conjunto de instancias que están detenidas actualmente. Los objetos de instancia devueltos por Get-EC2Instance se canalizan a. Start-EC2Instance La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o superior.**
```
(Get-EC2Instance -Filter @{ Name="instance-state-name"; Values="stopped"}).Instances | Start-EC2Instance
```
**Ejemplo 4: Con la PowerShell versión 2, debe usar New-Object para crear el filtro para el parámetro Filter.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "instance-state-name"
$filter.Values = "stopped"
(Get-EC2Instance -Filter $filter).Instances | Start-EC2Instance
```
**Ejemplo 5: en este ejemplo se validan los permisos para iniciar una instancia de EC2 mediante el DryRun parámetro sin iniciar realmente la instancia. Nota: Si se realiza correctamente, se produce una excepción, que es el comportamiento esperado.**
```
Start-EC2Instance -InstanceId 'i-0abcdef123456' -Region 'us-west-1' -DryRun $true
```
+ Para obtener más información sobre la API, consulte [StartInstances Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Start-EC2InstanceMonitoring`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-EC2InstanceMonitoring`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita la supervisión detallada de la instancia especificada.**
```
Start-EC2InstanceMonitoring -InstanceId i-12345678
```
**Salida:**
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ Para obtener más información sobre la API, consulte [MonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-EC2ImportTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-EC2ImportTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela la tarea de importación especificada (importación de instantáneas o imágenes). Si es necesario, se puede proporcionar un motivo mediante el parámetro `-CancelReason`.**
```
Stop-EC2ImportTask -ImportTaskId import-ami-abcdefgh
```
+ Para obtener más información sobre la API, consulte [CancelImportTask](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-EC2Instance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-EC2Instance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se detiene la instancia especificada.**
```
Stop-EC2Instance -InstanceId i-12345678
```
**Salida:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ Para obtener más información sobre la API, consulte [StopInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-EC2InstanceMonitoring`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-EC2InstanceMonitoring`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se deshabilita la supervisión detallada de la instancia especificada.**
```
Stop-EC2InstanceMonitoring -InstanceId i-12345678
```
**Salida:**
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ Para obtener más información sobre la API, consulte [UnmonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-EC2SpotFleetRequest`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-EC2SpotFleetRequest`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela la solicitud de flota de spot especificada y se terminan las instancias de spot asociadas.**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $true
```
**Ejemplo 2: En este ejemplo se cancela la solicitud de flota de spot especificada sin que se terminan las instancias de spot asociadas.**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $false
```
+ Para obtener más información sobre la API, consulte [CancelSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-EC2SpotInstanceRequest`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-EC2SpotInstanceRequest`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cancela la solicitud de instancia de spot especificada.**
```
Stop-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**Salida:**
```
SpotInstanceRequestId State
--------------------- -----
sir-12345678 cancelled
```
+ Para obtener más información sobre la API, consulte [CancelSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-EC2Address`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-EC2Address`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desvincula la dirección IP elástica especificada de la instancia especificada en una VPC.**
```
Unregister-EC2Address -AssociationId eipassoc-12345678
```
**Ejemplo 2: En este ejemplo se desvincula la dirección IP elástica especificada de la instancia especificada en EC2-Classic.**
```
Unregister-EC2Address -PublicIp 203.0.113.17
```
+ Para obtener más información sobre la API, consulte [DisassociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-EC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-EC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se anula el registro de la AMI especificada.**
```
Unregister-EC2Image -ImageId ami-12345678
```
+ Para obtener más información sobre la API, consulte [DeregisterImage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-EC2PrivateIpAddress`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-EC2PrivateIpAddress`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se anula la asignación de la dirección IP privada especificada de la interfaz de red especificada.**
```
Unregister-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
+ Para obtener más información sobre la API, consulte [UnassignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-EC2RouteTable`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-EC2RouteTable`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la asociación especificada entre una tabla de enrutamiento y una subred.**
```
Unregister-EC2RouteTable -AssociationId rtbassoc-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DisassociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-EC2SecurityGroupRuleIngressDescription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-EC2SecurityGroupRuleIngressDescription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Actualiza la descripción de una regla del grupo de seguridad de entrada existente.**
```
$existingInboundRule = Get-EC2SecurityGroupRule -SecurityGroupRuleId "sgr-1234567890"
$ruleWithUpdatedDescription = [Amazon.EC2.Model.SecurityGroupRuleDescription]@{
"SecurityGroupRuleId" = $existingInboundRule.SecurityGroupRuleId
"Description" = "Updated rule description"
}
Update-EC2SecurityGroupRuleIngressDescription -GroupId $existingInboundRule.GroupId -SecurityGroupRuleDescription $ruleWithUpdatedDescription
```
**Ejemplo 2: Elimina la descripción de una regla de grupo de seguridad de entrada (entrante) existente (omitiendo el parámetro de la solicitud).**
```
$existingInboundRule = Get-EC2SecurityGroupRule -SecurityGroupRuleId "sgr-1234567890"
$ruleWithoutDescription = [Amazon.EC2.Model.SecurityGroupRuleDescription]@{
"SecurityGroupRuleId" = $existingInboundRule.SecurityGroupRuleId
}
Update-EC2SecurityGroupRuleIngressDescription -GroupId $existingInboundRule.GroupId -SecurityGroupRuleDescription $ruleWithoutDescription
```
+ Para obtener más información sobre la API, consulte [UpdateSecurityGroupRuleDescriptionsIngress](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon ECR con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon ECR.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-ECRLoginCommand`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ECRLoginCommand`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: Devuelve una información de PSObject inicio de sesión que se puede utilizar para autenticarse en cualquier registro de Amazon ECR al que tenga acceso su director de IAM. Las credenciales y el punto de conexión regional necesarios para que la llamada obtenga el token de autorización se obtienen de los valores predeterminados del intérprete de comandos (configurados por los cmdlets `Set-AWSCredential/Set-DefaultAWSRegion` o `Initialize-AWSDefaultConfiguration`). Puede usar la propiedad Command con Invoke-Expression para iniciar sesión en el registro especificado o usar las credenciales devueltas en otras herramientas que requieran iniciar sesión.**
```
Get-ECRLoginCommand
```
**Salida:**
```
Username : AWS
Password : eyJwYXlsb2Fk...kRBVEFfS0VZIn0=
ProxyEndpoint : https://123456789012.dkr.ecr.us-west-2.amazonaws.com
Endpoint : https://123456789012.dkr.ecr.us-west-2.amazonaws.com
ExpiresAt : 9/26/2017 6:08:23 AM
Command : docker login --username AWS --password eyJwYXlsb2Fk...kRBVEFfS0VZIn0= https://123456789012.dkr.ecr.us-west-2.amazonaws.com
```
**Ejemplo 2: recupera una información de inicio PSObject de sesión que se utiliza como entrada para un comando de inicio de sesión de docker. Puede especificar cualquier URI de registro de Amazon ECR en la que se autentique, siempre que su entidad principal de IAM tenga acceso a ese registro.**
```
(Get-ECRLoginCommand).Password | docker login --username AWS --password-stdin 012345678910.dkr.ecr.us-east-1.amazonaws.com
```
+ Para obtener información sobre la API, consulte [Get- ECRLogin Command](https://docs.aws.amazon.com/powershell/v5/reference) en *Herramientas de AWS para PowerShell Cmdlet Reference* (V5).
# Ejemplos de Amazon ECS con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon ECS.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-ECSClusterDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ECSClusterDetail`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este cmdlet describe uno o varios de los clústeres de ECS.**
```
Get-ECSClusterDetail -Cluster "LAB-ECS-CL" -Include SETTINGS | Select-Object *
```
**Salida:**
```
LoggedAt : 12/27/2019 9:27:41 PM
Clusters : {LAB-ECS-CL}
Failures : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 396
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [DescribeClusters](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ECSClusterList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ECSClusterList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet devuelve una lista de los clústeres de ECS existentes.**
```
Get-ECSClusterList
```
**Salida:**
```
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS
```
+ Para obtener más información sobre la API, consulte [ListClusters](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ECSClusterService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ECSClusterService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran todos los servicios que se ejecutan en el clúster predeterminado.**
```
Get-ECSClusterService
```
**Ejemplo 2: En este ejemplo se muestran todos los servicios que se ejecutan en el clúster especificado.**
```
Get-ECSClusterService -Cluster myCluster
```
+ Para obtener más información sobre la API, consulte [ListServices](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ECSService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ECSService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra cómo recuperar los detalles de un servicio específico del clúster predeterminado.**
```
Get-ECSService -Service my-hhtp-service
```
**Ejemplo 2: En este ejemplo se muestra cómo recuperar los detalles de un servicio específico que se está ejecutando en el clúster designado.**
```
Get-ECSService -Cluster myCluster -Service my-hhtp-service
```
+ Para obtener más información sobre la API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ECSCluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ECSCluster`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet crea un nuevo clúster de Amazon ECS.**
```
New-ECSCluster -ClusterName "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="enabled"}
```
**Salida:**
```
ActiveServicesCount : 0
Attachments : {}
AttachmentsStatus :
CapacityProviders : {}
ClusterArn : arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
ClusterName : LAB-ECS-CL
DefaultCapacityProviderStrategy : {}
PendingTasksCount : 0
RegisteredContainerInstancesCount : 0
RunningTasksCount : 0
Settings : {containerInsights}
Statistics : {}
Status : ACTIVE
Tags : {}
```
+ Para obtener más información sobre la API, consulte [CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ECSService`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ECSService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando de ejemplo crea un servicio en el clúster predeterminado llamado `ecs-simple-service`. El servicio utiliza la definición de la tarea “ecs-demo” y mantiene 10 instancias de la tarea.**
```
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10
```
**Ejemplo 2: Este comando de ejemplo crea un servicio detrás de un balanceador de carga en tu clúster predeterminado llamado `ecs-simple-service`. El servicio utiliza la definición de la tarea “ecs-demo” y mantiene 10 instancias de la tarea.**
```
$lb = @{
LoadBalancerName = "EC2Contai-EcsElast-S06278JGSJCM"
ContainerName = "simple-demo"
ContainerPort = 80
}
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10 -LoadBalancer $lb
```
+ Para obtener información sobre la API, consulte [CreateService Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-ECSCluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ECSCluster`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina el clúster de ECS especificado. Debe anular el registro de todas las instancias de contenedor de este clúster para poder eliminarlo.**
```
Remove-ECSCluster -Cluster "LAB-ECS"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ECSCluster (DeleteCluster)" on target "LAB-ECS".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ECSService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ECSService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina el servicio denominado 'my-http-service' del clúster predeterminado. El servicio debe tener establecido el recuento deseado y el recuento de ejecución en 0 para poder eliminarlo. Se le solicitará confirmación antes de que se ejecute el comando. Para omitir la petición de confirmación, añada el modificador -Force al comando.**
```
Remove-ECSService -Service my-http-service
```
**Ejemplo 2: Elimina el servicio denominado 'my-http-service' del clúster nombrado.**
```
Remove-ECSService -Cluster myCluster -Service my-http-service
```
+ Para obtener más información sobre la API, consulte [DeleteService Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Update-ECSClusterSetting`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-ECSClusterSetting`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet modifica la configuración que se usa para un clúster de ECS.**
```
Update-ECSClusterSetting -Cluster "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="disabled"}
```
**Salida:**
```
ActiveServicesCount : 0
Attachments : {}
AttachmentsStatus :
CapacityProviders : {}
ClusterArn : arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
ClusterName : LAB-ECS-CL
DefaultCapacityProviderStrategy : {}
PendingTasksCount : 0
RegisteredContainerInstancesCount : 0
RunningTasksCount : 0
Settings : {containerInsights}
Statistics : {}
Status : ACTIVE
Tags : {}
```
+ Para obtener más información sobre la API, consulte [UpdateClusterSettings](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-ECSService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-ECSService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando de ejemplo actualiza el servicio `my-http-service` para usar la definición de tarea amazon-ecs-sample ``.**
```
Update-ECSService -Service my-http-service -TaskDefinition amazon-ecs-sample
```
**Ejemplo 2: Este comando de ejemplo actualiza el recuento deseado del servicio my-http-service `` a 10.**
```
Update-ECSService -Service my-http-service -DesiredCount 10
```
+ Para obtener más información sobre la API, consulte [UpdateService Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
# Ejemplos de Amazon EFS con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon EFS.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Edit-EFSMountTargetSecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-EFSMountTargetSecurityGroup`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Actualiza los grupos de seguridad en vigor para el destino de montaje especificado. Se pueden especificar hasta cinco con el formato “sg-xxxxxxxx”.**
```
Edit-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d -SecurityGroup sg-group1,sg-group3
```
+ Para obtener más información sobre la API, consulte [ModifyMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EFSFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EFSFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve de la colección de todos los sistemas de archivos que son propiedad de la cuenta del autor de la llamada en la región.**
```
Get-EFSFileSystem
```
**Salida:**
```
CreationTime : 5/26/2015 4:02:38 PM
CreationToken : 1a2bff54-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-1a2b3c4d
LifeCycleState : available
Name :
NumberOfMountTargets : 0
OwnerId : 123456789012
SizeInBytes : Amazon.ElasticFileSystem.Model.FileSystemSize
CreationTime : 5/26/2015 4:06:23 PM
CreationToken : 2b4daa14-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-4d3c2b1a
...
```
**Ejemplo 2: Devuelve información detallada del sistema de archivos especificado.**
```
Get-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
**Ejemplo 3: Devuelve los detalles de un sistema de archivos mediante el token de creación de idempotencia que se especificó en el momento de la creación del sistema de archivos.**
```
Get-EFSFileSystem -CreationToken 1a2bff54-85e0-4747-bd95-7bc172c4f555
```
+ Para obtener más información sobre la API, consulte [DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EFSMountTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EFSMountTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la colección de destinos de montaje asociada al sistema de archivos especificado.**
```
Get-EFSMountTarget -FileSystemId fs-1a2b3c4d
```
**Salida:**
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : available
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DescribeMountTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EFSMountTargetSecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EFSMountTargetSecurityGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los identificadores de los grupos de seguridad actualmente asignados a la interfaz de red asociada al destino de montaje.**
```
Get-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d
```
**Salida:**
```
sg-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DescribeMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EFSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EFSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la colección de etiquetas asociada actualmente al sistema de archivos especificado.**
```
Get-EFSTag -FileSystemId fs-1a2b3c4d
```
**Salida:**
```
Key Value
--- -----
Name My File System
tagkey1 tagvalue1
tagkey2 tagvalue2
```
+ Para obtener más información sobre la API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EFSFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EFSFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un nuevo sistema de archivos vacío. El token utilizado para garantizar la creación idempotente se generará automáticamente y se podrá acceder a él desde el miembro `CreationToken` del objeto devuelto.**
```
New-EFSFileSystem
```
**Salida:**
```
CreationTime : 5/26/2015 4:02:38 PM
CreationToken : 1a2bff54-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-1a2b3c4d
LifeCycleState : creating
Name :
NumberOfMountTargets : 0
OwnerId : 123456789012
SizeInBytes : Amazon.ElasticFileSystem.Model.FileSystemSize
```
**Ejemplo 2: Crea un nuevo sistema de archivos vacío mediante un token personalizado para garantizar la creación idempotente.**
```
New-EFSFileSystem -CreationToken "MyUniqueToken"
```
+ Para obtener más información sobre la API, consulte [CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EFSMountTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EFSMountTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un nuevo destino de montaje para un sistema de archivos. La subred especificada se utilizará para determinar la nube privada virtual (VPC) en la que se creará el destino de montaje y la dirección IP que se asignará automáticamente (del intervalo de direcciones de la subred). La dirección IP asignada se puede usar para luego montar este sistema de archivos en una instancia de Amazon EC2. Como no se especificó ningún grupo de seguridad, la interfaz de red creada para el destino se asocia al grupo de seguridad predeterminado de la VPC de la subred.**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**Salida:**
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : creating
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
**Ejemplo 2: Crea un nuevo destino de montaje para el sistema de archivos especificado con una dirección IP asignada automáticamente. La interfaz de red creada para el destino de montaje está asociada a los grupos de seguridad especificados (se pueden especificar hasta cinco, con el formato “sg-xxxxxxxx”).**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -SecurityGroup sg-group1,sg-group2,sg-group3
```
**Ejemplo 3: Crea un nuevo destino de montaje para el sistema de archivos especificado con la dirección IP especificada.**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -IpAddress 10.0.0.131
```
+ Para obtener más información sobre la API, consulte [CreateMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EFSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EFSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Aplica la colección de etiquetas al sistema de archivos especificado. Si ya existe una etiqueta con la clave especificada en el sistema de archivos, se actualiza el valor de la etiqueta.**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="tagkey1";Value="tagvalue1"},@{Key="tagkey2";Value="tagvalue2"}
```
**Ejemplo 2: Establece la etiqueta name para el sistema de archivos especificado. Este valor se devuelve junto con otros detalles del sistema de archivos cuando se utiliza el Get-EFSFileSystem cmdlet.**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="Name";Value="My File System"}
```
+ Para obtener información sobre la API, consulte [CreateTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Remove-EFSFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EFSFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina el sistema de archivos especificado que ya no está en uso (si el sistema de archivos tiene destinos de montaje, primero hay que eliminarlos). Se le solicitará confirmación antes de continuar con la operación; para suprimir la confirmación, utilice el modificador `-Force`.**
```
Remove-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EFSMountTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EFSMountTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina el destino de montaje especificado. Se le solicitará una confirmación antes de continuar con la operación. Para suprimir la petición, utilice el modificador `-Force`. Tenga en cuenta que esta operación interrumpe por la fuerza cualquier montaje del sistema de archivos a través del destino; si es viable, puede considerar la posibilidad de desmontar el sistema de archivos antes de ejecutar este comando.**
```
Remove-EFSMountTarget -MountTargetId fsmt-1a2b3c4d
```
+ Para obtener más información sobre la API, consulte [DeleteMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EFSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EFSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina la colección de una o varias etiquetas de un sistema de archivos. Se le solicitará confirmación antes de continuar con la operación; para suprimir la confirmación, utilice el modificador `-Force`.**
```
Remove-EFSTag -FileSystemId fs-1a2b3c4d -TagKey "tagkey1","tagkey2"
```
+ Para obtener más información sobre la API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon EKS con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon EKS.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-EKSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-EKSResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este cmdlet asocia las etiquetas especificadas a un recurso con el resourceArn especificado.**
```
Add-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -Tag @{Name = "EKSPRODCLUSTER"}
```
+ Para obtener más información sobre la API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EKSCluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSCluster`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet devuelve información descriptiva sobre un clúster de Amazon EKS.**
```
Get-EKSCluster -Name "PROD"
```
**Salida:**
```
Arn : arn:aws:eks:us-west-2:012345678912:cluster/PROD
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 6:46:17 AM
Endpoint : https://669608765450FBBE54D1D78A3D71B72C.gr8.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : PROD
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : ACTIVE
Tags : {}
Version : 1.14
```
+ Para obtener más información sobre la API, consulte [DescribeCluster](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EKSClusterList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSClusterList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra los clústeres de Amazon EKS de la Cuenta de AWS región especificada.**
```
Get-EKSClusterList
```
**Salida:**
```
PROD
```
+ Para obtener más información sobre la API, consulte [ListClusters Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-EKSFargateProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSFargateProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este cmdlet devuelve información descriptiva sobre un perfil de Fargate AWS .**
```
Get-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Salida:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : ACTIVE
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EKSFargateProfileList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSFargateProfileList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra los perfiles de AWS Fargate asociados al clúster especificado en la región especificada. Cuenta de AWS **
```
Get-EKSFargateProfileList -ClusterName "TEST"
```
**Salida:**
```
EKSFargate
EKSFargateProfile
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ListFargateProfiles](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-EKSNodegroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSNodegroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet devuelve información descriptiva sobre un grupo de nodos de Amazon EKS.**
```
Get-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Salida:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ Para obtener más información sobre la API, consulte [DescribeNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EKSNodegroupList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSNodegroupList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra los grupos de nodos de Amazon EKS asociados al clúster especificado Cuenta de AWS en la región especificada.**
```
Get-EKSNodegroupList -ClusterName PROD
```
**Salida:**
```
ProdEKSNodeGroup
```
+ Para obtener más información sobre la API, consulte [ListNodegroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia del Herramientas de AWS para PowerShell cmdlet (V5*).
### `Get-EKSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra las etiquetas de un recurso de Amazon EKS.**
```
Get-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD"
```
**Salida:**
```
Key Value
--- -----
Name EKSPRODCLUSTER
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EKSUpdate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSUpdate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet devuelve información descriptiva sobre una actualización del clúster de Amazon EKS o del grupo de nodos administrados asociado.**
```
Get-EKSUpdate -Name "PROD" -UpdateId "ee708232-7d2e-4ed7-9270-d0b5176f0726"
```
**Salida:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : Successful
Type : LoggingUpdate
```
+ Para obtener más información sobre la API, consulte [DescribeUpdate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-EKSUpdateList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-EKSUpdateList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet muestra las actualizaciones asociadas a un clúster o grupo de nodos gestionados de Amazon EKS en su Cuenta de AWS región especificada.**
```
Get-EKSUpdateList -Name "PROD"
```
**Salida:**
```
ee708232-7d2e-4ed7-9270-d0b5176f0726
```
+ Para obtener más información sobre la API, consulte [ListUpdates Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-EKSCluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EKSCluster`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo clúster denominado “prod”.**
```
New-EKSCluster -Name prod -ResourcesVpcConfig @{SubnetIds=@("subnet-0a1b2c3d","subnet-3a2b1c0d");SecurityGroupIds="sg-6979fe18"} -RoleArn "arn:aws:iam::012345678901:role/eks-service-role"
```
**Salida:**
```
Arn : arn:aws:eks:us-west-2:012345678901:cluster/prod
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/10/2018 9:25:31 PM
Endpoint :
Name : prod
PlatformVersion : eks.3
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678901:role/eks-service-role
Status : CREATING
Version : 1.10
```
+ Para obtener más información sobre la API, consulte [CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EKSFargateProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EKSFargateProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet crea un perfil de AWS Fargate para su clúster de Amazon EKS. Debe tener al menos un perfil de Fargate en un clúster para poder programar pods en la infraestructura de Fargate.**
```
New-EKSFargateProfile -FargateProfileName EKSFargateProfile -ClusterName TEST -Subnet "subnet-02f6ff500ff2067a0", "subnet-0cd976f08d5fbfaae" -PodExecutionRoleArn arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole -Selector @{Namespace="default"}
```
**Salida:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:38:21 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargateProfile/20b7a11b-8292-41c1-bc56-ffa5e60f6224
FargateProfileName : EKSFargateProfile
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : CREATING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ Para obtener más información sobre la API, consulte [CreateFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)la referencia de *Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-EKSNodeGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-EKSNodeGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet crea un grupo de nodos de trabajo administrados para un clúster de Amazon EKS. Solo puede crear un grupo de nodos para el clúster que sea igual a la versión actual de Kubernetes para el clúster. Todos los grupos de nodos se crean con la última versión de la AMI para la versión secundaria correspondiente de Kubernetes del clúster.**
```
New-EKSNodeGroup -NodeGroupName "ProdEKSNodeGroup" -AmiType "AL2_x86_64" -DiskSize 40 -ClusterName "PROD" -ScalingConfig_DesiredSize 2 -ScalingConfig_MinSize 2 -ScalingConfig_MaxSize 5 -InstanceType t3.large -NodeRole "arn:aws:iam::012345678912:role/NodeInstanceRole" -Subnet "subnet-0d1a9fff35efa7691","subnet-0a3f4928edbc224d4"
```
**Salida:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ Para obtener más información sobre la API, consulte [CreateNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EKSCluster`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EKSCluster`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina el plano de control del clúster de Amazon EKS.**
```
Remove-EKSCluster -Name "DEV-KUBE-CL"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSCluster (DeleteCluster)" on target "DEV-KUBE-CL".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn : arn:aws:eks:us-west-2:012345678912:cluster/DEV-KUBE-CL
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 9:33:25 AM
Endpoint : https://02E6D31E3E4F8C15D7BE7F58D527776A.yl4.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : DEV-KUBE-CL
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : DELETING
Tags : {}
Version : 1.14
```
+ Para obtener más información sobre la API, consulte [DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EKSFargateProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EKSFargateProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina un perfil de AWS Fargate. Al eliminar un perfil de Fargate, se eliminan todos los pods que se programaron en Fargate con el perfil.**
```
Remove-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSFargateProfile (DeleteFargateProfile)" on target "EKSFargate".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : DELETING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DeleteFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Remove-EKSNodegroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EKSNodegroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina un grupo de nodos de Amazon EKS de un clúster.**
```
Remove-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSNodegroup (DeleteNodegroup)" on target "ProdEKSNodeGroup".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 11:01:16 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources : Amazon.EKS.Model.NodegroupResources
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : DELETING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ Para obtener más información sobre la API, consulte [DeleteNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-EKSResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-EKSResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet elimina las etiquetas especificadas de un recurso de EKS.**
```
Remove-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -TagKey "Name"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSResourceTag (UntagResource)" on target "arn:aws:eks:us-west-2:012345678912:cluster/PROD".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-EKSClusterConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-EKSClusterConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Actualiza la configuración de un clúster de Amazon EKS. El clúster seguirá funcionando durante la actualización.**
```
Update-EKSClusterConfig -Name "PROD" -Logging_ClusterLogging @{Types="api","audit","authenticator","controllerManager","scheduler",Enabled="True"}
```
**Salida:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : LoggingUpdate
```
+ Para obtener más información sobre la API, consulte [UpdateClusterConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-EKSClusterVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-EKSClusterVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este cmdlet actualiza un clúster de Amazon EKS a la versión de Kubernetes especificada. El clúster seguirá funcionando durante la actualización.**
```
Update-EKSClusterVersion -Name "PROD-KUBE-CL" -Version 1.14
```
**Salida:**
```
CreatedAt : 12/26/2019 9:50:37 AM
Errors : {}
Id : ef186eff-3b3a-4c25-bcfc-3dcdf9e898a8
Params : {Amazon.EKS.Model.UpdateParam, Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : VersionUpdate
```
+ Para obtener más información sobre la API, consulte [UpdateClusterVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Elastic Load Balancing: versión 1 con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Elastic Load Balancing (versión 1).
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-ELBLoadBalancerToSubnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ELBLoadBalancerToSubnet`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: En este ejemplo se añade la subred especificada al conjunto de subredes configuradas para el equilibrador de carga especificado. El resultado incluye la lista completa de subredes.**
```
Add-ELBLoadBalancerToSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**Salida:**
```
subnet-12345678
subnet-87654321
```
+ Para obtener más información sobre la API, consulte [AttachLoadBalancerToSubnets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-ELBResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ELBResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo añade las etiquetas especificadas al equilibrador de carga especificado. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
Add-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project";Value="lima" },@{ Key="department";Value="digital-media" }
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear una etiqueta para el parámetro Tag.**
```
$tag = New-Object Amazon.ElasticLoadBalancing.Model.Tag
$tag.Key = "project"
$tag.Value = "lima"
Add-ELBResourceTag -LoadBalancerName my-load-balancer -Tag $tag
```
+ Para obtener más información sobre la API, consulte [AddTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Disable-ELBAvailabilityZoneForLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-ELBAvailabilityZoneForLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la zona de disponibilidad especificada del equilibrador de carga especificado. El resultado incluye las zonas de disponibilidad restantes.**
```
Disable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**Salida:**
```
us-west-2b
```
+ Para obtener más información sobre la API, consulte [DisableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Dismount-ELBLoadBalancerFromSubnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Dismount-ELBLoadBalancerFromSubnet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la subred especificada del conjunto de subredes configuradas para el equilibrador de carga especificado. La salida incluye las subredes restantes.**
```
Dismount-ELBLoadBalancerFromSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**Salida:**
```
subnet-87654321
```
+ Para obtener más información sobre la API, consulte [DetachLoadBalancerFromSubnets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELBLoadBalancerAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELBLoadBalancerAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilita el equilibrio de carga entre zonas para el equilibrador de carga especificado.**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -CrossZoneLoadBalancing_Enabled $true
```
**Ejemplo 2: En este ejemplo se deshabilita el drenaje de conexiones para el equilibrador de carga especificado.**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -ConnectionDraining_Enabled $false
```
**Ejemplo 3: En este ejemplo se habilitan el registro de acceso del equilibrador de carga especificado.**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer `
>> -AccessLog_Enabled $true `
>> -AccessLog_S3BucketName amzn-s3-demo-logging-bucket `
>> -AccessLog_S3BucketPrefix my-app/prod `
>> -AccessLog_EmitInterval 60
```
+ Para obtener más información sobre la API, consulte [ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Enable-ELBAvailabilityZoneForLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-ELBAvailabilityZoneForLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade la zona de disponibilidad especificada al equilibrador de carga especificado. El resultado incluye la lista completa de zonas de disponibilidad.**
```
Enable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**Salida:**
```
us-west-2a
us-west-2b
```
+ Para obtener más información sobre la API, consulte [EnableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELBInstanceHealth`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBInstanceHealth`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el estado de las instancias registradas en el equilibrador de carga especificado.**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer
```
**Salida:**
```
Description InstanceId ReasonCode State
----------- ---------- ---------- -----
N/A i-87654321 N/A InService
Instance has failed at lea... i-12345678 Instance OutOfService
```
**Ejemplo 2: En este ejemplo se describe el estado de la instancia registrada en el equilibrador de carga especificado.**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Ejemplo 3: En este ejemplo se muestra la descripción completa del estado de la instancia especificada.**
```
(Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678).Description
```
**Salida:**
```
Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
```
+ Para obtener más información sobre la API, consulte [DescribeInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELBLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los nombres de los equilibradores de carga.**
```
Get-ELBLoadBalancer | format-table -property LoadBalancerName
```
**Salida:**
```
LoadBalancerName
----------------
my-load-balancer
my-other-load-balancer
my-internal-load-balancer
```
**Ejemplo 2: En este ejemplo se describe el equilibrador de carga especificado.**
```
Get-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**Salida:**
```
AvailabilityZones : {us-west-2a, us-west-2b}
BackendServerDescriptions : {Amazon.ElasticLoadBalancing.Model.BackendServerDescription}
CanonicalHostedZoneName : my-load-balancer-1234567890.us-west-2.elb.amazonaws.com
CanonicalHostedZoneNameID : Z3DZXE0EXAMPLE
CreatedTime : 4/11/2015 12:12:45 PM
DNSName : my-load-balancer-1234567890.us-west-2.elb.amazonaws.com
HealthCheck : Amazon.ElasticLoadBalancing.Model.HealthCheck
Instances : {i-207d9717, i-afefb49b}
ListenerDescriptions : {Amazon.ElasticLoadBalancing.Model.ListenerDescription}
LoadBalancerName : my-load-balancer
Policies : Amazon.ElasticLoadBalancing.Model.Policies
Scheme : internet-facing
SecurityGroups : {sg-a61988c3}
SourceSecurityGroup : Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup
Subnets : {subnet-15aaab61}
VPCId : vpc-a01106c2
```
**Ejemplo 3: en este ejemplo se describen todos los balanceadores de carga de la región actual AWS .**
```
Get-ELBLoadBalancer
```
**Ejemplo 4: En este ejemplo se describen todos los equilibradores de carga de todas las regiones de Regiones de AWS disponibles.**
```
Get-AWSRegion | % { Get-ELBLoadBalancer -Region $_ }
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELBLoadBalancerAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBLoadBalancerAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen los atributos del equilibrador de carga especificado.**
```
Get-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer
```
**Salida:**
```
AccessLog : Amazon.ElasticLoadBalancing.Model.AccessLog
AdditionalAttributes : {}
ConnectionDraining : Amazon.ElasticLoadBalancing.Model.ConnectionDraining
ConnectionSettings : Amazon.ElasticLoadBalancing.Model.ConnectionSettings
CrossZoneLoadBalancing : Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELBLoadBalancerPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBLoadBalancerPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las políticas asociadas al equilibrador de carga especificado.**
```
Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer
```
**Salida:**
```
PolicyAttributeDescriptions PolicyName PolicyTypeName
--------------------------- ---------- --------------
{ProxyProtocol} my-ProxyProtocol-policy ProxyProtocolPolicyType
{CookieName} my-app-cookie-policy AppCookieStickinessPolicyType
```
**Ejemplo 2: En este ejemplo se describen los atributos de la política especificada.**
```
(Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-ProxyProtocol-policy).PolicyAttributeDescriptions
```
**Salida:**
```
AttributeName AttributeValue
------------- --------------
ProxyProtocol true
```
**Ejemplo 3: En este ejemplo se describen las políticas predefinidas, incluidas las políticas de ejemplo. Los nombres de las políticas de muestra tienen el prefijo ELBSample -.**
```
Get-ELBLoadBalancerPolicy
```
**Salida:**
```
PolicyAttributeDescriptions PolicyName PolicyTypeName
--------------------------- ---------- --------------
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-05 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-03 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-02 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2014-10 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2014-01 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2011-08 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSample-ELBDefaultCipherPolicy SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSample-OpenSSLDefaultCipherPolicy SSLNegotiationPolicyType
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancerPolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-ELBLoadBalancerPolicyType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBLoadBalancerPolicyType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los tipos de políticas compatibles con Elastic Load Balancing.**
```
Get-ELBLoadBalancerPolicyType
```
**Salida:**
```
Description PolicyAttributeTypeDescriptions PolicyTypeName
----------- ------------------------------- --------------
Stickiness policy with session lifet... {CookieExpirationPeriod} LBCookieStickinessPolicyType
Policy that controls authentication ... {PublicKeyPolicyName} BackendServerAuthenticationPolicyType
Listener policy that defines the cip... {Protocol-SSLv2, Protocol-TLSv1, Pro... SSLNegotiationPolicyType
Policy containing a list of public k... {PublicKey} PublicKeyPolicyType
Stickiness policy with session lifet... {CookieName} AppCookieStickinessPolicyType
Policy that controls whether to incl... {ProxyProtocol} ProxyProtocolPolicyType
```
**Ejemplo 2: En este ejemplo se describe el tipo de política especificado.**
```
Get-ELBLoadBalancerPolicyType -PolicyTypeName ProxyProtocolPolicyType
```
**Salida:**
```
Description PolicyAttributeTypeDescriptions PolicyTypeName
----------- ------------------------------- --------------
Policy that controls whether to incl... {ProxyProtocol} ProxyProtocolPolicyType
```
**Ejemplo 3: En este ejemplo se muestra la descripción completa del tipo de política especificado.**
```
(Get-ELBLoadBalancerPolicyType -PolicyTypeName).Description
```
**Salida:**
```
Policy that controls whether to include the IP address and port of the originating request for TCP messages.
This policy operates on TCP/SSL listeners only
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancerPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELBResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELBResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas de los equilibradores de carga especificados.**
```
Get-ELBResourceTag -LoadBalancerName @("my-load-balancer","my-internal-load-balancer")
```
**Salida:**
```
LoadBalancerName Tags
---------------- ----
my-load-balancer {project, department}
my-internal-load-balancer {project, department}
```
**Ejemplo 2: En este ejemplo se describen las etiquetas del equilibrador de carga especificado.**
```
(Get-ELBResourceTag -LoadBalancerName my-load-balancer).Tags
```
**Salida:**
```
Key Value
--- -----
project lima
department digital-media
```
+ Para obtener más información sobre la API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Join-ELBSecurityGroupToLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Join-ELBSecurityGroupToLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reemplaza el grupo de seguridad actual del equilibrador de carga especificado por el grupo de seguridad especificado.**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup sg-87654321
```
**Salida:**
```
sg-87654321
```
**Ejemplo 2: Para conservar el grupo de seguridad actual y especificar un grupo de seguridad adicional, especifique tanto el grupo de seguridad existente como el nuevo.**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup @("sg-12345678", "sg-87654321")
```
**Salida:**
```
sg-12345678
sg-87654321
```
+ Para obtener más información sobre la API, consulte [ApplySecurityGroupsToLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELBAppCookieStickinessPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELBAppCookieStickinessPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una política de persistencia que sigue las vidas útiles de las sesiones persistentes de la cookie generada por la aplicación especificada.**
```
New-ELBAppCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-app-cookie-policy -CookieName my-app-cookie
```
+ Para obtener más información sobre la API, consulte [CreateAppCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELBLBCookieStickinessPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELBLBCookieStickinessPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una política de persistencia en la que las vidas útiles de las sesiones persistentes se controlan en función del período de vencimiento especificado (en segundos).**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy -CookieExpirationPeriod 60
```
**Ejemplo 2: En este ejemplo se crea una política de persistencia en la que las vidas útiles de las sesiones persistentes se controlan mediante la vida útil del navegador (usuario-agente).**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
+ Para obtener más información sobre la API, consulte [CreateLbCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELBLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELBLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un equilibrador de carga con un oyente de HTTP en una VPC.**
```
$httpListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpListener.Protocol = "http"
$httpListener.LoadBalancerPort = 80
$httpListener.InstanceProtocol = "http"
$httpListener.InstancePort = 80
New-ELBLoadBalancer -LoadBalancerName my-vpc-load-balancer -SecurityGroup sg-a61988c3 -Subnet subnet-15aaab61 -Listener $httpListener
my-vpc-load-balancer-1234567890.us-west-2.elb.amazonaws.com
```
**Ejemplo 2: En este ejemplo se crea un equilibrador de carga con un oyente de HTTP en EC2-Classic.**
```
New-ELBLoadBalancer -LoadBalancerName my-classic-load-balancer -AvailabilityZone us-west-2a` -Listener $httpListener
```
**Salida:**
```
my-classic-load-balancer-123456789.us-west-2.elb.amazonaws.com
```
**Ejemplo 3: En este ejemplo se crea un equilibrador de carga con un oyente de HTTPS.**
```
$httpsListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpsListener.Protocol = "https"
$httpsListener.LoadBalancerPort = 443
$httpsListener.InstanceProtocol = "http"
$httpsListener.InstancePort = 80
$httpsListener.SSLCertificateId="arn:aws:iam::123456789012:server-certificate/my-server-cert"
New-ELBLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a -Listener $httpsListener
my-load-balancer-123456789.us-west-2.elb.amazonaws.com
```
+ Para obtener más información sobre la API, consulte [CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELBLoadBalancerListener`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELBLoadBalancerListener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo añade un oyente de HTTPS al equilibrador de carga especificado.**
```
$httpsListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpsListener.Protocol = "https"
$httpsListener.LoadBalancerPort = 443
$httpsListener.InstanceProtocol = "https"
$httpsListener.InstancePort = 443
$httpsListener.SSLCertificateId="arn:aws:iam::123456789012:server-certificate/my-server-cert"
New-ELBLoadBalancerListener -LoadBalancerName my-load-balancer -Listener $httpsListener
```
+ Para obtener más información sobre la API, consulte [CreateLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELBLoadBalancerPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELBLoadBalancerPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva política de proxy para un equilibrador de carga especificado.**
```
$attribute = New-Object Amazon.ElasticLoadBalancing.Model.PolicyAttribute -Property @{
AttributeName="ProxyProtocol"
AttributeValue="True"
}
New-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-ProxyProtocol-policy -PolicyTypeName ProxyProtocolPolicyType -PolicyAttribute $attribute
```
+ Para obtener más información sobre la API, consulte [CreateLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-ELBInstanceWithLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-ELBInstanceWithLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra la instancia de EC2 especificada en el equilibrador de carga especificado.**
```
Register-ELBInstanceWithLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Salida:**
```
InstanceId
----------
i-12345678
i-87654321
```
+ Para obtener más información sobre la API, consulte [RegisterInstancesWithLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELBInstanceFromLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELBInstanceFromLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la instancia de EC2 especificada del equilibrador de carga especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-ELBInstanceFromLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBInstanceFromLoadBalancer (DeregisterInstancesFromLoadBalancer)" on Target
"Amazon.ElasticLoadBalancing.Model.Instance".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
InstanceId
----------
i-87654321
```
+ Para obtener más información sobre la API, consulte [DeregisterInstancesFromLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELBLoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELBLoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el equilibrador de carga especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancer (DeleteLoadBalancer)" on Target "my-load-balancer".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELBLoadBalancerListener`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELBLoadBalancerListener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el oyente en el puerto 80 para el equilibrador de carga especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-ELBLoadBalancerListener -LoadBalancerName my-load-balancer -LoadBalancerPort 80
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancerListener (DeleteLoadBalancerListeners)" on Target "80".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELBLoadBalancerPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELBLoadBalancerPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la política especificada del equilibrador de carga especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force.**
```
Remove-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancerPolicy (DeleteLoadBalancerPolicy)" on Target "my-duration-cookie-policy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ Para obtener más información sobre la API, consulte [DeleteLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELBResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELBResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta especificada del equilibrador de carga especificado. Para que la operación continúe, se le pedirá confirmación, a menos que especifique el parámetro Force. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
Remove-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project" }
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELBResourceTag (RemoveTags)" on target "Amazon.ElasticLoadBalancing.Model.TagKeyOnly".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Ejemplo 2: Con la versión 2 de PowerShell, debe usar New-Object para crear la etiqueta para el parámetro Tag.**
```
$tag = New-Object Amazon.ElasticLoadBalancing.Model.TagKeyOnly
$tag.Key = "project"
Remove-ELBResourceTag -Tag $tag -Force
```
+ Para obtener más información sobre la API, consulte [RemoveTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Set-ELBHealthCheck`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELBHealthCheck`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se configuran las opciones de comprobación de estado del equilibrador de carga especificado.**
```
Set-ELBHealthCheck -LoadBalancerName my-load-balancer `
>> -HealthCheck_HealthyThreshold 2 `
>> -HealthCheck_UnhealthyThreshold 2 `
>> -HealthCheck_Target "HTTP:80/ping" `
>> -HealthCheck_Interval 30 `
>> -HealthCheck_Timeout 3
```
**Salida:**
```
HealthyThreshold : 2
Interval : 30
Target : HTTP:80/ping
Timeout : 3
UnhealthyThreshold : 2
```
+ Para obtener más información sobre la API, consulte [ConfigureHealthCheck](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELBLoadBalancerListenerSSLCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELBLoadBalancerListenerSSLCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se reemplaza el certificado que termina las conexiones SSL del oyente especificado.**
```
Set-ELBLoadBalancerListenerSSLCertificate -LoadBalancerName my-load-balancer `
>> -LoadBalancerPort 443 `
>> -SSLCertificateId "arn:aws:iam::123456789012:server-certificate/new-server-cert"
```
+ Para obtener más información sobre la API, consulte [SetLoadBalancerListenerSslCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELBLoadBalancerPolicyForBackendServer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELBLoadBalancerPolicyForBackendServer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se sustituyen las políticas del puerto especificado por la política especificada.**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80 -PolicyName my-ProxyProtocol-policy
```
**Ejemplo 2: En este ejemplo se quitan todas las políticas asociadas al puerto especificado.**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80
```
+ Para obtener más información sobre la API, consulte [SetLoadBalancerPoliciesForBackendServer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELBLoadBalancerPolicyOfListener`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELBLoadBalancerPolicyOfListener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se sustituyen las políticas del oyente especificado por la política especificada.**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443 -PolicyName my-SSLNegotiation-policy
```
**Ejemplo 2: En este ejemplo se quitan todas las políticas asociadas al oyente especificado.**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443
```
+ Para obtener más información sobre la API, consulte [SetLoadBalancerPoliciesOfListener](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Elastic Load Balancing: versión 2 con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Elastic Load Balancing (versión 2).
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-ELB2ListenerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ELB2ListenerCertificate`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: En este ejemplo se añade un certificado adicional al oyente especificado.**
```
Add-ELB2ListenerCertificate -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618' -Certificate @{CertificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97'}
```
**Salida:**
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97 False
```
+ Para obtener más información sobre la API, consulte [AddListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-ELB2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ELB2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade una nueva etiqueta al recurso de `AWS.Tools.ElasticLoadBalancingV2` especificado.**
```
Add-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Tag @{Key = 'productVersion'; Value = '1.0.0'}
```
+ Para obtener más información sobre la API, consulte [AddTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELB2Listener`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELB2Listener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo modifica la acción predeterminada de los oyentes especificada a una respuesta fija.**
```
$newDefaultAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
"FixedResponseConfig" = @{
"ContentType" = "text/plain"
"MessageBody" = "Hello World"
"StatusCode" = "200"
}
"Type" = [Amazon.ElasticLoadBalancingV2.ActionTypeEnum]::FixedResponse
}
Edit-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/d19f2f14974db685' -Port 8080 -DefaultAction $newDefaultAction
```
**Salida:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/d19f2f14974db685
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676
Port : 8080
Protocol : HTTP
SslPolicy :
```
+ Para obtener más información sobre la API, consulte [ModifyListener](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELB2LoadBalancerAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELB2LoadBalancerAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifican los atributos del equilibrador de carga especificado.**
```
Edit-ELB2LoadBalancerAttribute -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Attribute @{Key = 'deletion_protection.enabled'; Value = 'true'}
```
**Salida:**
```
Key Value
--- -----
deletion_protection.enabled true
access_logs.s3.enabled false
access_logs.s3.bucket
access_logs.s3.prefix
idle_timeout.timeout_seconds 60
routing.http2.enabled true
routing.http.drop_invalid_header_fields.enabled false
```
+ Para obtener más información sobre la API, consulte [ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELB2Rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELB2Rule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifican las configuraciones de las reglas de oyente especificadas.**
```
$newRuleCondition = [Amazon.ElasticLoadBalancingV2.Model.RuleCondition]@{
"PathPatternConfig" = @{
"Values" = "/login1","/login2","/login3"
}
"Field" = "path-pattern"
}
Edit-ELB2Rule -RuleArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc' -Condition $newRuleCondition
```
**Salida:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 10
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc
```
+ Para obtener más información sobre la API, consulte [ModifyRule](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELB2TargetGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELB2TargetGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifican las propiedades del grupo de destino especificado.**
```
Edit-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -HealthCheckIntervalSecond 60 -HealthCheckPath '/index.html' -HealthCheckPort 8080
```
**Salida:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 60
HealthCheckPath : /index.html
HealthCheckPort : 8080
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 5
LoadBalancerArns : {}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970
TargetGroupName : test-tg
TargetType : instance
UnhealthyThresholdCount : 2
VpcId : vpc-2cfd7000
```
+ Para obtener más información sobre la API, consulte [ModifyTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-ELB2TargetGroupAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-ELB2TargetGroupAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo modifica el atributo deregistration\$1delay del grupo de destino especificado.**
```
Edit-ELB2TargetGroupAttribute -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -Attribute @{Key = 'deregistration_delay.timeout_seconds'; Value = 600}
```
**Salida:**
```
Key Value
--- -----
stickiness.enabled false
deregistration_delay.timeout_seconds 600
stickiness.type lb_cookie
stickiness.lb_cookie.duration_seconds 86400
slow_start.duration_seconds 0
load_balancing.algorithm.type round_robin
```
+ Para obtener más información sobre la API, consulte [ModifyTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2AccountLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2AccountLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando muestra los límites de las ELB2 cuentas para una región determinada.**
```
Get-ELB2AccountLimit
```
**Salida:**
```
Max Name
--- ----
3000 target-groups
1000 targets-per-application-load-balancer
50 listeners-per-application-load-balancer
100 rules-per-application-load-balancer
50 network-load-balancers
3000 targets-per-network-load-balancer
500 targets-per-availability-zone-per-network-load-balancer
50 listeners-per-network-load-balancer
5 condition-values-per-alb-rule
5 condition-wildcards-per-alb-rule
100 target-groups-per-application-load-balancer
5 target-groups-per-action-on-application-load-balancer
1 target-groups-per-action-on-network-load-balancer
50 application-load-balancers
```
+ Para obtener información sobre la API, consulte [DescribeAccountLimits Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ELB2Listener`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2Listener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo describe los oyentes del ALB/NLB especificado.**
```
Get-ELB2Listener -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Salida:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/1dac07c21187d41e
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f
Port : 80
Protocol : HTTP
SslPolicy :
Certificates : {Amazon.ElasticLoadBalancingV2.Model.Certificate}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f
Port : 443
Protocol : HTTPS
SslPolicy : ELBSecurityPolicy-2016-08
```
+ Para obtener más información sobre la API, consulte [DescribeListeners](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2ListenerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2ListenerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el certificado del oyente especificado.**
```
Get-ELB2ListenerCertificate -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Salida:**
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/5fc7c092-68bf-4862-969c-22fd48b6e17c True
```
+ Para obtener más información sobre la API, consulte [DescribeListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2LoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2LoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran todos los equilibradores de carga de una región determinada.**
```
Get-ELB2LoadBalancer
```
**Salida:**
```
AvailabilityZones : {us-east-1c}
CanonicalHostedZoneId : Z26RNL4JYFTOTI
CreatedTime : 6/22/18 11:21:50 AM
DNSName : test-elb1234567890-238d34ad8d94bc2e.elb.us-east-1.amazonaws.com
IpAddressType : ipv4
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/test-elb1234567890/238d34ad8d94bc2e
LoadBalancerName : test-elb1234567890
Scheme : internet-facing
SecurityGroups : {}
State : Amazon.ElasticLoadBalancingV2.Model.LoadBalancerState
Type : network
VpcId : vpc-2cf00000
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2LoadBalancerAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2LoadBalancerAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando describe los atributos de un equilibrador de carga determinado.**
```
Get-ELB2LoadBalancerAttribute -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/test-elb/238d34ad8d94bc2e'
```
**Salida:**
```
Key Value
--- -----
access_logs.s3.enabled false
load_balancing.cross_zone.enabled true
access_logs.s3.prefix
deletion_protection.enabled false
access_logs.s3.bucket
```
+ Para obtener más información sobre la API, consulte [DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2Rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2Rule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen las reglas del oyente para el ARN del oyente especificado.**
```
Get-ELB2Rule -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Salida:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 1
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/2286fff5055e0f79
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 2
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/14e7b036567623ba
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {}
IsDefault : True
Priority : default
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/853948cf3aa9b2bf
```
+ Para obtener más información sobre la API, consulte [DescribeRules](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2SSLPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2SSLPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran todas las políticas de escucha disponibles para ElasticLoadBalancing la versión 2.**
```
Get-ELB2SSLPolicy
```
**Salida:**
```
Ciphers Name SslProtocols
------- ---- ------------
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-2016-08 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-2-2017-01 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-1-2017-01 {TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-2-Ext-2018-06 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-2018-06 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-2015-05 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-0-2015-04 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-2-Res-2019-08 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-1-2019-08 {TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-2-2019-08 {TLSv1.2}
```
+ Para obtener más información sobre la API, consulte [DescribeSslPolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-ELB2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas del recurso especificado.**
```
Get-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Salida:**
```
ResourceArn Tags
----------- ----
arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f {stage, internalName, version}
```
+ Para obtener más información sobre la API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2TargetGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2TargetGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describe el grupo de destino especificado.**
```
Get-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Salida:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 30
HealthCheckPath : /
HealthCheckPort : traffic-port
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 5
LoadBalancerArns : {arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970
TargetGroupName : test-tg
TargetType : instance
UnhealthyThresholdCount : 2
VpcId : vpc-2cfd7000
```
+ Para obtener más información sobre la API, consulte [DescribeTargetGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2TargetGroupAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2TargetGroupAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se describen los atributos del grupo de destino especificado.**
```
Get-ELB2TargetGroupAttribute -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Salida:**
```
Key Value
--- -----
stickiness.enabled false
deregistration_delay.timeout_seconds 300
stickiness.type lb_cookie
stickiness.lb_cookie.duration_seconds 86400
slow_start.duration_seconds 0
load_balancing.algorithm.type round_robin
```
+ Para obtener más información sobre la API, consulte [DescribeTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ELB2TargetHealth`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ELB2TargetHealth`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve el estado de los destinos presentes en el grupo de destino especificado.**
```
Get-ELB2TargetHealth -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Salida:**
```
HealthCheckPort Target TargetHealth
--------------- ------ ------------
80 Amazon.ElasticLoadBalancingV2.Model.TargetDescription Amazon.ElasticLoadBalancingV2.Model.TargetHealth
```
+ Para obtener más información sobre la API, consulte [DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELB2Listener`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELB2Listener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea un nuevo oyente de ALB con la acción predeterminada “Forward” para enviar el tráfico al grupo de destino especificado.**
```
$defaultAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
ForwardConfig = @{
TargetGroups = @(
@{ TargetGroupArn = "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testAlbTG/3d61c2f20aa5bccb" }
)
TargetGroupStickinessConfig = @{
DurationSeconds = 900
Enabled = $true
}
}
Type = "Forward"
}
New-ELB2Listener -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676' -Port 8001 -Protocol "HTTP" -DefaultAction $defaultAction
```
**Salida:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/1c84f02aec143e80
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676
Port : 8001
Protocol : HTTP
SslPolicy :
```
+ Para obtener más información sobre la API, consulte [CreateListener](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELB2LoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELB2LoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea un nuevo equilibrador de carga de aplicación orientado a Internet con dos subredes.**
```
New-ELB2LoadBalancer -Type application -Scheme internet-facing -IpAddressType ipv4 -Name 'New-Test-ALB' -SecurityGroup 'sg-07c3414abb8811cbd' -subnet 'subnet-c37a67a6','subnet-fc02eea0'
```
**Salida:**
```
AvailabilityZones : {us-east-1b, us-east-1a}
CanonicalHostedZoneId : Z35SXDOTRQ7X7K
CreatedTime : 12/28/19 2:58:03 PM
DNSName : New-Test-ALB-1391502222.us-east-1.elb.amazonaws.com
IpAddressType : ipv4
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/New-Test-ALB/dab2e4d90eb51493
LoadBalancerName : New-Test-ALB
Scheme : internet-facing
SecurityGroups : {sg-07c3414abb8811cbd}
State : Amazon.ElasticLoadBalancingV2.Model.LoadBalancerState
Type : application
VpcId : vpc-2cfd7000
```
+ Para obtener más información sobre la API, consulte [CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELB2Rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELB2Rule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea una nueva regla de oyente con una acción de respuesta fija basada en el valor del encabezado del cliente para el oyente especificado.**
```
$newRuleAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
"FixedResponseConfig" = @{
"ContentType" = "text/plain"
"MessageBody" = "Hello World"
"StatusCode" = "200"
}
"Type" = [Amazon.ElasticLoadBalancingV2.ActionTypeEnum]::FixedResponse
}
$newRuleCondition = [Amazon.ElasticLoadBalancingV2.Model.RuleCondition]@{
"httpHeaderConfig" = @{
"HttpHeaderName" = "customHeader"
"Values" = "header2","header1"
}
"Field" = "http-header"
}
New-ELB2Rule -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/1c84f02aec143e80' -Action $newRuleAction -Condition $newRuleCondition -Priority 10
```
**Salida:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 10
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc
```
+ Para obtener más información sobre la API, consulte [CreateRule](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ELB2TargetGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ELB2TargetGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo grupo de destino con los parámetros proporcionados.**
```
New-ELB2TargetGroup -HealthCheckEnabled 1 -HealthCheckIntervalSeconds 30 -HealthCheckPath '/index.html' -HealthCheckPort 80 -HealthCheckTimeoutSecond 5 -HealthyThresholdCount 2 -UnhealthyThresholdCount 5 -Port 80 -Protocol 'HTTP' -TargetType instance -VpcId 'vpc-2cfd7000' -Name 'NewTargetGroup'
```
**Salida:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 30
HealthCheckPath : /index.html
HealthCheckPort : 80
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 2
LoadBalancerArns : {}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/NewTargetGroup/534e484681d801bf
TargetGroupName : NewTargetGroup
TargetType : instance
UnhealthyThresholdCount : 5
VpcId : vpc-2cfd7000
```
+ Para obtener más información sobre la API, consulte [CreateTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-ELB2Target`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-ELB2Target`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra la instancia “i-0672a4c4cdeae3111” con el grupo de destino especificado.**
```
Register-ELB2Target -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -Target @{Port = 80; Id = 'i-0672a4c4cdeae3111'}
```
+ Para obtener más información sobre la API, consulte [RegisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2Listener`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2Listener`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el oyente especificado.**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Listener (DeleteListener)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
**Ejemplo 2: En este ejemplo se quita el oyente especificado del equilibrador de carga especificado.**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Listener (DeleteListener)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [DeleteListener](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2ListenerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2ListenerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el certificado especificado del grupo de destino especificado.**
```
Remove-ELB2ListenerCertificate -Certificate @{CertificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97'} -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2ListenerCertificate (RemoveListenerCertificates)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [RemoveListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2LoadBalancer`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2LoadBalancer`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el equilibrador de carga especificado.**
```
Remove-ELB2LoadBalancer -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2LoadBalancer (DeleteLoadBalancer)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2Rule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2Rule`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la regla especificada del oyente especificado.**
```
Remove-ELB2Rule -RuleArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/3873f123b98f7618/4b25eb10a42e33ab'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Rule (DeleteRule)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/3873f123b98f7618/4b25eb10a42e33ab".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [DeleteRule](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2Tag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2Tag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta de la clave especificada. **
```
Remove-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -TagKey 'productVersion'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Tag (RemoveTags)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [RemoveTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-ELB2TargetGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-ELB2TargetGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de destino especificado.**
```
Remove-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testsssss/4e0b6076bc6483a7'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2TargetGroup (DeleteTargetGroup)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testsssss/4e0b6076bc6483a7".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ Para obtener más información sobre la API, consulte [DeleteTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELB2IpAddressType`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELB2IpAddressType`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el tipo de dirección IP del balanceador de carga de '' a IPv4 ''. DualStack**
```
Set-ELB2IpAddressType -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -IpAddressType dualstack
```
**Salida:**
```
Value
-----
dualstack
```
+ Para obtener más información sobre la API, consulte [SetIpAddressType Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Set-ELB2RulePriority`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELB2RulePriority`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia la prioridad de la regla de oyente especificada.**
```
Set-ELB2RulePriority -RulePriority -RulePriority @{Priority = 11; RuleArn = 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/a4eb199fa5046f80/dbf4c6dcef3ec6f8'}
```
**Salida:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 11
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/a4eb199fa5046f80/dbf4c6dcef3ec6f8
```
+ Para obtener más información sobre la API, consulte [SetRulePriorities](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELB2SecurityGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELB2SecurityGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade el grupo de seguridad “sg-07c3414abb8811cbd” al equilibrador de carga especificado.**
```
Set-ELB2SecurityGroup -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -SecurityGroup 'sg-07c3414abb8811cbd'
```
**Salida:**
```
sg-07c3414abb8811cbd
```
+ Para obtener más información sobre la API, consulte [SetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-ELB2Subnet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-ELB2Subnet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se modifican las subredes del equilibrador de carga especificado.**
```
Set-ELB2Subnet -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Subnet 'subnet-7d8a0a51','subnet-c37a67a6'
```
**Salida:**
```
LoadBalancerAddresses SubnetId ZoneName
--------------------- -------- --------
{} subnet-7d8a0a51 us-east-1c
{} subnet-c37a67a6 us-east-1b
```
+ Para obtener más información sobre la API, consulte [SetSubnets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-ELB2Target`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-ELB2Target`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se anula el registro de la instancia “i-0672a4c4cdeae3111” del grupo de destino especificado.**
```
$targetDescription = New-Object Amazon.ElasticLoadBalancingV2.Model.TargetDescription
$targetDescription.Id = 'i-0672a4c4cdeae3111'
Unregister-ELB2Target -Target $targetDescription -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
+ Para obtener más información sobre la API, consulte [DeregisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# FSx Ejemplos de Amazon que utilizan Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon FSx.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-FSXResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-FSXResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se añaden etiquetas al recurso especificado.**
```
Add-FSXResourceTag -ResourceARN "arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a" -Tag @{Key="Users";Value="Test"}
```
**Salida:**
```
arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a
```
+ Para obtener más información sobre la API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-FSXBackup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-FSXBackup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recuperan las copias de seguridad creadas desde ayer para el identificador del sistema de archivos especificado.**
```
Get-FSXBackup -Filter @{Name="file-system-id";Values=$fsx.FileSystemId} | Where-Object CreationTime -gt (Get-Date).AddDays(-1)
```
**Salida:**
```
BackupId : backup-01dac234e56782bcc
CreationTime : 6/14/2019 3:35:14 AM
FailureDetails :
FileSystem : Amazon.FSx.Model.FileSystem
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f1-e1234c5af123
Lifecycle : AVAILABLE
ProgressPercent : 100
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-01dac234e56782bcc
Tags : {}
Type : AUTOMATIC
```
+ Para obtener más información sobre la API, consulte [DescribeBackups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-FSXFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-FSXFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve la descripción de un filesystemId especificado.**
```
Get-FSXFileSystem -FileSystemId fs-01cd23bc4bdf5678a
```
**Salida:**
```
CreationTime : 1/17/2019 9:55:30 AM
DNSName : fs-01cd23bc4bdf5678a.ktmsad.local
FailureDetails :
FileSystemId : fs-01cd23bc4bdf5678a
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-8bde-a9f0-e1234c5af678
Lifecycle : AVAILABLE
LustreConfiguration :
NetworkInterfaceIds : {eni-07d1dda1322b7e209}
OwnerId : 123456789012
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a
StorageCapacity : 300
SubnetIds : {subnet-7d123456}
Tags : {FSx-Service}
VpcId : vpc-41cf2b3f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ Para obtener más información sobre la API, consulte [DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-FSXResourceTagList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-FSXResourceTagList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas del ARN del recurso especificado.**
```
Get-FSXResourceTagList -ResourceARN $fsx.ResourceARN
```
**Salida:**
```
Key Value
--- -----
FSx-Service Windows
Users Dev
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-FSXBackup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-FSXBackup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una copia de seguridad del sistema de archivos especificado.**
```
New-FSXBackup -FileSystemId fs-0b1fac2345623456ba
```
**Salida:**
```
BackupId : backup-0b1fac2345623456ba
CreationTime : 6/14/2019 5:37:17 PM
FailureDetails :
FileSystem : Amazon.FSx.Model.FileSystem
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f3-e1234c5af678
Lifecycle : CREATING
ProgressPercent : 0
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-0b1fac2345623456ba
Tags : {}
Type : USER_INITIATED
```
+ Para obtener más información sobre la API, consulte [CreateBackup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-FSXFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-FSXFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo crea un nuevo sistema de archivos Windows de 300 GB, que permite el acceso desde la subred especificada y que admite un rendimiento de hasta 8 megabytes por segundo. El nuevo sistema de archivos se une automáticamente a la instancia de Microsoft Active Directory especificada.**
```
New-FSXFileSystem -FileSystemType WINDOWS -StorageCapacity 300 -SubnetId subnet-1a2b3c4d5e6f -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId='d-1a2b3c4d'}
```
**Salida:**
```
CreationTime : 12/10/2018 6:06:59 PM
DNSName : fs-abcdef01234567890.example.com
FailureDetails :
FileSystemId : fs-abcdef01234567890
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:us-west-2:123456789012:key/a1234567-252c-45e9-afaa-123456789abc
Lifecycle : CREATING
LustreConfiguration :
NetworkInterfaceIds : {}
OwnerId : 123456789012
ResourceARN : arn:aws:fsx:us-west-2:123456789012:file-system/fs-abcdef01234567890
StorageCapacity : 300
SubnetIds : {subnet-1a2b3c4d5e6f}
Tags : {}
VpcId : vpc-1a2b3c4d5e6f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ Para obtener más información sobre la API, consulte [CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-FSXFileSystemFromBackup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-FSXFileSystemFromBackup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo crea un nuevo sistema de FSx archivos de Amazon a partir de una copia de seguridad existente de Amazon FSx for Windows File Server.**
```
New-FSXFileSystemFromBackup -BackupId $backupID -Tag @{Key="tag:Name";Value="from-manual-backup"} -SubnetId $SubnetID -SecurityGroupId $SG_ID -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId=$DirectoryID}
```
**Salida:**
```
CreationTime : 8/8/2019 12:59:58 PM
DNSName : fs-012ff34e56789120.ktmsad.local
FailureDetails :
FileSystemId : fs-012ff34e56789120
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-1bde-a2f3-e4567c8a9321
Lifecycle : CREATING
LustreConfiguration :
NetworkInterfaceIds : {}
OwnerId : 933303704102
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-012ff34e56789120
StorageCapacity : 300
SubnetIds : {subnet-fa1ae23c}
Tags : {tag:Name}
VpcId : vpc-12cf3b4f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ Para obtener más información sobre la API, consulte [CreateFileSystemFromBackup Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-FSXBackup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-FSXBackup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el backup-id especificado.**
```
Remove-FSXBackup -BackupId $backupID
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXBackup (DeleteBackup)" on target "backup-0bbca1e2345678e12".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
BackupId Lifecycle
-------- ---------
backup-0bbca1e2345678e12 DELETED
```
+ Para obtener más información sobre la API, consulte [DeleteBackup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-FSXFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-FSXFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina el ID del sistema de archivos de FSX especificado.**
```
Remove-FSXFileSystem -FileSystemId fs-012ff34e567890120
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXFileSystem (DeleteFileSystem)" on target "fs-012ff34e567890120".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
FileSystemId Lifecycle WindowsResponse
------------ --------- ---------------
fs-012ff34e567890120 DELETING Amazon.FSx.Model.DeleteFileSystemWindowsResponse
```
+ Para obtener más información sobre la API, consulte [DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-FSXResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-FSXResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta de recurso del ARN de recurso del sistema de archivos de FSX especificado.**
```
Remove-FSXResourceTag -ResourceARN $FSX.ResourceARN -TagKey Users
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXResourceTag (UntagResource)" on target "arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-FSXFileSystem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-FSXFileSystem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo actualiza los días de retención de copias de seguridad automáticas del sistema de archivos FSX mediante. UpdateFileSystemWindowsConfiguration**
```
$UpdateFSXWinConfig = [Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration]::new()
$UpdateFSXWinConfig.AutomaticBackupRetentionDays = 35
Update-FSXFileSystem -FileSystemId $FSX.FileSystemId -WindowsConfiguration $UpdateFSXWinConfig
```
**Salida:**
```
CreationTime : 1/17/2019 9:55:30 AM
DNSName : fs-01cd23bc4bdf5678a.ktmsad.local
FailureDetails :
FileSystemId : fs-01cd23bc4bdf5678a
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f2-e1234c5af678
Lifecycle : AVAILABLE
LustreConfiguration :
NetworkInterfaceIds : {eni-01cd23bc4bdf5678a}
OwnerId : 933303704102
ResourceARN : arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a
StorageCapacity : 300
SubnetIds : {subnet-1d234567}
Tags : {FSx-Service}
VpcId : vpc-23cf4b5f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ Para obtener más información sobre la API, consulte [UpdateFileSystem Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
# Ejemplos de Amazon Glacier con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon Glacier.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-GLCJob`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-GLCJob`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: devuelve información detallada de la tarea especificada. Cuando el trabajo se completa correctamente, el cmdlet Read- GCJob Output se puede utilizar para recuperar el contenido del trabajo (un archivo o una lista de inventario) en el sistema de archivos local.**
```
Get-GLCJob -VaultName myvault -JobId "op1x...JSbthM"
```
**Salida:**
```
Action : ArchiveRetrieval
ArchiveId : o9O9j...X-TpIhQJw
ArchiveSHA256TreeHash : 79f3ea754c02f58...dc57bf4395b
ArchiveSizeInBytes : 38034480
Completed : False
CompletionDate : 1/1/0001 12:00:00 AM
CreationDate : 12/13/2018 11:00:14 AM
InventoryRetrievalParameters :
InventorySizeInBytes : 0
JobDescription :
JobId : op1x...JSbthM
JobOutputPath :
OutputLocation :
RetrievalByteRange : 0-38034479
SelectParameters :
SHA256TreeHash : 79f3ea754c02f58...dc57bf4395b
SNSTopic :
StatusCode : InProgress
StatusMessage :
Tier : Standard
VaultARN : arn:aws:glacier:us-west-2:012345678912:vaults/test
```
+ Para obtener más información sobre la API, consulte [DescribeJob Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-GLCVault`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-GLCVault`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea una nueva bóveda para la cuenta del usuario. Como no se ha proporcionado ningún valor al AccountId parámetro -, los cmdlets utilizan el valor predeterminado «-» para indicar la cuenta corriente.**
```
New-GLCVault -VaultName myvault
```
**Salida:**
```
/01234567812/vaults/myvault
```
+ Para obtener más información sobre la API, consulte [CreateVault Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Read-GLCJobOutput`
En el siguiente ejemplo de código, se muestra cómo utilizar `Read-GLCJobOutput`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: descarga el contenido del archivo cuya recuperación estaba programada en la tarea especificada y lo almacena en un archivo en el disco. La descarga valida la suma de comprobación, si hay alguna disponible. Si lo desea, puede devolver la respuesta completa, incluida la suma de verificación, especificando `-Select '*'`.**
```
Read-GLCJobOutput -VaultName myvault -JobId "HSWjArc...Zq2XLiW" -FilePath "c:\temp\blue.bin"
```
+ Para obtener más información sobre la API, consulte [GetJobOutput](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-GLCJob`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-GLCJob`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: inicia una tarea para recuperar un archivo del almacén especificado propiedad del usuario. El estado del trabajo se puede comprobar mediante el GLCJob cmdlet Get-. Cuando el trabajo se complete correctamente, se puede utilizar el cmdlet Read- GCJob Output para recuperar el contenido del archivo en el sistema de archivos local.**
```
Start-GLCJob -VaultName myvault -JobType "archive-retrieval" -JobDescription "archive retrieval" -ArchiveId "o9O9j...TX-TpIhQJw"
```
**Salida:**
```
JobId JobOutputPath Location
----- ------------- --------
op1x...JSbthM /012345678912/vaults/test/jobs/op1xe...I4HqCHkSJSbthM
```
+ Para obtener más información sobre la API, consulte [InitiateJob Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Write-GLCArchive`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-GLCArchive`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: carga un único archivo en el almacén especificado y devuelve el identificador del archivo y la suma de comprobación calculada.**
```
Write-GLCArchive -VaultName myvault -FilePath c:\temp\blue.bin
```
**Salida:**
```
FilePath ArchiveId Checksum
-------- --------- --------
C:\temp\blue.bin o9O9jUUs...TTX-TpIhQJw 79f3e...f4395b
```
**Ejemplo 2: carga el contenido de una jerarquía de carpetas al almacén especificado de la cuenta del usuario. Para cada archivo cargado, el cmdlet emite el nombre del archivo, el identificador de archivo correspondiente y la suma de comprobación calculada del archivo.**
```
Write-GLCArchive -VaultName myvault -FolderPath . -Recurse
```
**Salida:**
```
FilePath ArchiveId Checksum
-------- --------- --------
C:\temp\blue.bin o9O9jUUs...TTX-TpIhQJw 79f3e...f4395b
C:\temp\green.bin qXAfOdSG...czo729UHXrw d50a1...9184b9
C:\temp\lum.bin 39aNifP3...q9nb8nZkFIg 28886...5c3e27
C:\temp\red.bin vp7E6rU_...Ejk_HhjAxKA e05f7...4e34f5
C:\temp\Folder1\file1.txt _eRINlip...5Sxy7dD2BaA d0d2a...c8a3ba
C:\temp\Folder2\file2.iso -Ix3jlmu...iXiDh-XfOPA 7469e...3e86f1
```
+ Para obtener más información sobre la API, consulte [UploadArchive](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS Glue ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS Glue
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `New-GLUEJob`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-GLUEJob`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se crea un nuevo trabajo en AWS Glue. El valor del nombre del comando es siempre`glueetl`. AWS Glue admite la ejecución de scripts de trabajo escritos en Python o Scala. En este ejemplo, el script de trabajo (MyTestGlueJob.py) está escrito en Python. Los parámetros de Python se especifican en la `$DefArgs` variable y, a continuación, se pasan al PowerShell comando del `DefaultArguments` parámetro, que acepta una tabla hash. Los parámetros de la `$JobParams` variable provienen de la CreateJob API, documentada en el tema Jobs (https://docs.aws.amazon.com/glue/latest/dg/aws- glue-api-jobs-job .html) de la referencia de la API AWS Glue.**
```
$Command = New-Object Amazon.Glue.Model.JobCommand
$Command.Name = 'glueetl'
$Command.ScriptLocation = 's3://amzn-s3-demo-source-bucket/admin/MyTestGlueJob.py'
$Command
$Source = "source_test_table"
$Target = "target_test_table"
$Connections = $Source, $Target
$DefArgs = @{
'--TempDir' = 's3://amzn-s3-demo-bucket/admin'
'--job-bookmark-option' = 'job-bookmark-disable'
'--job-language' = 'python'
}
$DefArgs
$ExecutionProp = New-Object Amazon.Glue.Model.ExecutionProperty
$ExecutionProp.MaxConcurrentRuns = 1
$ExecutionProp
$JobParams = @{
"AllocatedCapacity" = "5"
"Command" = $Command
"Connections_Connection" = $Connections
"DefaultArguments" = $DefArgs
"Description" = "This is a test"
"ExecutionProperty" = $ExecutionProp
"MaxRetries" = "1"
"Name" = "MyOregonTestGlueJob"
"Role" = "Amazon-GlueServiceRoleForSSM"
"Timeout" = "20"
}
New-GlueJob @JobParams
```
+ Para obtener más información sobre la API, consulte [CreateJob Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
# AWS Health ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS Health
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-HLTHEvent`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-HLTHEvent`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este comando devuelve los eventos del AWS Personal Health Dashboard. El usuario añade el parámetro -Region para ver los eventos disponibles para el servicio en la región Este de EE. UU. (Norte de Virginia), pero el parámetro -Filter\$1Region filtra los eventos que se registran en las regiones UE (Londres) y Oeste de EE. UU. (Oregón) (eu-west-2 y us-west-2). El StartTime parámetro -Filter\$1 filtra por un rango de horas en las que los eventos pueden comenzar, mientras que el EndTime parámetro -Filter\$1 filtra por un rango de horas en las que pueden terminar los eventos. El resultado es un evento de mantenimiento programado para RDS que comienza dentro del rango -Filter\$1 especificado y termina dentro del rango -Filter\$1 StartTime programado. EndTime **
```
Get-HLTHEvent -Region us-east-1 -Filter_Region "eu-west-2","us-west-2" -Filter_StartTime @{from="3/14/2019 6:30:00AM";to="3/15/2019 5:00:00PM"} -Filter_EndTime @{from="3/21/2019 7:00:00AM";to="3/21/2019 5:00:00PM"}
```
**Salida:**
```
Arn : arn:aws:health:us-west-2::event/RDS/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED_USW2_20190314_20190321
AvailabilityZone :
EndTime : 3/21/2019 2:00:00 PM
EventTypeCategory : scheduledChange
EventTypeCode : AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED
LastUpdatedTime : 2/28/2019 2:26:07 PM
Region : us-west-2
Service : RDS
StartTime : 3/14/2019 2:00:00 PM
StatusCode : open
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference ([DescribeEvents](https://docs.aws.amazon.com/powershell/v5/reference)V5).Herramientas de AWS para PowerShell *
# Ejemplos de IAM que utilizan Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con IAM.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-IAMClientIDToOpenIDConnectProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-IAMClientIDToOpenIDConnectProvider`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: este comando agrega el ID de cliente (o público) `my-application-ID` al proveedor de OIDC existente denominado `server.example.com`.**
```
Add-IAMClientIDToOpenIDConnectProvider -ClientID "my-application-ID" -OpenIDConnectProviderARN "arn:aws:iam::123456789012:oidc-provider/server.example.com"
```
+ Para obtener más información sobre la API, consulte [AddClientIdToOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-IAMRoleTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-IAMRoleTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se agrega una etiqueta al rol en el servicio de administración de identidades**
```
Add-IAMRoleTag -RoleName AdminRoleacess -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ Para obtener más información sobre la API, consulte [TagRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-IAMRoleToInstanceProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-IAMRoleToInstanceProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando añade el rol denominado `S3Access` a un perfil de instancia existente denominado `webserver`. Para crear el perfil de instancia, utilice el comando `New-IAMInstanceProfile`. Tras crear el perfil de instancia y asociarlo a un rol mediante este comando, puede adjuntarlo a una instancia de EC2. Para ello, utilice el cmdlet de `New-EC2Instance` con el parámetro `InstanceProfile_Arn` o `InstanceProfile-Name` para iniciar la nueva instancia.**
```
Add-IAMRoleToInstanceProfile -RoleName "S3Access" -InstanceProfileName "webserver"
```
+ Para obtener más información sobre la API, consulte [AddRoleToInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-IAMUserTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-IAMUserTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se agrega una etiqueta al usuario en el servicio de administración de identidades**
```
Add-IAMUserTag -UserName joe -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ Para obtener más información sobre la API, consulte [TagUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Add-IAMUserToGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-IAMUserToGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando agrega el usuario llamado `Bob` al grupo denominado `Admins`.**
```
Add-IAMUserToGroup -UserName "Bob" -GroupName "Admins"
```
+ Para obtener más información sobre la API, consulte [AddUserToGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Disable-IAMMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Disable-IAMMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando deshabilita el dispositivo MFA de hardware asociado al usuario `Bob` que tiene el número de serie `123456789012`.**
```
Disable-IAMMFADevice -UserName "Bob" -SerialNumber "123456789012"
```
**Ejemplo 2: este comando deshabilita el dispositivo MFA virtual asociado al usuario `David` que tiene el ARN `arn:aws:iam::210987654321:mfa/David`. Tenga en cuenta que el dispositivo MFA virtual no se elimina de la cuenta. El dispositivo virtual sigue presente y aparece en la salida del comando `Get-IAMVirtualMFADevice`. Para poder crear un nuevo dispositivo MFA virtual para el mismo usuario, debe eliminar el antiguo mediante el comando `Remove-IAMVirtualMFADevice`.**
```
Disable-IAMMFADevice -UserName "David" -SerialNumber "arn:aws:iam::210987654321:mfa/David"
```
+ Para obtener más información sobre la API, consulte [DeactivateMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-IAMPassword`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-IAMPassword`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando cambia la contraseña del usuario que ejecuta el comando. Solo los usuarios de IAM pueden llamar a este comando. Si se ejecuta este comando cuando ha iniciado sesión con las credenciales de la AWS cuenta (root), el comando devolverá un error. `InvalidUserType`**
```
Edit-IAMPassword -OldPassword "MyOldP@ssw0rd" -NewPassword "MyNewP@ssw0rd"
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ChangePassword](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Enable-IAMMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Enable-IAMMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando habilita el dispositivo MFA de hardware con el número de serie `987654321098` y asocia el dispositivo con el usuario `Bob`. Incluye los dos primeros códigos secuenciales del dispositivo.**
```
Enable-IAMMFADevice -UserName "Bob" -SerialNumber "987654321098" -AuthenticationCode1 "12345678" -AuthenticationCode2 "87654321"
```
**Ejemplo 2: este ejemplo crea y habilita un dispositivo MFA virtual. El primer comando crea el dispositivo virtual y devuelve la representación del objeto del dispositivo en la variable `$MFADevice`. Puede usar las propiedades `.Base32StringSeed` o `QRCodePng` para configurar la aplicación de software del usuario. El comando final asigna el dispositivo al usuario `David` e identifica el dispositivo por su número de serie. El comando también sincroniza el dispositivo AWS al incluir los dos primeros códigos en secuencia desde el dispositivo MFA virtual.**
```
$MFADevice = New-IAMVirtualMFADevice -VirtualMFADeviceName "MyMFADevice"
# see example for New-IAMVirtualMFADevice to see how to configure the software program with PNG or base32 seed code
Enable-IAMMFADevice -UserName "David" -SerialNumber -SerialNumber $MFADevice.SerialNumber -AuthenticationCode1 "24681357" -AuthenticationCode2 "13572468"
```
+ Para obtener más información sobre la API, consulte [EnableMfaDevice Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-IAMAccessKey`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccessKey`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando muestra las claves de acceso del usuario de IAM llamado `Bob`. Tenga en cuenta que no puede enumerar las claves de acceso secretas para los usuarios de IAM. Si se pierden las claves de acceso secretas, debe crear nuevas claves de acceso mediante el comando de cmdlet de `New-IAMAccessKey`.**
```
Get-IAMAccessKey -UserName "Bob"
```
**Salida:**
```
AccessKeyId CreateDate Status UserName
----------- ---------- ------ --------
AKIAIOSFODNN7EXAMPLE 12/3/2014 10:53:41 AM Active Bob
AKIAI44QH8DHBEXAMPLE 6/6/2013 8:42:26 PM Inactive Bob
```
+ Para obtener más información sobre la API, consulte [ListAccessKeys](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMAccessKeyLastUsed`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccessKeyLastUsed`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve el nombre de usuario propietario y la información sobre el último uso de la clave de acceso proporcionada.**
```
Get-IAMAccessKeyLastUsed -AccessKeyId ABCDEXAMPLE
```
+ Para obtener más información sobre la API, consulte [GetAccessKeyLastUsed](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMAccountAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccountAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el alias de la cuenta para la Cuenta de AWS.**
```
Get-IAMAccountAlias
```
**Salida:**
```
ExampleCo
```
+ Para obtener más información sobre la API, consulte [ListAccountAliases](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMAccountAuthorizationDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccountAuthorizationDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los detalles de autorización sobre las identidades de la AWS cuenta y se muestra la lista de elementos del objeto devuelto, incluidos los usuarios, los grupos y las funciones. Por ejemplo, la propiedad `UserDetailList` muestra detalles sobre los usuarios. Hay información similar disponible en las propiedades `RoleDetailList` y `GroupDetailList`.**
```
$Details=Get-IAMAccountAuthorizationDetail
$Details
```
**Salida:**
```
GroupDetailList : {Administrators, Developers, Testers, Backup}
IsTruncated : False
Marker :
RoleDetailList : {TestRole1, AdminRole, TesterRole, clirole...}
UserDetailList : {Administrator, Bob, BackupToS3, }
```
```
$Details.UserDetailList
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/Administrator
CreateDate : 10/16/2014 9:03:09 AM
GroupList : {Administrators}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE1
UserName : Administrator
UserPolicyList : {}
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/6/2015 12:54:42 PM
GroupList : {Developers}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE2
UserName : bab
UserPolicyList : {}
Arn : arn:aws:iam::123456789012:user/BackupToS3
CreateDate : 1/27/2015 10:15:08 AM
GroupList : {Backup}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE3
UserName : BackupToS3
UserPolicyList : {BackupServicePermissionsToS3Buckets}
```
+ Para obtener información sobre la API, consulte [GetAccountAuthorizationDetails Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-IAMAccountPasswordPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccountPasswordPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se muestran detalles sobre la política de contraseñas de la cuenta actual. Si no se ha definido una política de contraseñas para la cuenta, el comando devuelve un error de `NoSuchEntity`.**
```
Get-IAMAccountPasswordPolicy
```
**Salida:**
```
AllowUsersToChangePassword : True
ExpirePasswords : True
HardExpiry : False
MaxPasswordAge : 90
MinimumPasswordLength : 8
PasswordReusePrevention : 20
RequireLowercaseCharacters : True
RequireNumbers : True
RequireSymbols : False
RequireUppercaseCharacters : True
```
+ Para obtener más información sobre la API, consulte [GetAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMAccountSummary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAccountSummary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve información sobre el uso actual de la entidad de IAM y las cuotas actuales de entidades de IAM en la Cuenta de AWS.**
```
Get-IAMAccountSummary
```
**Salida:**
```
Key Value
Users 7
GroupPolicySizeQuota 5120
PolicyVersionsInUseQuota 10000
ServerCertificatesQuota 20
AccountSigningCertificatesPresent 0
AccountAccessKeysPresent 0
Groups 3
UsersQuota 5000
RolePolicySizeQuota 10240
UserPolicySizeQuota 2048
GroupsPerUserQuota 10
AssumeRolePolicySizeQuota 2048
AttachedPoliciesPerGroupQuota 2
Roles 9
VersionsPerPolicyQuota 5
GroupsQuota 100
PolicySizeQuota 5120
Policies 5
RolesQuota 250
ServerCertificates 0
AttachedPoliciesPerRoleQuota 2
MFADevicesInUse 2
PoliciesQuota 1000
AccountMFAEnabled 1
Providers 2
InstanceProfilesQuota 100
MFADevices 4
AccessKeysPerUserQuota 2
AttachedPoliciesPerUserQuota 2
SigningCertificatesPerUserQuota 2
PolicyVersionsInUse 4
InstanceProfiles 1
...
```
+ Para obtener más información sobre la API, consulte [GetAccountSummary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMAttachedGroupPolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAttachedGroupPolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los nombres y ARNs las políticas administradas que están asociadas al grupo de IAM mencionado `Admins` en la AWS cuenta. Para ver la lista de políticas integradas en el grupo, utilice el comando `Get-IAMGroupPolicyList`.**
```
Get-IAMAttachedGroupPolicyList -GroupName "Admins"
```
**Salida:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
arn:aws:iam::aws:policy/AdministratorAccess AdministratorAccess
```
+ Para obtener más información sobre la API, consulte [ListAttachedGroupPolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMAttachedRolePolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAttachedRolePolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los nombres y ARNs las políticas administradas asociadas a la función de IAM nombrada `SecurityAuditRole` en la AWS cuenta. Para ver la lista de políticas integradas que están incrustadas en el rol, utilice el comando `Get-IAMRolePolicyList`.**
```
Get-IAMAttachedRolePolicyList -RoleName "SecurityAuditRole"
```
**Salida:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
```
+ Para obtener más información sobre la API, consulte [ListAttachedRolePolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMAttachedUserPolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMAttachedUserPolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los nombres y ARNs las políticas administradas del usuario de IAM mencionado `Bob` en la AWS cuenta. Para ver la lista de políticas integradas que están incrustadas en el usuario de IAM, utilice el comando `Get-IAMUserPolicyList`.**
```
Get-IAMAttachedUserPolicyList -UserName "Bob"
```
**Salida:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/TesterPolicy TesterPolicy
```
+ Para obtener más información sobre la API, consulte [ListAttachedUserPolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMContextKeysForCustomPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMContextKeysForCustomPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo busca todas las claves de contexto presentes en el JSON de la política proporcionada. Para proporcionar varias políticas, puede proporcionarlas como una lista de valores separados por comas.**
```
$policy1 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}'
$policy2 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/"}}'
Get-IAMContextKeysForCustomPolicy -PolicyInputList $policy1,$policy2
```
+ Para obtener más información sobre la API, consulte [GetContextKeysForCustomPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMContextKeysForPrincipalPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMContextKeysForPrincipalPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo busca todas las claves de contexto presentes en el json de la política proporcionado y las políticas asociadas a la entidad de IAM (usuario/rol, etc.). Para: PolicyInputList puede proporcionar una lista de valores múltiples como valores separados por comas.**
```
$policy1 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}'
$policy2 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/"}}'
Get-IAMContextKeysForPrincipalPolicy -PolicyInputList $policy1,$policy2 -PolicySourceArn arn:aws:iam::852640994763:user/TestUser
```
+ Para obtener más información sobre la API, consulte [GetContextKeysForPrincipalPolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMCredentialReport`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMCredentialReport`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se abre el informe devuelto y se envía a la :canalización como una matriz de líneas de texto. La primera línea es el encabezado con los nombres de las columnas separados por comas. Cada fila sucesiva es la fila de detalles de un usuario y cada campo está separado por comas. Para poder ver el informe, debe generarlo con el cmdlet `Request-IAMCredentialReport`. Para recuperar el informe como una cadena única, utilice `-Raw` en lugar de `-AsTextArray`. El alias `-SplitLines` también se acepta para el conmutador `-AsTextArray`. Para ver la lista completa de las columnas de la salida, consulte la Referencia de las API de los servicios. Tenga en cuenta que si no utiliza `-AsTextArray` o `-SplitLines`, debe extraer el texto de la propiedad `.Content`mediante la clase `StreamReader` de .NET.**
```
Request-IAMCredentialReport
```
**Salida:**
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
```
Get-IAMCredentialReport -AsTextArray
```
**Salida:**
```
user,arn,user_creation_time,password_enabled,password_last_used,password_last_changed,password_next_rotation,mfa_active,access_key_1_active,access_key_1_last_rotated,access_key_2_active,access_key_2_last_rotated,cert_1_active,cert_1_last_rotated,cert_2_active,cert_2_last_rotated root_account,arn:aws:iam::123456789012:root,2014-10-15T16:31:25+00:00,not_supported,2015-04-20T17:41:10+00:00,not_supported,not_supported,true,false,N/A,false,N/A,false,N/A,false,N/A
Administrator,arn:aws:iam::123456789012:user/Administrator,2014-10-16T16:03:09+00:00,true,2015-04-20T15:18:32+00:00,2014-10-16T16:06:00+00:00,N/A,false,true,2014-12-03T18:53:41+00:00,true,2015-03-25T20:38:14+00:00,false,N/A,false,N/A
Bill,arn:aws:iam::123456789012:user/Bill,2015-04-15T18:27:44+00:00,false,N/A,N/A,N/A,false,false,N/A,false,N/A,false,2015-04-20T20:00:12+00:00,false,N/A
```
+ Para obtener más información sobre la API, consulte [GetCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMEntitiesForPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMEntitiesForPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se devuelve una lista de grupos, roles y usuarios de IAM que tienen la política adjunta `arn:aws:iam::123456789012:policy/TestPolicy`.**
```
Get-IAMEntitiesForPolicy -PolicyArn "arn:aws:iam::123456789012:policy/TestPolicy"
```
**Salida:**
```
IsTruncated : False
Marker :
PolicyGroups : {}
PolicyRoles : {testRole}
PolicyUsers : {Bob, Theresa}
```
+ Para obtener más información sobre la API, consulte [ListEntitiesForPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve detalles sobre el grupo de IAM `Testers`, incluida una colección de todos los usuarios de IAM que pertenecen al grupo.**
```
$results = Get-IAMGroup -GroupName "Testers"
$results
```
**Salida:**
```
Group IsTruncated Marker Users
----- ----------- ------ -----
Amazon.IdentityManagement.Model.Group False {Theresa, David}
```
```
$results.Group
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : 3RHNZZGQJ7QHMAEXAMPLE1
GroupName : Testers
Path : /
```
```
$results.Users
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/Theresa
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : 4OSVDDJJTF4XEEXAMPLE2
UserName : Theresa
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE3
UserName : David
```
+ Para obtener más información sobre la API, consulte [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMGroupForUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMGroupForUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se devuelve la lista de grupos de IAM a los que pertenece el usuario de IAM `David`.**
```
Get-IAMGroupForUser -UserName David
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:group/Administrators
CreateDate : 10/20/2014 10:06:24 AM
GroupId : 6WCH4TRY3KIHIEXAMPLE1
GroupName : Administrators
Path : /
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : RHNZZGQJ7QHMAEXAMPLE2
GroupName : Testers
Path : /
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 12/10/2014 3:38:55 PM
GroupId : ZU2EOWMK6WBZOEXAMPLE3
GroupName : Developers
Path : /
```
+ Para obtener más información sobre la API, consulte [ListGroupsForUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMGroupList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMGroupList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve una colección de todos los grupos de IAM definidos en el actual. Cuenta de AWS**
```
Get-IAMGroupList
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:group/Administrators
CreateDate : 10/20/2014 10:06:24 AM
GroupId : 6WCH4TRY3KIHIEXAMPLE1
GroupName : Administrators
Path : /
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 12/10/2014 3:38:55 PM
GroupId : ZU2EOWMK6WBZOEXAMPLE2
GroupName : Developers
Path : /
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : RHNZZGQJ7QHMAEXAMPLE3
GroupName : Testers
Path : /
```
+ Para obtener más información sobre la API, consulte [ListGroups Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMGroupPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMGroupPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelven detalles sobre la política en línea incrustada llamada `PowerUserAccess-Testers` del grupo `Testers`. La propiedad `PolicyDocument` tiene codificación de URL. En este ejemplo, se decodifica con el método `UrlDecode` de .NET.**
```
$results = Get-IAMGroupPolicy -GroupName Testers -PolicyName PowerUserAccess-Testers
$results
```
**Salida:**
```
GroupName PolicyDocument PolicyName
--------- -------------- ----------
Testers %7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%0A%20... PowerUserAccess-Testers
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ec2:DescribeInstances"
],
"Resource": [
"arn:aws:ec2:us-east-1:555555555555:instance/i-b188560f"
]
}
]
}
```
+ Para obtener más información sobre la API, consulte [GetGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMGroupPolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMGroupPolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se devuelve una lista de las políticas integradas que están dentro del grupo `Testers`. Para obtener las políticas administradas que están asociadas al grupo, utilice el comando `Get-IAMAttachedGroupPolicyList`.**
```
Get-IAMGroupPolicyList -GroupName Testers
```
**Salida:**
```
Deny-Assume-S3-Role-In-Production
PowerUserAccess-Testers
```
+ Para obtener más información sobre la API, consulte [ListGroupPolicies](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMInstanceProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMInstanceProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve los detalles del perfil de instancia denominado `ec2instancerole` que está definido en la AWS cuenta corriente.**
```
Get-IAMInstanceProfile -InstanceProfileName ec2instancerole
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obtener información sobre la API, consulte [GetInstanceProfile Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-IAMInstanceProfileForRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMInstanceProfileForRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles del perfil de instancia asociado al rol `ec2instancerole`.**
```
Get-IAMInstanceProfileForRole -RoleName ec2instancerole
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obtener más información sobre la API, consulte [ListInstanceProfilesForRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMInstanceProfileList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMInstanceProfileList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve una colección de los perfiles de instancia definidos en la versión actual Cuenta de AWS.**
```
Get-IAMInstanceProfileList
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obtener más información sobre la API, consulte [ListInstanceProfiles Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-IAMLoginProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMLoginProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve la fecha de creación de la contraseña y si es necesario restablecer la contraseña del usuario `David` de IAM.**
```
Get-IAMLoginProfile -UserName David
```
**Salida:**
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
12/10/2014 3:39:44 PM False David
```
+ Para obtener más información sobre la API, consulte [GetLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo devuelve detalles sobre el dispositivo MFA asignado al usuario de IAM `David`. En este ejemplo, puede darse cuenta de que es un dispositivo virtual porque el `SerialNumber` es un ARN en lugar del número de serie real de un dispositivo físico.**
```
Get-IAMMFADevice -UserName David
```
**Salida:**
```
EnableDate SerialNumber UserName
---------- ------------ --------
4/8/2015 9:41:10 AM arn:aws:iam::123456789012:mfa/David David
```
+ Para obtener más información sobre la API, consulte [ListMfaDevices](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMOpenIDConnectProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMOpenIDConnectProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen detalles sobre el proveedor de OpenID Connect cuyo ARN es `arn:aws:iam::123456789012:oidc-provider/accounts.google.com`. La `ClientIDList` propiedad es una colección que contiene todos los clientes IDs definidos para este proveedor.**
```
Get-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/oidc.example.com
```
**Salida:**
```
ClientIDList CreateDate ThumbprintList Url
------------ ---------- -------------- ---
{MyOIDCApp} 2/3/2015 3:00:30 PM {12345abcdefghijk67890lmnopqrst98765uvwxy} oidc.example.com
```
+ Para obtener más información sobre la API, consulte [GetOpenIdConnectProvider Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-IAMOpenIDConnectProviderList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMOpenIDConnectProviderList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se devuelve una lista de los ARN de todos los proveedores de OpenID Connect que están definidos en la Cuenta de AWS actual.**
```
Get-IAMOpenIDConnectProviderList
```
**Salida:**
```
Arn
---
arn:aws:iam::123456789012:oidc-provider/server.example.com
arn:aws:iam::123456789012:oidc-provider/another.provider.com
```
+ Para obtener más información sobre la API, consulte [ListOpenIdConnectProviders](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se obtienen detalles sobre la política administrada cuyo ARN es `arn:aws:iam::123456789012:policy/MySamplePolicy`.**
```
Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**Salida:**
```
Arn : arn:aws:iam::aws:policy/MySamplePolicy
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:08 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : Z27SI6FQMGNQ2EXAMPLE1
PolicyName : MySamplePolicy
UpdateDate : 2/6/2015 10:40:08 AM
```
+ Para obtener más información sobre la API, consulte [GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMPolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMPolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve una colección de las tres primeras políticas administradas disponibles en la AWS cuenta corriente. Como no `-scope` se especifica, de forma predeterminada es `all` e incluye tanto las políticas administradas como las AWS administradas por el cliente.**
```
Get-IAMPolicyList -MaxItem 3
```
**Salida:**
```
Arn : arn:aws:iam::aws:policy/AWSDirectConnectReadOnlyAccess
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:08 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : Z27SI6FQMGNQ2EXAMPLE1
PolicyName : AWSDirectConnectReadOnlyAccess
UpdateDate : 2/6/2015 10:40:08 AM
Arn : arn:aws:iam::aws:policy/AmazonGlacierReadOnlyAccess
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:27 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : NJKMU274MET4EEXAMPLE2
PolicyName : AmazonGlacierReadOnlyAccess
UpdateDate : 2/6/2015 10:40:27 AM
Arn : arn:aws:iam::aws:policy/AWSMarketplaceFullAccess
AttachmentCount : 0
CreateDate : 2/11/2015 9:21:45 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : 5ULJSO2FYVPYGEXAMPLE3
PolicyName : AWSMarketplaceFullAccess
UpdateDate : 2/11/2015 9:21:45 AM
```
**Ejemplo 2: Este ejemplo devuelve un conjunto de las dos primeras políticas gestionadas por el cliente disponibles en la AWS cuenta corriente. Se utiliza `-Scope local` para limitar la salida únicamente a las políticas administradas por el cliente.**
```
Get-IAMPolicyList -Scope local -MaxItem 2
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:policy/MyLocalPolicy
AttachmentCount : 0
CreateDate : 2/12/2015 9:39:09 AM
DefaultVersionId : v2
Description :
IsAttachable : True
Path : /
PolicyId : SQVCBLC4VAOUCEXAMPLE4
PolicyName : MyLocalPolicy
UpdateDate : 2/12/2015 9:39:53 AM
Arn : arn:aws:iam::123456789012:policy/policyforec2instancerole
AttachmentCount : 1
CreateDate : 2/17/2015 2:51:38 PM
DefaultVersionId : v11
Description :
IsAttachable : True
Path : /
PolicyId : X5JPBLJH2Z2SOEXAMPLE5
PolicyName : policyforec2instancerole
UpdateDate : 2/18/2015 8:52:31 AM
```
+ Para obtener más información sobre la API, consulte [ListPolicies Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-IAMPolicyVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMPolicyVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se devuelve el documento de política para la versión `v2` de la política cuyo ARN es `arn:aws:iam::123456789012:policy/MyManagedPolicy`. El documento de política en la propiedad `Document` tiene codificación de URL y se decodifica en este ejemplo con el método `UrlDecode` de .NET.**
```
$results = Get-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy -VersionId v2
$results
```
**Salida:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
2/12/2015 9:39:53 AM %7B%0A%20%20%22Version%22%3A%20%222012-10... True v2
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
$policy = [System.Web.HttpUtility]::UrlDecode($results.Document)
$policy
{
"Version":"2012-10-17",
"Statement":
{
"Effect": "Allow",
"Action": [
"ec2:DescribeInstances"
],
"Resource": [
"arn:aws:ec2:us-east-1:555555555555:instance/i-b188560f"
]
}
}
```
+ Para obtener más información sobre la API, consulte [GetPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMPolicyVersionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMPolicyVersionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve la lista de versiones disponibles de la política cuyo ARN es `arn:aws:iam::123456789012:policy/MyManagedPolicy`. Para obtener el documento de política de una versión específica, utilice el comando `Get-IAMPolicyVersion` y especifique el `VersionId` que desee.**
```
Get-IAMPolicyVersionList -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy
```
**Salida:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
2/12/2015 9:39:53 AM True v2
2/12/2015 9:39:09 AM False v1
```
+ Para obtener más información sobre la API, consulte [ListPolicyVersions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo devuelve los detalles de`lamda_exec_role`. Incluye el documento de política de confianza que especifica quién puede asumir este rol. El documento de política está codificado en URL y se puede decodificar mediante el método `UrlDecode` de .NET. En este ejemplo, se eliminaron todos los espacios en blanco de la política original antes de cargarla en la política. Para ver los documentos de la política de permisos que determinan lo que puede hacer una persona que asume el rol, utilice `Get-IAMRolePolicy` para las políticas integradas y `Get-IAMPolicyVersion` para las políticas administradas adjuntas.**
```
$results = Get-IamRole -RoleName lambda_exec_role
$results | Format-List
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:role/lambda_exec_role
AssumeRolePolicyDocument : %7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22
%3A%22%22%2C%22Effect%22%3A%22Allow%22%2C%22Principal%22%3A%7B%22Service
%22%3A%22lambda.amazonaws.com%22%7D%2C%22Action%22%3A%22sts%3AAssumeRole
%22%7D%5D%7D
CreateDate : 4/2/2015 9:16:11 AM
Path : /
RoleId : 2YBIKAIBHNKB4EXAMPLE1
RoleName : lambda_exec_role
```
```
$policy = [System.Web.HttpUtility]::UrlDecode($results.AssumeRolePolicyDocument)
$policy
```
**Salida:**
```
{"Version":"2012-10-17", "Statement":[{"Sid":"","Effect":"Allow","Principal":{"Service":"lambda.amazonaws.com"},"Action":"sts:AssumeRole"}]}
```
+ Para obtener más información sobre la API, consulte [GetRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMRoleList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMRoleList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera una lista de todos los roles de IAM de la Cuenta de AWS.**
```
Get-IAMRoleList
```
+ Para obtener más información sobre la API, consulte [ListRoles](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve el documento de política de permisos de la política denominada `oneClick_lambda_exec_role_policy` que está incrustado en el rol de IAM `lamda_exec_role`. El documento de política resultante tiene codificación de URL. En este ejemplo, se decodifica con el método `UrlDecode` de .NET.**
```
$results = Get-IAMRolePolicy -RoleName lambda_exec_role -PolicyName oneClick_lambda_exec_role_policy
$results
```
**Salida:**
```
PolicyDocument PolicyName UserName
-------------- ---------- --------
%7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%... oneClick_lambda_exec_role_policy lambda_exec_role
```
```
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
```
**Salida:**
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"logs:*"
],
"Resource": "arn:aws:logs:us-east-1:555555555555:log-group:/aws/lambda/aws-example-function:*"
},
{
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:PutObject"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket/*"
]
}
]
}
```
+ Para obtener más información sobre la API, consulte [GetRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMRolePolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMRolePolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve la lista de nombres de las políticas incrustadas que están integradas en el rol de IAM `lamda_exec_role`. Para ver los detalles de una política incrustada, utilice el comando `Get-IAMRolePolicy`.**
```
Get-IAMRolePolicyList -RoleName lambda_exec_role
```
**Salida:**
```
oneClick_lambda_exec_role_policy
```
+ Para obtener más información sobre la API, consulte [ListRolePolicies](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMRoleTagList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMRoleTagList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera la etiqueta asociada con el rol.**
```
Get-IAMRoleTagList -RoleName MyRoleName
```
+ Para obtener más información sobre la API, consulte [ListRoleTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMSAMLProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMSAMLProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan los detalles sobre el proveedor SAML 2.0 cuyo ARM es arn:aws:iam::123456789012:saml-provider/SAMLADFS. La respuesta incluye el documento de metadatos que recibió del proveedor de identidades para crear la entidad proveedora de AWS SAML, así como las fechas de creación y caducidad.**
```
Get-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS
```
**Salida:**
```
CreateDate SAMLMetadataDocument ValidUntil
---------- -------------------- ----------
12/23/2014 12:16:55 PM
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMSAMLProviderList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo recupera la lista de proveedores SAML 2.0 creados en la Cuenta de AWS actual. Devuelve el ARN, la fecha de creación y la fecha de caducidad de cada proveedor SAML.**
```
Get-IAMSAMLProviderList
```
**Salida:**
```
Arn CreateDate ValidUntil
--- ---------- ----------
arn:aws:iam::123456789012:saml-provider/SAMLADFS 12/23/2014 12:16:55 PM 12/23/2114 12:16:54 PM
```
+ Para obtener más información sobre la API, consulte la [lista SAMLProviders](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMServerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMServerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan detalles sobre el certificado de servidor llamado `MyServerCertificate`. Puede encontrar los detalles del certificado en las propiedades `CertificateBody` y `ServerCertificateMetadata`.**
```
$result = Get-IAMServerCertificate -ServerCertificateName MyServerCertificate
$result | format-list
```
**Salida:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateChain :
ServerCertificateMetadata : Amazon.IdentityManagement.Model.ServerCertificateMetadata
```
```
$result.ServerCertificateMetadata
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate
Expiration : 1/14/2018 9:52:36 AM
Path : /Org1/Org2/
ServerCertificateId : ASCAJIFEXAMPLE17HQZYW
ServerCertificateName : MyServerCertificate
UploadDate : 4/21/2015 11:14:16 AM
```
+ Para obtener más información sobre la API, consulte [GetServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMServerCertificateList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMServerCertificateList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera la lista de certificados de servidor que han sido cargados en la Cuenta de AWS actual.**
```
Get-IAMServerCertificateList
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate
Expiration : 1/14/2018 9:52:36 AM
Path : /Org1/Org2/
ServerCertificateId : ASCAJIFEXAMPLE17HQZYW
ServerCertificateName : MyServerCertificate
UploadDate : 4/21/2015 11:14:16 AM
```
+ Para obtener más información sobre la API, consulte [ListServerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMServiceLastAccessedDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMServiceLastAccessedDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se proporcionan detalles del último servicio al que accedió la entidad de IAM (usuario, grupo, rol o política) asociada a la llamada de solicitud.**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
**Salida:**
```
f0b7a819-eab0-929b-dc26-ca598911cb9f
```
```
Get-IAMServiceLastAccessedDetail -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f
```
+ Para obtener más información sobre la API, consulte [GetServiceLastAccessedDetails](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMServiceLastAccessedDetailWithEntity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMServiceLastAccessedDetailWithEntity`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo proporciona la marca de tiempo del último acceso al servicio en la solicitud de la entidad de IAM correspondiente.**
```
$results = Get-IAMServiceLastAccessedDetailWithEntity -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f -ServiceNamespace ec2
$results
```
**Salida:**
```
EntityDetailsList : {Amazon.IdentityManagement.Model.EntityDetails}
Error :
IsTruncated : False
JobCompletionDate : 12/29/19 11:19:31 AM
JobCreationDate : 12/29/19 11:19:31 AM
JobStatus : COMPLETED
Marker :
```
```
$results.EntityDetailsList
```
**Salida:**
```
EntityInfo LastAuthenticated
---------- -----------------
Amazon.IdentityManagement.Model.EntityInfo 11/16/19 3:47:00 PM
```
```
$results.EntityInfo
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/TestUser
Id : AIDA4NBK5CXF5TZHU1234
Name : TestUser
Path : /
Type : USER
```
+ Para obtener más información sobre la API, consulte [GetServiceLastAccessedDetailsWithEntities](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMSigningCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMSigningCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan los detalles sobre el certificado de firma que está asociado con el usuario llamado `Bob`.**
```
Get-IAMSigningCertificate -UserName Bob
```
**Salida:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateId : Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU
Status : Active
UploadDate : 4/20/2015 1:26:01 PM
UserName : Bob
```
+ Para obtener más información sobre la API, consulte [ListSigningCertificates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan detalles sobre el usurario llamado `David`.**
```
Get-IAMUser -UserName David
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE1
UserName : David
```
**Ejemplo 2: en este ejemplo se recuperan detalles sobre el usuario de IAM que ha iniciado sesión actualmente.**
```
Get-IAMUser
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 10/16/2014 9:03:09 AM
PasswordLastUsed : 3/4/2015 12:12:33 PM
Path : /
UserId : 7K3GJEANSKZF2EXAMPLE2
UserName : Bob
```
+ Para obtener más información sobre la API, consulte [GetUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMUserList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMUserList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo recupera un conjunto de usuarios de la versión actual. Cuenta de AWS**
```
Get-IAMUserList
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/Administrator
CreateDate : 10/16/2014 9:03:09 AM
PasswordLastUsed : 3/4/2015 12:12:33 PM
Path : /
UserId : 7K3GJEANSKZF2EXAMPLE1
UserName : Administrator
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/6/2015 12:54:42 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : L3EWNONDOM3YUEXAMPLE2
UserName : bab
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE3
UserName : David
```
+ Para obtener más información sobre la API, consulte [ListUsers Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-IAMUserPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMUserPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan los detalles de la política incrustada `Davids_IAM_Admin_Policy` que está integrada en el usuario de IAM llamado `David`. El documento de política tiene codificación de URL.**
```
$results = Get-IAMUserPolicy -PolicyName Davids_IAM_Admin_Policy -UserName David
$results
```
**Salida:**
```
PolicyDocument PolicyName UserName
-------------- ---------- --------
%7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%... Davids_IAM_Admin_Policy David
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"iam:GetUser",
"iam:ListUsers"
],
"Resource": [
"arn:aws:iam::111122223333:user/*"
]
}
]
}
```
+ Para obtener más información sobre la API, consulte [GetUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMUserPolicyList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMUserPolicyList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera la lista de nombres de las políticas incrustadas que están integradas en el usuario de IAM llamado `David`.**
```
Get-IAMUserPolicyList -UserName David
```
**Salida:**
```
Davids_IAM_Admin_Policy
```
+ Para obtener más información sobre la API, consulte [ListUserPolicies](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMUserTagList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMUserTagList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera la etiqueta asociada con el usuario.**
```
Get-IAMUserTagList -UserName joe
```
+ Para obtener más información sobre la API, consulte [ListUserTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-IAMVirtualMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-IAMVirtualMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo recupera una colección de dispositivos MFA virtuales que están asignados a los usuarios de la cuenta. AWS La propiedad `User` de cada uno es un objeto con detalles del usuario de IAM al que está asignado el dispositivo.**
```
Get-IAMVirtualMFADevice -AssignmentStatus Assigned
```
**Salida:**
```
Base32StringSeed :
EnableDate : 4/13/2015 12:03:42 PM
QRCodePNG :
SerialNumber : arn:aws:iam::123456789012:mfa/David
User : Amazon.IdentityManagement.Model.User
Base32StringSeed :
EnableDate : 4/13/2015 12:06:41 PM
QRCodePNG :
SerialNumber : arn:aws:iam::123456789012:mfa/root-account-mfa-device
User : Amazon.IdentityManagement.Model.User
```
+ Para obtener más información sobre la API, consulte [ListVirtualMfaDevices Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-IAMAccessKey`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMAccessKey`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo par de clave de acceso y clave de acceso secreta y se lo asigna al usuario `David`. Asegúrese de guardar los valores de `AccessKeyId` y `SecretAccessKey` en un archivo, porque es la única oportunidad que tiene para obtener la `SecretAccessKey`. No puede recuperarla más tarde. Si pierde la clave secreta, debe crear un nuevo par de claves de acceso.**
```
New-IAMAccessKey -UserName David
```
**Salida:**
```
AccessKeyId : AKIAIOSFODNN7EXAMPLE
CreateDate : 4/13/2015 1:00:42 PM
SecretAccessKey : wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Status : Active
UserName : David
```
+ Para obtener más información sobre la API, consulte [CreateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMAccountAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMAccountAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el alias de su AWS cuenta a`mycompanyaws`. La dirección de la página de inicio de sesión del usuario cambia a panyaws.signin.aws.amazon.com/console https://mycom. La URL original con el número de ID de cuenta en lugar del alias (https://.signin.aws.amazon.com/console) sigue funcionando. Sin embargo, URLs cualquier alias previamente definido deja de funcionar.**
```
New-IAMAccountAlias -AccountAlias mycompanyaws
```
+ Para obtener más información sobre la API, consulte [CreateAccountAlias Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `New-IAMGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo grupo de IAM denominado `Developers`.**
```
New-IAMGroup -GroupName Developers
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 4/14/2015 11:21:31 AM
GroupId : QNEJ5PM4NFSQCEXAMPLE1
GroupName : Developers
Path : /
```
+ Para obtener más información sobre la API, consulte [CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMInstanceProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMInstanceProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo perfil de instancia de IAM denominado `ProfileForDevEC2Instance`. Debe ejecutar el comando `Add-IAMRoleToInstanceProfile` por separado para asociar el perfil de instancia a un rol de IAM existente que otorgue permisos a la instancia. Por último, adjuntar el perfil de instancia a una instancia de EC2 en el momento de iniciarla. Para ello, utilice el cmdlet de `New-EC2Instance` con el parámetro `InstanceProfile_Arn` o `InstanceProfile_Name`.**
```
New-IAMInstanceProfile -InstanceProfileName ProfileForDevEC2Instance
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ProfileForDevEC2Instance
CreateDate : 4/14/2015 11:31:39 AM
InstanceProfileId : DYMFXL556EY46EXAMPLE1
InstanceProfileName : ProfileForDevEC2Instance
Path : /
Roles : {}
```
+ Para obtener más información sobre la API, consulte [CreateInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMLoginProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMLoginProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una contraseña (temporal) para el usuario de IAM llamado Bob y se establece el indicador que exige que el usuario `Bob` cambie la contraseña la próxima vez que inicie sesión.**
```
New-IAMLoginProfile -UserName Bob -Password P@ssw0rd -PasswordResetRequired $true
```
**Salida:**
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
4/14/2015 12:26:30 PM True Bob
```
+ Para obtener más información sobre la API, consulte [CreateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMOpenIDConnectProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMOpenIDConnectProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un proveedor OIDC de IAM asociado al servicio de proveedor compatible con el OIDC que se encuentra en la URL `https://example.oidcprovider.com` y en el ID de cliente `my-testapp-1`. El proveedor del OIDC suministra la huella digital. Para autenticar la huella digital, sigue los pasos que se indican en http://docs.aws.amazon. com/IAM/latest/UserGuide/identity**- providers-oidc-obtain-thumbprint .html.
```
New-IAMOpenIDConnectProvider -Url https://example.oidcprovider.com -ClientIDList my-testapp-1 -ThumbprintList 990F419EXAMPLEECF12DDEDA5EXAMPLE52F20D9E
```
**Salida:**
```
arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ Para obtener más información sobre la API, consulte [CreateOpenIdConnectProvider Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-IAMPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una nueva política de IAM en la AWS cuenta corriente denominada El archivo `MySamplePolicy.json` proporciona `MySamplePolicy` el contenido de la política. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el archivo de políticas JSON.**
```
New-IAMPolicy -PolicyName MySamplePolicy -PolicyDocument (Get-Content -Raw MySamplePolicy.json)
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:policy/MySamplePolicy
AttachmentCount : 0
CreateDate : 4/14/2015 2:45:59 PM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : LD4KP6HVFE7WGEXAMPLE1
PolicyName : MySamplePolicy
UpdateDate : 4/14/2015 2:45:59 PM
```
+ Para obtener información sobre la API, consulte [CreatePolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-IAMPolicyVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMPolicyVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se crea una nueva versión “v2” de la política de IAM cuyo ARN es `arn:aws:iam::123456789012:policy/MyPolicy` y se la convierte en la versión predeterminada. El archivo `NewPolicyVersion.json` proporciona el contenido de la política. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el archivo de políticas JSON.**
```
New-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -PolicyDocument (Get-content -Raw NewPolicyVersion.json) -SetAsDefault $true
```
**Salida:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
4/15/2015 10:54:54 AM True v2
```
+ Para obtener más información sobre la API, consulte [CreatePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo rol con el nombre `MyNewRole` y se le adjunta la política que se encuentra en el archivo `NewRoleTrustPolicy.json`. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el archivo de políticas JSON. El documento de política que se muestra en el resultado tiene codificación de URL. En este ejemplo, se decodifica con el método `UrlDecode` de .NET.**
```
$results = New-IAMRole -AssumeRolePolicyDocument (Get-Content -raw NewRoleTrustPolicy.json) -RoleName MyNewRole
$results
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:role/MyNewRole
AssumeRolePolicyDocument : %7B%0D%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%0D%0A%20%20%22Statement%22
%3A%20%5B%0D%0A%20%20%20%20%7B%0D%0A%20%20%20%20%20%20%22Sid%22%3A%20%22%22%2C
%0D%0A%20%20%20%20%20%20%22Effect%22%3A%20%22Allow%22%2C%0D%0A%20%20%20%20%20%20
%22Principal%22%3A%20%7B%0D%0A%20%20%20%20%20%20%20%20%22AWS%22%3A%20%22arn%3Aaws
%3Aiam%3A%3A123456789012%3ADavid%22%0D%0A%20%20%20%20%20%20%7D%2C%0D%0A%20%20%20
%20%20%20%22Action%22%3A%20%22sts%3AAssumeRole%22%0D%0A%20%20%20%20%7D%0D%0A%20
%20%5D%0D%0A%7D
CreateDate : 4/15/2015 11:04:23 AM
Path : /
RoleId : V5PAJI2KPN4EAEXAMPLE1
RoleName : MyNewRole
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.AssumeRolePolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:David"
},
"Action": "sts:AssumeRole"
}
]
}
```
+ Para obtener más información sobre la API, consulte [CreateRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMSAMLProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMSAMLProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una nueva entidad de proveedor SAML en IAM. Se denomina `MySAMLProvider` y se describe en el documento de metadatos SAML que se encuentra en el archivo `SAMLMetaData.xml`, que se descargó por separado del sitio web del proveedor de servicios SAML.**
```
New-IAMSAMLProvider -Name MySAMLProvider -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
**Salida:**
```
arn:aws:iam::123456789012:saml-provider/MySAMLProvider
```
+ Para obtener más información sobre la API, consulte [Create SAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `New-IAMServiceLinkedRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMServiceLinkedRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un rol vinculado a un servicio para el servicio de escalado automático.**
```
New-IAMServiceLinkedRole -AWSServiceName autoscaling.amazonaws.com -CustomSuffix RoleNameEndsWithThis -Description "My service-linked role to support autoscaling"
```
+ Para obtener más información sobre la API, consulte [CreateServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-IAMUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un usuario de IAM denominado `Bob`. Si Bob necesita iniciar sesión en la AWS consola, debe ejecutar el comando por separado `New-IAMLoginProfile` para crear un perfil de inicio de sesión con una contraseña. Si Bob necesita ejecutar AWS PowerShell comandos CLI multiplataforma o realizar llamadas a la AWS API, debe ejecutar el `New-IAMAccessKey` comando por separado para crear claves de acceso.**
```
New-IAMUser -UserName Bob
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/22/2015 12:02:11 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : AIDAJWGEFDMEMEXAMPLE1
UserName : Bob
```
+ Para obtener más información sobre la API, consulte [CreateUser Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-IAMVirtualMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-IAMVirtualMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo dispositivo MFA virtual. Las líneas 2 y 3 extraen el valor `Base32StringSeed` que el programa de software de MFA virtual necesita para crear una cuenta (como alternativa al código QR). Después de configurar el programa con el valor, obtenga dos códigos de autenticación secuenciales del programa. Por último, utilice el último comando para vincular el dispositivo MFA virtual al usuario de IAM `Bob` y sincronizar la cuenta con los dos códigos de autenticación.**
```
$Device = New-IAMVirtualMFADevice -VirtualMFADeviceName BobsMFADevice
$SR = New-Object System.IO.StreamReader($Device.Base32StringSeed)
$base32stringseed = $SR.ReadToEnd()
$base32stringseed
CZWZMCQNW4DEXAMPLE3VOUGXJFZYSUW7EXAMPLECR4NJFD65GX2SLUDW2EXAMPLE
```
**Salida:**
```
-- Pause here to enter base-32 string seed code into virtual MFA program to register account. --
Enable-IAMMFADevice -SerialNumber $Device.SerialNumber -UserName Bob -AuthenticationCode1 123456 -AuthenticationCode2 789012
```
**Ejemplo 2: en este ejemplo se crea un nuevo dispositivo MFA virtual. Las líneas 2 y 3 extraen el valor `QRCodePNG` y lo escriben en un archivo. El programa de software MFA virtual puede escanear esta imagen para crear una cuenta (como alternativa a introducir manualmente el valor Base32StringSeed ). Después de crear la cuenta en el programa de MFA virtual, obtenga dos códigos de autenticación secuenciales e introdúzcalos en los últimos comandos para vincular el dispositivo MFA virtual al usuario de IAM `Bob` y sincronizar la cuenta.**
```
$Device = New-IAMVirtualMFADevice -VirtualMFADeviceName BobsMFADevice
$BR = New-Object System.IO.BinaryReader($Device.QRCodePNG)
$BR.ReadBytes($BR.BaseStream.Length) | Set-Content -Encoding Byte -Path QRCode.png
```
**Salida:**
```
-- Pause here to scan PNG with virtual MFA program to register account. --
Enable-IAMMFADevice -SerialNumber $Device.SerialNumber -UserName Bob -AuthenticationCode1 123456 -AuthenticationCode2 789012
```
+ Para obtener más información sobre la API, consulte [CreateVirtualMfaDevice Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Publish-IAMServerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Publish-IAMServerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se carga un nuevo certificado de servidor en la cuenta de IAM. Los archivos que contienen el cuerpo del certificado, la clave privada y la cadena de certificados (opcional) deben tener todos codificación PEM. Tenga en cuenta que los parámetros requieren el contenido real de los archivos y no los nombres de los archivos. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el contenido del archivo.**
```
Publish-IAMServerCertificate -ServerCertificateName MyTestCert -CertificateBody (Get-Content -Raw server.crt) -PrivateKey (Get-Content -Raw server.key)
```
**Salida:**
```
Arn : arn:aws:iam::123456789012:server-certificate/MyTestCert
Expiration : 1/14/2018 9:52:36 AM
Path : /
ServerCertificateId : ASCAJIEXAMPLE7J7HQZYW
ServerCertificateName : MyTestCert
UploadDate : 4/21/2015 11:14:16 AM
```
+ Para obtener más información sobre la API, consulte [UploadServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Publish-IAMSigningCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Publish-IAMSigningCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se carga un nuevo certificado de firma X.509 y se asocia al usuario de IAM denominado `Bob`. El archivo que contiene el cuerpo del certificado está codificado en PEM. El parámetro `CertificateBody` requiere el contenido real del archivo de certificado y no el nombre del archivo. Debe usar el parámetro de conmutación `-Raw` para procesar correctamente el archivo.**
```
Publish-IAMSigningCertificate -UserName Bob -CertificateBody (Get-Content -Raw SampleSigningCert.pem)
```
**Salida:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateId : Y3EK7RMEXAMPLESV33FCEXAMPLEHMJLU
Status : Active
UploadDate : 4/20/2015 1:26:01 PM
UserName : Bob
```
+ Para obtener más información sobre la API, consulte [UploadSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-IAMGroupPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-IAMGroupPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se adjunta la política administrada por el cliente denominada `TesterPolicy` al grupo de IAM de `Testers`. Los usuarios de ese grupo se ven afectados inmediatamente por los permisos definidos en la versión predeterminada de esa política.**
```
Register-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**Ejemplo 2: en este ejemplo se adjunta la política AWS gestionada denominada `AdministratorAccess` al grupo de IAM. `Admins` Los usuarios de ese grupo se ven afectados inmediatamente por los permisos definidos en la última versión de esa política.**
```
Register-IAMGroupPolicy -GroupName Admins -PolicyArn arn:aws:iam::aws:policy/AdministratorAccess
```
+ Para obtener más información sobre la API, consulte [AttachGroupPolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Register-IAMRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-IAMRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se adjunta la política AWS gestionada denominada `SecurityAudit` a la función de IAM. `CoSecurityAuditors` Los usuarios que asumen ese rol se ven afectados de inmediato por los permisos definidos en la última versión de esa política.**
```
Register-IAMRolePolicy -RoleName CoSecurityAuditors -PolicyArn arn:aws:iam::aws:policy/SecurityAudit
```
+ Para obtener más información sobre la API, consulte [AttachRolePolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Register-IAMUserPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-IAMUserPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se adjunta la política AWS gestionada denominada `AmazonCognitoPowerUser` al usuario de IAM. `Bob` El usuario se ve afectado de inmediato por los permisos definidos en la última versión de esa política.**
```
Register-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::aws:policy/AmazonCognitoPowerUser
```
+ Para obtener más información sobre la API, consulte [AttachUserPolicy Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Remove-IAMAccessKey`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMAccessKey`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el par de claves de AWS acceso con el ID `AKIAIOSFODNN7EXAMPLE` de clave del usuario nombrado`Bob`.**
```
Remove-IAMAccessKey -AccessKeyId AKIAIOSFODNN7EXAMPLE -UserName Bob -Force
```
+ Para obtener más información sobre la API, consulte [DeleteAccessKey Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-IAMAccountAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMAccountAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina el alias de la cuenta de su Cuenta de AWS. La página de inicio de sesión del usuario con el alias https://mycom panyaws.signin.aws.amazon.com/console ya no funciona. En su lugar, debes usar la URL original con tu número de identificación en https://.signin.aws.amazon.com/console. Cuenta de AWS **
```
Remove-IAMAccountAlias -AccountAlias mycompanyaws
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5). [DeleteAccountAlias](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Remove-IAMAccountPasswordPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMAccountPasswordPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la política de contraseñas Cuenta de AWS y se restablecen todos los valores a sus valores predeterminados originales. Si actualmente no existe una política de contraseñas, aparece el siguiente mensaje de error: PasswordPolicy No se encuentra la política de cuentas con el nombre.**
```
Remove-IAMAccountPasswordPolicy
```
+ Para obtener más información sobre la API, consulte [DeleteAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (V5)*.
### `Remove-IAMClientIDFromOpenIDConnectProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMClientIDFromOpenIDConnectProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina el ID `My-TestApp-3` de cliente de la lista de clientes IDs asociados al proveedor OIDC de IAM cuyo ARN es. `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com`**
```
Remove-IAMClientIDFromOpenIDConnectProvider -ClientID My-TestApp-3 -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [RemoveClientIdFromOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Remove-IAMGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el grupo de IAM denominado `MyTestGroup`. El primer comando elimina todos los usuarios de IAM que sean miembros del grupo y el segundo elimina el grupo de IAM. Ambos comandos funcionan sin ninguna solicitud de confirmación.**
```
(Get-IAMGroup -GroupName MyTestGroup).Users | Remove-IAMUserFromGroup -GroupName MyTestGroup -Force
Remove-IAMGroup -GroupName MyTestGroup -Force
```
+ Para obtener más información sobre la API, consulte [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMGroupPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMGroupPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la política incrustada llamada `TesterPolicy` del grupo de IAM `Testers`. Los usuarios de ese grupo pierden los permisos definidos en esa política de inmediato.**
```
Remove-IAMGroupPolicy -GroupName Testers -PolicyName TestPolicy
```
+ Para obtener más información sobre la API, consulte [DeleteGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMInstanceProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMInstanceProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el perfil de instancia de EC2 denominado `MyAppInstanceProfile`. El primer comando separa todos los roles del perfil de instancia y, a continuación, el segundo comando elimina el perfil de instancia.**
```
(Get-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile).Roles | Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyAppInstanceProfile
Remove-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile
```
+ Para obtener más información sobre la API, consulte [DeleteInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMLoginProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMLoginProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el perfil de inicio de sesión del usuario de IAM llamado `Bob`. Esto impide que el usuario inicie sesión en la consola. AWS No impide que el usuario ejecute ninguna llamada a la AWS CLI o a la API mediante claves de AWS acceso que aún estén adjuntas a la cuenta de usuario. PowerShell**
```
Remove-IAMLoginProfile -UserName Bob
```
+ Para obtener más información sobre la API, consulte [DeleteLoginProfile Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-IAMOpenIDConnectProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMOpenIDConnectProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el proveedor de OIDC de IAM que se conecta al proveedor `example.oidcprovider.com`. Asegúrese de actualizar o eliminar todos los roles que hagan referencia a este proveedor en el elemento `Principal` de la política de confianza del rol.**
```
Remove-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ Para obtener más información sobre la API, consulte [DeleteOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la política cuyo ARN es `arn:aws:iam::123456789012:policy/MySamplePolicy`. Antes de eliminar la política, primero debe eliminar todas las versiones, excepto la predeterminada, mediante la ejecución de `Remove-IAMPolicyVersion`. También debe separar la política de todos los usuarios, grupos o roles de IAM.**
```
Remove-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**Ejemplo 2: en este ejemplo, se elimina una política; en primer lugar, se eliminan todas las versiones de la política que no son las predeterminadas, se separa de todas las entidades de IAM asociadas y, por último, se elimina la propia política. La primera línea recupera el objeto de política. La segunda línea recupera todas las versiones de la política que no están marcadas como la versión predeterminada de una colección y, a continuación, elimina todas las políticas de la colección. La tercera línea recupera todos los usuarios, grupos y roles de IAM a los que se asocia la política. Las líneas cuatro a seis separan la política de cada entidad adjunta. La última línea usa este comando para eliminar la política administrada, así como la versión predeterminada restante. El ejemplo incluye el parámetro de conmutación `-Force` en cualquier línea que lo necesite para suprimir las solicitudes de confirmación.**
```
$pol = Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
Get-IAMPolicyVersions -PolicyArn $pol.Arn | where {-not $_.IsDefaultVersion} | Remove-IAMPolicyVersion -PolicyArn $pol.Arn -force
$attached = Get-IAMEntitiesForPolicy -PolicyArn $pol.Arn
$attached.PolicyGroups | Unregister-IAMGroupPolicy -PolicyArn $pol.arn
$attached.PolicyRoles | Unregister-IAMRolePolicy -PolicyArn $pol.arn
$attached.PolicyUsers | Unregister-IAMUserPolicy -PolicyArn $pol.arn
Remove-IAMPolicy $pol.Arn -Force
```
+ Para obtener más información sobre la API, consulte [DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMPolicyVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMPolicyVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la versión identificada como `v2` de la política cuyo ARN es `arn:aws:iam::123456789012:policy/MySamplePolicy`.**
```
Remove-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy -VersionID v2
```
**Ejemplo 2: en este ejemplo, se elimina una política; en primer lugar, se eliminan todas las versiones de la política que no son predeterminadas y, a continuación, se elimina la propia política. La primera línea recupera el objeto de política. La segunda línea recupera todas las versiones de la política que no están marcadas como predeterminadas en una colección y, a continuación, utiliza este comando para eliminar cada política de la colección. La última línea elimina la política en sí, así como el resto de la versión predeterminada. Tenga en cuenta que para eliminar correctamente una política administrada, también debe separar la política de cualquier usuario, grupo o rol mediante los comandos `Unregister-IAMUserPolicy`, `Unregister-IAMGroupPolicy` y `Unregister-IAMRolePolicy`. Consulte el ejemplo del cmdlet `Remove-IAMPolicy`.**
```
$pol = Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
Get-IAMPolicyVersions -PolicyArn $pol.Arn | where {-not $_.IsDefaultVersion} | Remove-IAMPolicyVersion -PolicyArn $pol.Arn -force
Remove-IAMPolicy -PolicyArn $pol.Arn -force
```
+ Para obtener más información sobre la API, consulte [DeletePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el rol denominado `MyNewRole` de la cuenta de IAM actual. Antes de poder eliminar el rol, primero debe usar el comando `Unregister-IAMRolePolicy` para separar las políticas administradas. Las políticas integradas se eliminan con el rol.**
```
Remove-IAMRole -RoleName MyNewRole
```
**Ejemplo 2: en este ejemplo se separan las políticas administradas del rol denominado `MyNewRole` y, a continuación, se elimina el rol. La primera línea recupera todas las políticas administradas asociadas al rol como una colección y, a continuación, separa cada política de la colección del rol. La segunda línea elimina el rol en sí. Las políticas integradas se eliminan junto con el rol.**
```
Get-IAMAttachedRolePolicyList -RoleName MyNewRole | Unregister-IAMRolePolicy -RoleName MyNewRole
Remove-IAMRole -RoleName MyNewRole
```
+ Para obtener más información sobre la API, consulte [DeleteRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMRoleFromInstanceProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMRoleFromInstanceProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el rol llamado `MyNewRole` del perfil de instancia de EC2 denominado `MyNewRole`. Un perfil de instancia que se crea en la consola de IAM siempre tiene el mismo nombre que el rol, como en este ejemplo. Si los crea en la API o la CLI, pueden tener nombres diferentes.**
```
Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyNewRole -RoleName MyNewRole -Force
```
+ Para obtener más información sobre la API, consulte [RemoveRoleFromInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMRolePermissionsBoundary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMRolePermissionsBoundary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra cómo eliminar el límite de permisos asociado a un rol de IAM.**
```
Remove-IAMRolePermissionsBoundary -RoleName MyRoleName
```
+ Para obtener más información sobre la API, consulte [DeleteRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la política incrustada `S3AccessPolicy` que está integrada en el rol de IAM `S3BackupRole`.**
```
Remove-IAMRolePolicy -PolicyName S3AccessPolicy -RoleName S3BackupRole
```
+ Para obtener más información sobre la API, consulte [DeleteRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMRoleTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMRoleTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la etiqueta del rol denominado "MyRoleName" con la clave de etiqueta como «abac». Para eliminar varias etiquetas, proporcione una lista de claves de etiquetas separadas por comas.**
```
Remove-IAMRoleTag -RoleName MyRoleName -TagKey "abac","xyzw"
```
+ Para obtener más información sobre la API, consulte [UntagRole Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-IAMSAMLProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMSAMLProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el proveedor SAML 2.0 de IAM cuyo ARN es `arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider`.**
```
Remove-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider
```
+ Para obtener más información sobre la API, consulte [Eliminar SAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMServerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMServerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el certificado de servidor denominado `MyServerCert`.**
```
Remove-IAMServerCertificate -ServerCertificateName MyServerCert
```
+ Para obtener más información sobre la API, consulte [DeleteServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMServiceLinkedRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMServiceLinkedRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se eliminó el rol vinculado al servicio. Tenga en cuenta que si el servicio sigue utilizando este rol, este comando generará un error.**
```
Remove-IAMServiceLinkedRole -RoleName AWSServiceRoleForAutoScaling_RoleNameEndsWithThis
```
+ Para obtener más información sobre la API, consulte [DeleteServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMSigningCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMSigningCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el certificado de firma con el ID `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` del usuario de IAM llamado `Bob`.**
```
Remove-IAMSigningCertificate -UserName Bob -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU
```
+ Para obtener más información sobre la API, consulte [DeleteSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el usuario de IAM denominado `Bob`.**
```
Remove-IAMUser -UserName Bob
```
**Ejemplo 2: en este ejemplo se elimina el usuario de IAM denominado `Theresa` junto con cualquier elemento que deba eliminarse primero.**
```
$name = "Theresa"
# find any groups and remove user from them
$groups = Get-IAMGroupForUser -UserName $name
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName $name -Force }
# find any inline policies and delete them
$inlinepols = Get-IAMUserPolicies -UserName $name
foreach ($pol in $inlinepols) { Remove-IAMUserPolicy -PolicyName $pol -UserName $name -Force}
# find any managed polices and detach them
$managedpols = Get-IAMAttachedUserPolicies -UserName $name
foreach ($pol in $managedpols) { Unregister-IAMUserPolicy -PolicyArn $pol.PolicyArn -UserName $name }
# find any signing certificates and delete them
$certs = Get-IAMSigningCertificate -UserName $name
foreach ($cert in $certs) { Remove-IAMSigningCertificate -CertificateId $cert.CertificateId -UserName $name -Force }
# find any access keys and delete them
$keys = Get-IAMAccessKey -UserName $name
foreach ($key in $keys) { Remove-IAMAccessKey -AccessKeyId $key.AccessKeyId -UserName $name -Force }
# delete the user's login profile, if one exists - note: need to use try/catch to suppress not found error
try { $prof = Get-IAMLoginProfile -UserName $name -ea 0 } catch { out-null }
if ($prof) { Remove-IAMLoginProfile -UserName $name -Force }
# find any MFA device, detach it, and if virtual, delete it.
$mfa = Get-IAMMFADevice -UserName $name
if ($mfa) {
Disable-IAMMFADevice -SerialNumber $mfa.SerialNumber -UserName $name
if ($mfa.SerialNumber -like "arn:*") { Remove-IAMVirtualMFADevice -SerialNumber $mfa.SerialNumber }
}
# finally, remove the user
Remove-IAMUser -UserName $name -Force
```
+ Para obtener más información sobre la API, consulte [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMUserFromGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMUserFromGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el usuario de IAM `Bob` del grupo llamado `Testers`.**
```
Remove-IAMUserFromGroup -GroupName Testers -UserName Bob
```
**Ejemplo 2: en este ejemplo se busca cualquier grupo del cual el usuario de IAM `Theresa` sea miembro y, a continuación, se elimina a `Theresa` de esos grupos.**
```
$groups = Get-IAMGroupForUser -UserName Theresa
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName Theresa -Force }
```
**Ejemplo 3: en este ejemplo se muestra una forma alternativa de eliminar al usuario de IAM `Bob` del grupo `Testers`.**
```
Get-IAMGroupForUser -UserName Bob | Remove-IAMUserFromGroup -UserName Bob -GroupName Testers -Force
```
+ Para obtener más información sobre la API, consulte [RemoveUserFromGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMUserPermissionsBoundary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMUserPermissionsBoundary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra cómo eliminar el límite de permisos asociado a un usuario de IAM.**
```
Remove-IAMUserPermissionsBoundary -UserName joe
```
+ Para obtener más información sobre la API, consulte [DeleteUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMUserPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMUserPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la política incrustada denominada `AccessToEC2Policy` que está integrada en el usuario de IAM llamado `Bob`.**
```
Remove-IAMUserPolicy -PolicyName AccessToEC2Policy -UserName Bob
```
**Ejemplo 2: en este ejemplo se busca todas las políticas incrustadas que están integradas en el usuario de IAM llamado `Theresa` y, a continuación, se eliminan.**
```
$inlinepols = Get-IAMUserPolicies -UserName Theresa
foreach ($pol in $inlinepols) { Remove-IAMUserPolicy -PolicyName $pol -UserName Theresa -Force}
```
+ Para obtener más información sobre la API, consulte [DeleteUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMUserTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMUserTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la etiqueta del usuario llamado “joe” con las claves de etiqueta “abac” y “xyzw”. Para eliminar varias etiquetas, proporcione una lista de claves de etiquetas separadas por comas.**
```
Remove-IAMUserTag -UserName joe -TagKey "abac","xyzw"
```
+ Para obtener más información sobre la API, consulte [UntagUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-IAMVirtualMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-IAMVirtualMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el dispositivo MFA virtual de IAM cuyo ARN es `arn:aws:iam::123456789012:mfa/bob`.**
```
Remove-IAMVirtualMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/bob
```
**Ejemplo 2: en este ejemplo se comprueba si el usuario de IAM Theresa tiene asignado un dispositivo MFA. Si se encuentra uno, el dispositivo está deshabilitado para el usuario de IAM. Si el dispositivo es virtual, también se elimina.**
```
$mfa = Get-IAMMFADevice -UserName Theresa
if ($mfa) {
Disable-IAMMFADevice -SerialNumber $mfa.SerialNumber -UserName $name
if ($mfa.SerialNumber -like "arn:*") { Remove-IAMVirtualMFADevice -SerialNumber $mfa.SerialNumber }
}
```
+ Para obtener más información sobre la API, consulte [DeleteVirtualMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Request-IAMCredentialReport`
En el siguiente ejemplo de código, se muestra cómo utilizar `Request-IAMCredentialReport`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se solicita la generación de un nuevo informe, lo que se puede hacer cada cuatro horas. Si el último informe aún es reciente, el campo Estado indica `COMPLETE`. Uso de `Get-IAMCredentialReport` para ver el informe completo.**
```
Request-IAMCredentialReport
```
**Salida:**
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
+ Para obtener más información sobre la API, consulte [GenerateCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Request-IAMServiceLastAccessedDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Request-IAMServiceLastAccessedDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo es un cmdlet equivalente a la API. GenerateServiceLastAccessedDetails Esto proporciona un identificador de trabajo que se puede usar en Get-IAMServiceLastAccessedDetail y Get- IAMService LastAccessedDetailWithEntity**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
+ Para obtener más información sobre la API, consulte [GenerateServiceLastAccessedDetails Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Set-IAMDefaultPolicyVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-IAMDefaultPolicyVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se establece la versión `v2` de la política cuyo ARN es `arn:aws:iam::123456789012:policy/MyPolicy` como la versión activa predeterminada.**
```
Set-IAMDefaultPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -VersionId v2
```
+ Para obtener más información sobre la API, consulte [SetDefaultPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-IAMRolePermissionsBoundary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-IAMRolePermissionsBoundary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra cómo establecer el límite de permisos para un rol de IAM. Puede establecer políticas AWS administradas o políticas personalizadas como límite de permisos.**
```
Set-IAMRolePermissionsBoundary -RoleName MyRoleName -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ Para obtener más información sobre la API, consulte [PutRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (V5)*.
### `Set-IAMUserPermissionsBoundary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-IAMUserPermissionsBoundary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra cómo establecer el límite de permisos para el usuario. Puede establecer políticas AWS administradas o políticas personalizadas como límite de permisos.**
```
Set-IAMUserPermissionsBoundary -UserName joe -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ Para obtener más información sobre la API, consulte [PutUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (V5)*.
### `Sync-IAMMFADevice`
En el siguiente ejemplo de código, se muestra cómo utilizar `Sync-IAMMFADevice`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo sincroniza el dispositivo MFA que está asociado al usuario de IAM `Bob` y cuyo ARN es `arn:aws:iam::123456789012:mfa/bob` con un programa autenticador que proporcionó los dos códigos de autenticación.**
```
Sync-IAMMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/theresa -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Bob
```
**Ejemplo 2: este ejemplo sincroniza el dispositivo MFA de IAM que está asociado al usuario de IAM `Theresa` con un dispositivo físico que tiene el número de serie `ABCD12345678` y que proporciona los dos códigos de autenticación.**
```
Sync-IAMMFADevice -SerialNumber ABCD12345678 -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Theresa
```
+ Para obtener más información sobre la API, consulte [ResyncMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-IAMGroupPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-IAMGroupPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se desvincula la política administrada del grupo cuyo ARN es `arn:aws:iam::123456789012:policy/TesterAccessPolicy` del grupo denominado `Testers`.**
```
Unregister-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterAccessPolicy
```
**Ejemplo 2: en este ejemplo se busca todas las políticas administradas que están asociadas al grupo denominado `Testers` y se las desvincula del grupo.**
```
Get-IAMAttachedGroupPolicies -GroupName Testers | Unregister-IAMGroupPolicy -Groupname Testers
```
+ Para obtener más información sobre la API, consulte [DetachGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-IAMRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-IAMRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se desvincula la política administrada del grupo cuyo ARN es `arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy` del rol denominado `FedTesterRole`.**
```
Unregister-IAMRolePolicy -RoleName FedTesterRole -PolicyArn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy
```
**Ejemplo 2: en este ejemplo se busca todas las políticas administradas que están asociadas al rol denominado `FedTesterRole` y se desvinculan del rol.**
```
Get-IAMAttachedRolePolicyList -RoleName FedTesterRole | Unregister-IAMRolePolicy -Rolename FedTesterRole
```
+ Para obtener más información sobre la API, consulte [DetachRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-IAMUserPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-IAMUserPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se desvincula la política administrada cuyo ARN es `arn:aws:iam::123456789012:policy/TesterPolicy` del usuario de IAM denominado `Bob`.**
```
Unregister-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**Ejemplo 2: en este ejemplo se busca todas las políticas administradas que están asociadas al usuario de IAM denominado `Theresa` y se las desvincula del usuario.**
```
Get-IAMAttachedUserPolicyList -UserName Theresa | Unregister-IAMUserPolicy -Username Theresa
```
+ Para obtener más información sobre la API, consulte [DetachUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMAccessKey`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMAccessKey`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se cambia el estado de la clave de acceso `AKIAIOSFODNN7EXAMPLE` para el usuario de IAM denominado `Bob` a `Inactive`.**
```
Update-IAMAccessKey -UserName Bob -AccessKeyId AKIAIOSFODNN7EXAMPLE -Status Inactive
```
+ Para obtener más información sobre la API, consulte [UpdateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMAccountPasswordPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMAccountPasswordPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza la política de contraseñas de la cuenta con la configuración especificada. Tenga en cuenta que los parámetros que no estén incluidos en el comando no se dejan sin modificar. En su lugar, se restablecen a los valores predeterminados.**
```
Update-IAMAccountPasswordPolicy -AllowUsersToChangePasswords $true -HardExpiry $false -MaxPasswordAge 90 -MinimumPasswordLength 8 -PasswordReusePrevention 20 -RequireLowercaseCharacters $true -RequireNumbers $true -RequireSymbols $true -RequireUppercaseCharacters $true
```
+ Para obtener más información sobre la API, consulte [UpdateAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMAssumeRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMAssumeRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el rol de IAM denominado `ClientRole` con una nueva política de confianza, cuyo contenido proviene del archivo `ClientRolePolicy.json`. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el contenido del archivo JSON.**
```
Update-IAMAssumeRolePolicy -RoleName ClientRole -PolicyDocument (Get-Content -raw ClientRolePolicy.json)
```
+ Para obtener más información sobre la API, consulte [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se cambia el nombre del grupo de IAM de `Testers` a `AppTesters`.**
```
Update-IAMGroup -GroupName Testers -NewGroupName AppTesters
```
**Ejemplo 2: en este ejemplo se cambia la ruta del grupo de IAM de `AppTesters` a `/Org1/Org2/`. Esto cambia el ARN del grupo a `arn:aws:iam::123456789012:group/Org1/Org2/AppTesters`.**
```
Update-IAMGroup -GroupName AppTesters -NewPath /Org1/Org2/
```
+ Para obtener más información sobre la API, consulte [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMLoginProfile`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMLoginProfile`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se establece una nueva contraseña temporal para el usuario de IAM `Bob` y se exige que el usuario cambie la contraseña la próxima vez que inicie sesión.**
```
Update-IAMLoginProfile -UserName Bob -Password "P@ssw0rd1234" -PasswordResetRequired $true
```
+ Para obtener más información sobre la API, consulte [UpdateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMOpenIDConnectProviderThumbprint`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMOpenIDConnectProviderThumbprint`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza la lista de huellas digitales de certificados del proveedor de OIDC cuyo ARN es `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com` para utilizar una nueva huella digital. El proveedor del OIDC comparte el nuevo valor cuando cambia el certificado asociado al proveedor.**
```
Update-IAMOpenIDConnectProviderThumbprint -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com -ThumbprintList 7359755EXAMPLEabc3060bce3EXAMPLEec4542a3
```
+ Para obtener más información sobre la API, consulte [UpdateOpenIdConnectProviderThumbprint](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza la descripción del rol y el valor de duración máxima de la sesión (en segundos) para el que se puede solicitar la sesión de un rol.**
```
Update-IAMRole -RoleName MyRoleName -Description "My testing role" -MaxSessionDuration 43200
```
+ Para obtener más información sobre la API, consulte [UpdateRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMRoleDescription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMRoleDescription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza la descripción de un rol de IAM en su cuenta.**
```
Update-IAMRoleDescription -RoleName MyRoleName -Description "My testing role"
```
+ Para obtener más información sobre la API, consulte [UpdateRoleDescription](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMSAMLProvider`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMSAMLProvider`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el proveedor SAML en IAM cuyo ARN es `arn:aws:iam::123456789012:saml-provider/SAMLADFS` con un nuevo documento de metadatos SAML del archivo `SAMLMetaData.xml`. Tenga en cuenta que debe usar el parámetro de conmutación `-Raw` para procesar correctamente el contenido del archivo JSON.**
```
Update-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
+ Para obtener más información sobre la API, consulte [UpdateSamlProvider](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMServerCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMServerCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se cambia el nombre del certificado denominado `MyServerCertificate` a `MyRenamedServerCertificate`.**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewServerCertificateName MyRenamedServerCertificate
```
**Ejemplo 2: en este ejemplo se mueve el certificado denominado `MyServerCertificate` a la ruta /Org1/Org2/. Esto cambia el ARN del recurso a `arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate`.**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewPath /Org1/Org2/
```
+ Para obtener más información sobre la API, consulte [UpdateServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMSigningCertificate`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMSigningCertificate`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el certificado asociado al usuario de IAM llamado `Bob` y cuyo ID de certificado es `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` para marcarlo como inactivo.**
```
Update-IAMSigningCertificate -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU -UserName Bob -Status Inactive
```
+ Para obtener más información sobre la API, consulte [UpdateSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-IAMUser`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-IAMUser`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se cambia el nombre del usuario de IAM de `Bob` a `Robert`.**
```
Update-IAMUser -UserName Bob -NewUserName Robert
```
**Ejemplo 2: en este ejemplo se cambia la ruta del usuario de IAM de `Bob` a `/Org1/Org2/`, lo que de hecho cambia el ARN del usuario a `arn:aws:iam::123456789012:user/Org1/Org2/bob`.**
```
Update-IAMUser -UserName Bob -NewPath /Org1/Org2/
```
+ Para obtener más información sobre la API, consulte [UpdateUser](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-IAMGroupPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-IAMGroupPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se crea una política incrustada llamada `AppTesterPolicy` y se incrusta en el grupo de IAM `AppTesters`. Si ya existe una política incrustada con el mismo nombre, se sobrescribirá. El contenido de la política JSON viene del archivo `apptesterpolicy.json`. Tenga en cuenta que debe usar el parámetro `-Raw` para procesar correctamente el contenido del archivo JSON.**
```
Write-IAMGroupPolicy -GroupName AppTesters -PolicyName AppTesterPolicy -PolicyDocument (Get-Content -Raw apptesterpolicy.json)
```
+ Para obtener más información sobre la API, consulte [PutGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-IAMRolePolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-IAMRolePolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se crea una política incrustada llamada `FedTesterRolePolicy` y se incrusta en el rol de IAM `FedTesterRole`. Si ya existe una política incrustada con el mismo nombre, se sobrescribirá. El contenido de la política JSON viene del archivo `FedTesterPolicy.json`. Tenga en cuenta que debe usar el parámetro `-Raw` para procesar correctamente el contenido del archivo JSON.**
```
Write-IAMRolePolicy -RoleName FedTesterRole -PolicyName FedTesterRolePolicy -PolicyDocument (Get-Content -Raw FedTesterPolicy.json)
```
+ Para obtener más información sobre la API, consulte [PutRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-IAMUserPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-IAMUserPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se crea una política incrustada llamada `EC2AccessPolicy` y se incrusta en el usuario de IAM `Bob`. Si ya existe una política incrustada con el mismo nombre, se sobrescribirá. El contenido de la política JSON viene del archivo `EC2AccessPolicy.json`. Tenga en cuenta que debe usar el parámetro `-Raw` para procesar correctamente el contenido del archivo JSON.**
```
Write-IAMUserPolicy -UserName Bob -PolicyName EC2AccessPolicy -PolicyDocument (Get-Content -Raw EC2AccessPolicy.json)
```
+ Para obtener más información sobre la API, consulte [PutUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Kinesis con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Kinesis.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-KINRecord`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-KINRecord`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra cómo devolver y extraer datos de una serie de un registro o más. El iterador suministrado para ello Get-KINRecord determina la posición inicial de los registros que se van a devolver, que en este ejemplo se capturan en una variable, \$1records. Luego, se puede acceder a cada registro individual indexando la colección \$1records. Suponiendo que los datos del registro son texto codificado en UTF-8, el comando final muestra cómo se pueden extraer los datos del objeto y devolverlos como texto a la consola. MemoryStream **
```
$records
$records = Get-KINRecord -ShardIterator "AAAAAAAAAAGIc....9VnbiRNaP"
```
**Salida:**
```
MillisBehindLatest NextShardIterator Records
------------------ ----------------- -------
0 AAAAAAAAAAERNIq...uDn11HuUs {Key1, Key2}
```
```
$records.Records[0]
```
**Salida:**
```
ApproximateArrivalTimestamp Data PartitionKey SequenceNumber
--------------------------- ---- ------------ --------------
3/7/2016 5:14:33 PM System.IO.MemoryStream Key1 4955986459776...931586
```
```
[Text.Encoding]::UTF8.GetString($records.Records[0].Data.ToArray())
```
**Salida:**
```
test data from string
```
+ Para obtener más información sobre la API, consulte [GetRecords Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-KINShardIterator`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-KINShardIterator`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve un iterador de particiones para la partición especificada y su posición inicial. Los detalles de los identificadores de los fragmentos y los números de secuencia se pueden obtener en el resultado del Get-KINStream cmdlet, haciendo referencia a la colección Shards del objeto de flujo devuelto. El iterador devuelto se puede usar con el Get-KINRecord cmdlet para extraer los registros de datos del fragmento.**
```
Get-KINShardIterator -StreamName "mystream" -ShardId "shardId-000000000000" -ShardIteratorType AT_SEQUENCE_NUMBER -StartingSequenceNumber "495598645..."
```
**Salida:**
```
AAAAAAAAAAGIc....9VnbiRNaP
```
+ Para obtener información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [GetShardIterator](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-KINStream`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-KINStream`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve información detallada del flujo especificada.**
```
Get-KINStream -StreamName "mystream"
```
**Salida:**
```
HasMoreShards : False
RetentionPeriodHours : 24
Shards : {}
StreamARN : arn:aws:kinesis:us-west-2:123456789012:stream/mystream
StreamName : mystream
StreamStatus : ACTIVE
```
+ Para obtener más información sobre la API, consulte [DescribeStream](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-KINStream`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-KINStream`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: cree una nueva transmisión.**
```
New-KINStream -StreamName "mystream" -ShardCount 1
```
+ Para obtener más información sobre la API, consulte [CreateStream](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-KINStream`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-KINStream`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina el flujo especificado. Se le solicitará una confirmación antes de que se ejecute el comando. Para suprimir la confirmación utilice el conmutador -Force**.
```
Remove-KINStream -StreamName "mystream"
```
+ Para obtener más información sobre la API, consulte [DeleteStream](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-KINRecord`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-KINRecord`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: escribe un registro que contiene la cadena proporcionada al parámetro -Text.**
```
Write-KINRecord -Text "test data from string" -StreamName "mystream" -PartitionKey "Key1"
```
**Ejemplo 2: escribe un registro que contiene los datos contenidos en el archivo especificado. El archivo se trata como una secuencia de bytes, por lo que si contiene texto, debe escribirse con la codificación necesaria antes de usarlo con este cmdlet.**
```
Write-KINRecord -FilePath "C:\TestData.txt" -StreamName "mystream" -PartitionKey "Key2"
```
+ Para obtener más información sobre la API, consulte [PutRecord](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Lambda con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Lambda.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-LMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-LMResourceTag`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: agrega las tres etiquetas (Washington, Oregon y California) y sus valores asociados a la función especificada identificada por su ARN.**
```
Add-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -Tag @{ "Washington" = "Olympia"; "Oregon" = "Salem"; "California" = "Sacramento" }
```
+ Para obtener más información sobre la API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMAccountSetting`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMAccountSetting`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se muestra para comparar el límite de la cuenta y el uso de la cuenta**
```
Get-LMAccountSetting | Select-Object @{Name="TotalCodeSizeLimit";Expression={$_.AccountLimit.TotalCodeSize}}, @{Name="TotalCodeSizeUsed";Expression={$_.AccountUsage.TotalCodeSize}}
```
**Salida:**
```
TotalCodeSizeLimit TotalCodeSizeUsed
------------------ -----------------
80530636800 15078795
```
+ Para obtener más información sobre la API, consulte [GetAccountSettings](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se recuperan las ponderaciones de Routing Config para un alias de función de Lambda específico.**
```
Get-LMAlias -FunctionName "MylambdaFunction123" -Name "newlabel1" -Select RoutingConfig
```
**Salida:**
```
AdditionalVersionWeights
------------------------
{[1, 0.6]}
```
+ Para obtener más información sobre la API, consulte [GetAlias](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMFunctionConcurrency`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMFunctionConcurrency`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo obtiene la simultaneidad reservada para la función de Lambda**
```
Get-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -Select *
```
**Salida:**
```
ReservedConcurrentExecutions
----------------------------
100
```
+ Para obtener más información sobre la API, consulte [GetFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMFunctionConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMFunctionConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo devuelve la configuración específica de la versión de una función de Lambda.**
```
Get-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Qualifier "PowershellAlias"
```
**Salida:**
```
CodeSha256 : uWOW0R7z+f0VyLuUg7+/D08hkMFsq0SF4seuyUZJ/R8=
CodeSize : 1426
DeadLetterConfig : Amazon.Lambda.Model.DeadLetterConfig
Description : Verson 3 to test Aliases
Environment : Amazon.Lambda.Model.EnvironmentResponse
FunctionArn : arn:aws:lambda:us-east-1:123456789012:function:MylambdaFunction123
:PowershellAlias
FunctionName : MylambdaFunction123
Handler : lambda_function.launch_instance
KMSKeyArn :
LastModified : 2019-12-25T09:52:59.872+0000
LastUpdateStatus : Successful
LastUpdateStatusReason :
LastUpdateStatusReasonCode :
Layers : {}
MasterArn :
MemorySize : 128
RevisionId : 5d7de38b-87f2-4260-8f8a-e87280e10c33
Role : arn:aws:iam::123456789012:role/service-role/lambda
Runtime : python3.8
State : Active
StateReason :
StateReasonCode :
Timeout : 600
TracingConfig : Amazon.Lambda.Model.TracingConfigResponse
Version : 4
VpcConfig : Amazon.Lambda.Model.VpcConfigDetail
```
+ Para obtener más información sobre la API, consulte [GetFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMFunctionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMFunctionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran todas las funciones de Lambda con un tamaño de código ordenado**
```
Get-LMFunctionList | Sort-Object -Property CodeSize | Select-Object FunctionName, RunTime, Timeout, CodeSize
```
**Salida:**
```
FunctionName Runtime Timeout CodeSize
------------ ------- ------- --------
test python2.7 3 243
MylambdaFunction123 python3.8 600 659
myfuncpython1 python3.8 303 675
```
+ Para obtener más información sobre la API, consulte [ListFunctions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra la política de funciones de la función de Lambda**
```
Get-LMPolicy -FunctionName test -Select Policy
```
**Salida:**
```
{"Version":"2012-10-17", "Id":"default","Statement":[{"Sid":"xxxx","Effect":"Allow","Principal":{"Service":"sns.amazonaws.com"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-1:123456789102:function:test"}]}
```
+ Para obtener más información sobre la API, consulte [GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMProvisionedConcurrencyConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMProvisionedConcurrencyConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo obtiene la configuración de simultaneidad aprovisionada para el alias especificado de la función de Lambda.**
```
C:\>Get-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
**Salida:**
```
AllocatedProvisionedConcurrentExecutions : 0
AvailableProvisionedConcurrentExecutions : 0
LastModified : 2020-01-15T03:21:26+0000
RequestedProvisionedConcurrentExecutions : 70
Status : IN_PROGRESS
StatusReason :
```
+ Para obtener más información sobre la API, consulte [GetProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMProvisionedConcurrencyConfigList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMProvisionedConcurrencyConfigList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo obtiene la configuración de simultaneidad aprovisionada para una función de Lambda.**
```
Get-LMProvisionedConcurrencyConfigList -FunctionName "MylambdaFunction123"
```
+ Para obtener más información sobre la API, consulte [ListProvisionedConcurrencyConfigs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: recupera las etiquetas y sus valores actualmente configurados en la función especificada.**
```
Get-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
**Salida:**
```
Key Value
--- -----
California Sacramento
Oregon Salem
Washington Olympia
```
+ Para obtener más información sobre la API, consulte [ListTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-LMVersionsByFunction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-LMVersionsByFunction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo devuelve la lista de configuraciones específicas de la versión para cada versión de la función de Lambda.**
```
Get-LMVersionsByFunction -FunctionName "MylambdaFunction123"
```
**Salida:**
```
FunctionName Runtime MemorySize Timeout CodeSize LastModified RoleName
------------ ------- ---------- ------- -------- ------------ --------
MylambdaFunction123 python3.8 128 600 659 2020-01-10T03:20:56.390+0000 lambda
MylambdaFunction123 python3.8 128 5 1426 2019-12-25T09:19:02.238+0000 lambda
MylambdaFunction123 python3.8 128 5 1426 2019-12-25T09:39:36.779+0000 lambda
MylambdaFunction123 python3.8 128 600 1426 2019-12-25T09:52:59.872+0000 lambda
```
+ Para obtener más información sobre la API, consulte [ListVersionsByFunction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-LMAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-LMAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo crea un nuevo alias de Lambda para una versión y configuración de enrutamiento específicas a fin de especificar el porcentaje de solicitudes de invocación que recibe.**
```
New-LMAlias -FunctionName "MylambdaFunction123" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6} -Description "Alias for version 4" -FunctionVersion 4 -Name "PowershellAlias"
```
+ Para obtener más información sobre la API, consulte [CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Publish-LMFunction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Publish-LMFunction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una nueva función de C\$1 (tiempo de ejecución de dotnetcore1.0) denominada MyFunction AWS Lambda, que proporciona los binarios compilados para la función desde un archivo zip del sistema de archivos local (se pueden utilizar rutas relativas o absolutas). Las funciones Lambda de C\$1 especifican el controlador de la función mediante la designación: :Namespace. AssemblyName ClassName::. MethodName Debe reemplazar adecuadamente las partes del nombre del ensamblado (sin el sufijo .dll), el espacio de nombres, el nombre de la clase y el nombre del método de la especificación del controlador. La nueva función tendrá las variables de entorno 'envvar1' y 'envvar2' configuradas a partir de los valores proporcionados.**
```
Publish-LMFunction -Description "My C# Lambda Function" `
-FunctionName MyFunction `
-ZipFilename .\MyFunctionBinaries.zip `
-Handler "AssemblyName::Namespace.ClassName::MethodName" `
-Role "arn:aws:iam::123456789012:role/LambdaFullExecRole" `
-Runtime dotnetcore1.0 `
-Environment_Variable @{ "envvar1"="value";"envvar2"="value" }
```
**Salida:**
```
CodeSha256 : /NgBMd...gq71I=
CodeSize : 214784
DeadLetterConfig :
Description : My C# Lambda Function
Environment : Amazon.Lambda.Model.EnvironmentResponse
FunctionArn : arn:aws:lambda:us-west-2:123456789012:function:ToUpper
FunctionName : MyFunction
Handler : AssemblyName::Namespace.ClassName::MethodName
KMSKeyArn :
LastModified : 2016-12-29T23:50:14.207+0000
MemorySize : 128
Role : arn:aws:iam::123456789012:role/LambdaFullExecRole
Runtime : dotnetcore1.0
Timeout : 3
Version : $LATEST
VpcConfig :
```
**Ejemplo 2: este ejemplo es similar al anterior, excepto que los binarios de la función se cargan primero en un bucket de Amazon S3 (que debe estar en la misma región que la función de Lambda prevista) y, a continuación, se hace referencia al objeto de S3 resultante al crear la función.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key MyFunctionBinaries.zip -File .\MyFunctionBinaries.zip
Publish-LMFunction -Description "My C# Lambda Function" `
-FunctionName MyFunction `
-BucketName amzn-s3-demo-bucket `
-Key MyFunctionBinaries.zip `
-Handler "AssemblyName::Namespace.ClassName::MethodName" `
-Role "arn:aws:iam::123456789012:role/LambdaFullExecRole" `
-Runtime dotnetcore1.0 `
-Environment_Variable @{ "envvar1"="value";"envvar2"="value" }
```
+ Para obtener más información sobre la API, consulte [CreateFunction Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Publish-LMVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Publish-LMVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo crea una versión para la instantánea existente del código de función de Lambda**
```
Publish-LMVersion -FunctionName "MylambdaFunction123" -Description "Publishing Existing Snapshot of function code as a new version through Powershell"
```
+ Para obtener más información sobre la API, consulte [PublishVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-LMAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina el alias de la función de Lambda mencionado en el comando.**
```
Remove-LMAlias -FunctionName "MylambdaFunction123" -Name "NewAlias"
```
+ Para obtener más información sobre la API, consulte [DeleteAlias](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-LMFunction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMFunction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo elimina una versión específica de una función de Lambda**
```
Remove-LMFunction -FunctionName "MylambdaFunction123" -Qualifier '3'
```
+ Para obtener más información sobre la API, consulte [DeleteFunction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-LMFunctionConcurrency`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMFunctionConcurrency`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo elimina la simultaneidad de funciones de la función de Lambda.**
```
Remove-LMFunctionConcurrency -FunctionName "MylambdaFunction123"
```
+ Para obtener más información sobre la API, consulte [DeleteFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-LMPermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMPermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo elimina la política de función para la función Lambda especificada StatementId .**
```
$policy = Get-LMPolicy -FunctionName "MylambdaFunction123" -Select Policy | ConvertFrom-Json| Select-Object -ExpandProperty Statement
Remove-LMPermission -FunctionName "MylambdaFunction123" -StatementId $policy[0].Sid
```
+ Para obtener más información sobre la API, consulte [RemovePermission Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-LMProvisionedConcurrencyConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMProvisionedConcurrencyConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la configuración de simultaneidad aprovisionada para un alias específico.**
```
Remove-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
+ Para obtener más información sobre la API, consulte [DeleteProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-LMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-LMResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: elimina las etiquetas suministradas de una función. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force. Se realiza una sola llamada al servicio para eliminar las etiquetas.**
```
Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -TagKey "Washington","Oregon","California"
```
**Ejemplo 2: elimina las etiquetas suministradas de una función. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force. Una vez realizada la llamada al servicio por etiqueta suministrada.**
```
"Washington","Oregon","California" | Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
+ Para obtener más información sobre la API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-LMAlias`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-LMAlias`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo actualiza la configuración de un alias de función de Lambda existente. Actualiza el RoutingConfiguration valor para transferir el 60% (0.6) del tráfico a la versión 1**
```
Update-LMAlias -FunctionName "MylambdaFunction123" -Description " Alias for version 2" -FunctionVersion 2 -Name "newlabel1" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6}
```
+ Para obtener más información sobre la API, consulte [UpdateAlias Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Update-LMFunctionCode`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-LMFunctionCode`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: actualiza la función denominada 'MyFunction' con el nuevo contenido contenido en el archivo zip especificado. Para una función de Lambda C\$1 .NET Core, el archivo zip debe contener el ensamblaje compilado.**
```
Update-LMFunctionCode -FunctionName MyFunction -ZipFilename .\UpdatedCode.zip
```
**Ejemplo 2: este ejemplo es similar al anterior, pero utiliza un objeto de Amazon S3 que contiene el código actualizado para actualizar la función.**
```
Update-LMFunctionCode -FunctionName MyFunction -BucketName amzn-s3-demo-bucket -Key UpdatedCode.zip
```
+ Para obtener más información sobre la API, consulte [UpdateFunctionCode Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Update-LMFunctionConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-LMFunctionConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo actualiza la configuración de la función de Lambda existente**
```
Update-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Handler "lambda_function.launch_instance" -Timeout 600 -Environment_Variable @{ "envvar1"="value";"envvar2"="value" } -Role arn:aws:iam::123456789101:role/service-role/lambda -DeadLetterConfig_TargetArn arn:aws:sns:us-east-1: 123456789101:MyfirstTopic
```
+ Para obtener más información sobre la API, consulte [UpdateFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-LMFunctionConcurrency`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-LMFunctionConcurrency`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se aplica la configuración de simultaneidad de la función en su conjunto.**
```
Write-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -ReservedConcurrentExecution 100
```
+ Para obtener más información sobre la API, consulte [PutFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-LMProvisionedConcurrencyConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-LMProvisionedConcurrencyConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se agrega una configuración de simultaneidad aprovisionada al alias de una función**
```
Write-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -ProvisionedConcurrentExecution 20 -Qualifier "NewAlias1"
```
+ Para obtener más información sobre la API, consulte [PutProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon ML con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon ML.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-MLBatchPrediction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLBatchPrediction`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: Devuelve los metadatos detallados de una predicción de lote con el identificador ID.**
```
Get-MLBatchPrediction -BatchPredictionId ID
```
+ Para obtener más información sobre la API, consulte [GetBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-MLBatchPredictionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLBatchPredictionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve una lista de todos los registros de datos BatchPredictions y sus registros de datos asociados que coinciden con el criterio de búsqueda indicado en la solicitud.**
```
Get-MLBatchPredictionList
```
**Ejemplo 2: devuelve una lista de todos BatchPredictions con el estado COMPLETADO.**
```
Get-MLBatchPredictionList -FilterVariable Status -EQ COMPLETED
```
+ Para obtener más información sobre la API, consulte [DescribeBatchPredictions Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-MLDataSource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLDataSource`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los metadatos, el estado y la información del archivo de datos de un DataSource con el identificador ID**
```
Get-MLDataSource -DataSourceId ID
```
+ Para obtener más información sobre la API, consulte [GetDataSource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-MLDataSourceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLDataSourceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve una lista de todos los registros de datos DataSources y sus registros de datos asociados.**
```
Get-MLDataSourceList
```
**Ejemplo 2: Devuelve una lista de todos DataSources con el estado COMPLETADO.**
```
Get-MLDataDourceList -FilterVariable Status -EQ COMPLETED
```
+ Para obtener más información sobre la API, consulte [DescribeDataSources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-MLEvaluation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLEvaluation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los metadatos y el estado de una evaluación con el identificador ID.**
```
Get-MLEvaluation -EvaluationId ID
```
+ Para obtener más información sobre la API, consulte [GetEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-MLEvaluationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLEvaluationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve una lista de todos los recursos de evaluación.**
```
Get-MLEvaluationList
```
**Ejemplo 2: Devuelve una lista de todas las evaluaciones con el estado COMPLETED.**
```
Get-MLEvaluationList -FilterVariable Status -EQ COMPLETED
```
+ Para obtener más información sobre la API, consulte [DescribeEvaluations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-MLModel`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLModel`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve los metadatos detallados, el estado, el esquema y la información del archivo de datos de un MLModel usuario con ID.**
```
Get-MLModel -ModelId ID
```
+ Para obtener información sobre la API, consulte [Get MLModel](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (V5)*.
### `Get-MLModelList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLModelList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve una lista de todos los modelos y sus registros de datos asociados.**
```
Get-MLModelList
```
**Ejemplo 2: Devuelve una lista de todos los modelos con el estado COMPLETED.**
```
Get-MLModelList -FilterVariable Status -EQ COMPLETED
```
+ Para obtener información detallada sobre la API, consulte la sección [Describe MLModels](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Get-MLPrediction`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MLPrediction`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Envía un registro a la URL del punto de conexión de predicción en tiempo real del modelo con el identificador ID.**
```
Get-MLPrediction -ModelId ID -PredictEndpoint URL -Record @{"A" = "B"; "C" = "D";}
```
+ Para obtener información sobre la API, consulte [Predict](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `New-MLBatchPrediction`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-MLBatchPrediction`.
**Herramientas para V5 PowerShell **
**Ejemplo 1: Crea una nueva solicitud de predicción por lotes para el modelo con un identificador ID y coloca la salida en la ubicación de S3 especificada.**
```
New-MLBatchPrediction -ModelId ID -Name NAME -OutputURI s3://...
```
+ Para obtener más información sobre la API, consulte [CreateBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-MLDataSourceFromS3`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-MLDataSourceFromS3`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Cree un origen de datos con datos de una ubicación de S3, con el nombre NAME y el esquema SCHEMA.**
```
New-MLDataSourceFromS3 -Name NAME -ComputeStatistics $true -DataSpec_DataLocationS3 "s3://BUCKET/KEY" -DataSchema SCHEMA
```
+ Para obtener más información sobre la API, consulte [CreateDataSourceFromS3](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-MLEvaluation`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-MLEvaluation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea una evaluación para un identificador de origen de datos y un identificador de modelo determinados.**
```
New-MLEvaluation -Name NAME -DataSourceId DSID -ModelId MID
```
+ Para obtener más información sobre la API, consulte [CreateEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-MLModel`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-MLModel`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un modelo nuevo con datos de entrenamiento.**
```
New-MLModel -Name NAME -ModelType BINARY -Parameter @{...} -TrainingDataSourceId ID
```
+ Para obtener más información sobre la API, consulte [Create MLModel](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `New-MLRealtimeEndpoint`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-MLRealtimeEndpoint`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un nuevo punto de conexión de predicción en tiempo real para el identificador del modelo especificado.**
```
New-MLRealtimeEndpoint -ModelId ID
```
+ Para obtener más información sobre la API, consulte [CreateRealtimeEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Macie con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Macie.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-MAC2FindingList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-MAC2FindingList`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: devuelve una lista de hallazgos que contienen una detección de FindingIds datos confidenciales del tipo «CREDIT\$1CARD\$1NUMBER» o «US\$1SOCIAL\$1SECURITY\$1NUMBER»**
```
$criterionAddProperties = New-Object Amazon.Macie2.Model.CriterionAdditionalProperties
$criterionAddProperties.Eq = @(
"CREDIT_CARD_NUMBER"
"US_SOCIAL_SECURITY_NUMBER"
)
$FindingCriterion = @{
'classificationDetails.result.sensitiveData.detections.type' = [Amazon.Macie2.Model.CriterionAdditionalProperties]$criterionAddProperties
}
Get-MAC2FindingList -FindingCriteria_Criterion $FindingCriterion -MaxResult 5
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5). [ListFindings](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
# Lista de precios de AWS ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. Lista de precios de AWS
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-PLSAttributeValue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-PLSAttributeValue`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Devuelve los valores del atributo “volumeType” de Amazon EC2 en la región us-east-1.**
```
Get-PLSAttributeValue -ServiceCode AmazonEC2 -AttributeName "volumeType" -region us-east-1
```
**Salida:**
```
Value
-----
Cold HDD
General Purpose
Magnetic
Provisioned IOPS
Throughput Optimized HDD
```
+ Para obtener más información sobre la API, consulte [GetAttributeValues](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-PLSProduct`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-PLSProduct`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los detalles de todos los productos de Amazon EC2.**
```
Get-PLSProduct -ServiceCode AmazonEC2 -Region us-east-1
```
**Salida:**
```
{"product":{"productFamily":"Compute Instance","attributes":{"enhancedNetworkingSupported":"Yes","memory":"30.5 GiB","dedicatedEbsThroughput":"800 Mbps","vcpu":"4","locationType":"AWS Region","storage":"EBS only","instanceFamily":"Memory optimized","operatingSystem":"SUSE","physicalProcessor":"Intel Xeon E5-2686 v4 (Broadwell)","clockSpeed":"2.3 GHz","ecu":"Variable","networkPerformance":"Up to 10 Gigabit","servicename":"Amazon Elastic Compute Cloud","instanceType":"r4.xlarge","tenancy":"Shared","usagetype":"USW2-BoxUsage:r4.xlarge","normalizationSizeFactor":"8","processorFeatures":"Intel AVX, Intel AVX2, Intel Turbo","servicecode":"AmazonEC2","licenseModel":"No License required","currentGeneration":"Yes","preInstalledSw":"NA","location":"US West (Oregon)","processorArchitecture":"64-bit","operation":"RunInstances:000g"},...
```
**Ejemplo 2: Devuelve datos de Amazon EC2 de la región us-east-1 filtrados por tipos de volumen de “uso general” que están respaldados por SSD.**
```
Get-PLSProduct -ServiceCode AmazonEC2 -Filter @{Type="TERM_MATCH";Field="volumeType";Value="General Purpose"},@{Type="TERM_MATCH";Field="storageMedia";Value="SSD-backed"} -Region us-east-1
```
**Salida:**
```
{"product":{"productFamily":"Storage","attributes":{"storageMedia":"SSD-backed","maxThroughputvolume":"160 MB/sec","volumeType":"General Purpose","maxIopsvolume":"10000",...
```
+ Para obtener más información sobre la API, consulte [GetProducts](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-PLSService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-PLSService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los metadatos de todos los códigos de servicio disponibles en la región us-east-1.**
```
Get-PLSService -Region us-east-1
```
**Salida:**
```
AttributeNames ServiceCode
-------------- -----------
{productFamily, servicecode, groupDescription, termType...} AWSBudgets
{productFamily, servicecode, termType, usagetype...} AWSCloudTrail
{productFamily, servicecode, termType, usagetype...} AWSCodeCommit
{productFamily, servicecode, termType, usagetype...} AWSCodeDeploy
{productFamily, servicecode, termType, usagetype...} AWSCodePipeline
{productFamily, servicecode, termType, usagetype...} AWSConfig
...
```
**Ejemplo 2: Devuelve los metadatos del servicio Amazon EC2 en la región us-east-1.**
```
Get-PLSService -ServiceCode AmazonEC2 -Region us-east-1
```
**Salida:**
```
AttributeNames ServiceCode
-------------- -----------
{volumeType, maxIopsvolume, instanceCapacity10xlarge, locationType...} AmazonEC2
```
+ Para obtener más información sobre la API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Resource Groups con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante la Herramientas de AWS para PowerShell V5 with Resource Groups.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-RGResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-RGResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se añade la clave de etiqueta “Instances” con el valor “workboxes” al ARN del grupo de recursos especificado.**
```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Salida:**
```
Arn Tags
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+ Para obtener información sobre la API, consulte [Tag](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Find-RGResource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Find-RGResource`.
**Herramientas para V5 PowerShell **
**Ejemplo 1: Este ejemplo crea un tipo de recurso de ResourceQuery for Instance con filtros de etiquetas y busca recursos.**
```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = ConvertTo-Json -Compress -Depth 4 -InputObject @{
ResourceTypeFilters = @('AWS::EC2::Instance')
TagFilters = @(@{
Key = 'auto'
Values = @('no')
})
}
Find-RGResource -ResourceQuery $query | Select-Object -ExpandProperty ResourceIdentifiers
```
**Salida:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+ Para obtener más información sobre la API, consulte [SearchResources Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-RGGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recupera el grupo de recursos por el nombre del grupo.**
```
Get-RGGroup -GroupName auto-no
```
**Salida:**
```
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+ Para obtener más información sobre la API, consulte [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGGroupList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGGroupList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los grupos de recursos ya creados.**
```
Get-RGGroupList
```
**Salida:**
```
GroupArn GroupName
-------- ---------
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
arn:aws:resource-groups:eu-west-1:123456789012:group/build600 build600
```
+ Para obtener más información sobre la API, consulte [ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGGroupQuery`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGGroupQuery`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recupera la consulta de recursos del grupo de recursos especificado.**
```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**Salida:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+ Para obtener más información sobre la API, consulte [GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGGroupResourceList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGGroupResourceList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los recursos del grupo en función de los filtrados por tipo de recurso.**
```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**Salida:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123bc45b567890e1 AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0a1caf2345f67d8dc AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0fd12dd3456789012 AWS::EC2::Instance
```
+ Para obtener más información sobre la API, consulte [ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran las etiquetas del ARN de grupo de recursos especificado.**
```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Salida:**
```
Key Value
--- -----
Instances workboxes
```
+ Para obtener más información sobre la API, consulte [GetTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-RGGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-RGGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un nuevo grupo de AWS recursos Resource Groups basado en etiquetas denominado TestPowerShellGroup. El grupo incluye instancias de Amazon EC2 de la región actual etiquetadas con la clave de etiqueta “Name” y el valor de etiqueta “test2”. El comando devuelve la consulta y el tipo de grupo, así como los resultados de la operación.**
```
$ResourceQuery = New-Object -TypeName Amazon.ResourceGroups.Model.ResourceQuery
$ResourceQuery.Type = "TAG_FILTERS_1_0"
$ResourceQuery.Query = '{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]}'
$ResourceQuery
New-RGGroup -Name TestPowerShellGroup -ResourceQuery $ResourceQuery -Description "Test resource group."
```
**Salida:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]} TAG_FILTERS_1_0
LoggedAt : 11/20/2018 2:40:59 PM
Group : Amazon.ResourceGroups.Model.Group
ResourceQuery : Amazon.ResourceGroups.Model.ResourceQuery
Tags : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 338
HttpStatusCode : OK
```
+ Para obtener más información sobre la API, consulte [CreateGroup Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Remove-RGGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-RGGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de recursos designado.**
```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGGroup (DeleteGroup)" on target "non-tag-cfn-elbv2".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/non-tag-cfn-elbv2 non-tag-cfn-elbv2
```
+ Para obtener más información sobre la API, consulte [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-RGResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-RGResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta mencionada del grupo de recursos.**
```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGResourceTag (Untag)" on target "arn:aws:resource-groups:eu-west-1:933303704102:group/workboxes".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn Keys
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {Instances}
```
+ Para obtener información sobre la API, consulte [Untag](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
### `Update-RGGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-RGGroup`.
**Herramientas para V5 PowerShell **
**Ejemplo 1: En este ejemplo se actualiza la descripción del grupo.**
```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**Salida:**
```
Description GroupArn Name
----------- -------- ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+ Para obtener más información sobre la API, consulte [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-RGGroupQuery`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-RGGroupQuery`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un objeto de consulta y se actualiza la consulta del grupo.**
```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = @{
ResourceTypeFilters = @('AWS::EC2::Instance')
TagFilters = @(@{
Key='Environment'
Values='Build600.11'
})
} | ConvertTo-Json -Compress -Depth 4
Update-RGGroupQuery -GroupName build600 -ResourceQuery $query
```
**Salida:**
```
GroupName ResourceQuery
--------- -------------
build600 Amazon.ResourceGroups.Model.ResourceQuery
```
+ Para obtener más información sobre la API, consulte [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de la API de etiquetado de Resource Groups con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante la API de etiquetado Herramientas de AWS para PowerShell V5 with Resource Groups.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-RGTResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-RGTResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añaden las claves de etiqueta “stage” y “version” con los valores “beta” y “preprod\$1test” a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para aplicar las etiquetas.**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
**Ejemplo 2: En este ejemplo se añaden las etiquetas y los valores especificados a un bucket de Amazon S3 y a una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al cmdlet.**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
+ Para obtener más información sobre la API, consulte [TagResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGTResource`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGTResource`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve todos los recursos etiquetados de una región y las claves de etiqueta asociadas al recurso. Si no se proporciona ningún parámetro -Region al cmdlet, se intentará deducir la región del intérprete de comandos de los metadatos de la instancia de EC2.**
```
Get-RGTResource
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Ejemplo 2: Devuelve todos los recursos etiquetados del tipo especificado en una región. La cadena de cada nombre de servicio y tipo de recurso es la misma que la incluida en el Nombre de recurso de Amazon (ARN) de un recurso.**
```
Get-RGTResource -ResourceType "s3"
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Ejemplo 3: Devuelve todos los recursos etiquetados del tipo especificado en una región. Tenga en cuenta que cuando los tipos de recursos se envían al cmdlet, se realiza una llamada al servicio por cada tipo de recurso especificado.**
```
"dynamodb","s3" | Get-RGTResource
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Ejemplo 4: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.**
```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Ejemplo 5: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.**
```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
**Ejemplo 6: Devuelve todos los recursos etiquetados que coinciden con el filtro especificado.**
```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**Salida:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
+ Para obtener más información sobre la API, consulte [GetResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGTTagKey`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGTTagKey`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve todas las claves de etiqueta de la región especificada. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2. Tenga en cuenta que las claves de las etiquetas no se devuelven en ningún orden específico.**
```
Get-RGTTagKey -region us-west-2
```
**Salida:**
```
version
stage
```
+ Para obtener más información sobre la API, consulte [GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-RGTTagValue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-RGTTagValue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve el valor de la etiqueta especificada en la región. Si no se especifica el parámetro -Region, el cmdlet intentará deducir la región del intérprete de comandos predeterminado o los metadatos de la instancia de EC2.**
```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**Salida:**
```
beta
```
+ Para obtener más información sobre la API, consulte [GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-RGTResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-RGTResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realiza una sola llamada al servicio para eliminar las etiquetas. Antes de eliminar las etiquetas, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el parámetro -Force.**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version"
```
**Ejemplo 2: Elimina las claves de etiqueta “stage” y ”version”, así como los valores asociados, de un bucket de Amazon S3 y una tabla de Amazon DynamoDB. Se realizan dos llamadas al servicio, una para cada ARN de recurso enviado al cmdlet. Antes de cada llamada, el cmdlet solicitará confirmación. Para omitir la confirmación, añada el parámetro -Force.**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version"
```
+ Para obtener más información sobre la API, consulte [UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Route 53 con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Route 53.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Edit-R53ResourceRecordSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-R53ResourceRecordSet`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: en este ejemplo, se crea un registro A para www.example.com y se cambia el registro A de test.example.com de 192.0.2.3 a 192.0.2.1. Tenga en cuenta que los valores de los registros de tipo TXT modificados deben estar entre comillas dobles. Consulte la documentación de Amazon Route 53 para obtener más información. Puede usar el Get-R53Change cmdlet para sondear y determinar cuándo se han completado los cambios.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "TXT"
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="item 1 item 2 item 3"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "DELETE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "test.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.3"})
$change3 = New-Object Amazon.Route53.Model.Change
$change3.Action = "CREATE"
$change3.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change3.ResourceRecordSet.Name = "test.example.com"
$change3.ResourceRecordSet.Type = "A"
$change3.ResourceRecordSet.TTL = 600
$change3.ResourceRecordSet.ResourceRecords = @()
$change3.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.1"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change batch creates a TXT record for www.example.com. and changes the A record for test.example.com. from 192.0.2.3 to 192.0.2.1."
ChangeBatch_Change=$change1,$change2,$change3
}
Edit-R53ResourceRecordSet @params
```
**Ejemplo 2: en este ejemplo, se muestra cómo crear conjuntos de registros de recursos de alias. “Z222222222” es el ID de la zona alojada de Amazon Route 53 en la que crea el conjunto de registros de recursos de alias. “example.com” es el vértice de zona para el que desea crear un alias y “www.example.com” es un subdominio para el que también debe crear un alias. «Z11111» es un ejemplo de un ID de zona alojada para el balanceador de cargas y «example-load-balancer-11.us-east-1.elb.amazonaws.com» es un ejemplo de un nombre de dominio de balanceador de carga con el que Amazon Route 53 responde a las consultas de example.com y www.example.com. Consulte la documentación de Amazon Route 53 para obtener más información. Puede usar el cmdlet para sondear y determinar cuándo se han completado los cambios. Get-R53Change**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z222222222"
ChangeBatch_Comment="This change batch creates two alias resource record sets, one for the zone apex, example.com, and one for www.example.com, that both point to example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Ejemplo 3: en este ejemplo, se crean dos registros A para www.example.com. Una cuarta parte de las veces (1/(1\$13)), Amazon Route 53 responde a las consultas de www.example.com con los dos valores del primer conjunto de registros de recursos (192.0.2.9 y 192.0.2.10). Tres cuartas partes de las veces (3/(1\$13)), Amazon Route 53 responde a las consultas de www.example.com con los dos valores del segundo conjunto de registros de recursos (192.0.2.11 y 192.0.2.12). Consulte la documentación de Amazon Route 53 para obtener más información. Puede usar el Get-R53Change cmdlet para sondear y determinar cuándo se han completado los cambios.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Rack 2, Positions 4 and 5"
$change1.ResourceRecordSet.Weight = 1
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.9"})
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.10"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "www.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Rack 5, Positions 1 and 2"
$change2.ResourceRecordSet.Weight = 3
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.11"})
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.12"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change creates two weighted resource record sets, each of which has two values."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Ejemplo 4: en este ejemplo se muestra cómo crear conjuntos de registros de recursos de alias ponderados suponiendo que example.com es el dominio para el que desea crear conjuntos de registros de recursos de alias ponderados. SetIdentifier diferencia los dos conjuntos de registros de recursos de alias ponderados entre sí. Este elemento es obligatorio porque los elementos Nombre y Tipo tienen los mismos valores para ambos conjuntos de registros de recursos. Los valores Z333311111 y Z3333333333333 son ejemplos de zonas alojadas para el balanceador de cargas ELB especificadas IDs por el valor de. DNSName example-load-balancer-2222222222.us-east-1.elb.amazonaws.com y -4444444444.us-east-1.elb.amazonaws.com example-load-balancer son ejemplos de dominios de Elastic Load Balancing desde los que Amazon Route 53 responde a las consultas de example.com. Consulte la documentación de Amazon Route 53 para obtener más información. Puede usar el cmdlet para sondear y determinar cuándo Get-R53Change se han completado los cambios.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "1"
$change1.ResourceRecordSet.Weight = 3
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "2"
$change2.ResourceRecordSet.Weight = 1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z3333333333333"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-4444444444.us-east-1.elb.amazonaws.com."
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two weighted alias resource record sets. Amazon Route 53 responds to queries for example.com with the first ELB domain 3/4ths of the times and the second one 1/4th of the time."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**Ejemplo 5: en este ejemplo, se crean dos conjuntos de registros de recursos de alias de latencia: uno para un equilibrador de carga ELB en la región Oeste de EE. UU. (Oregón) (us-west-2) y otro para un equilibrador de carga en la región Asia Pacífico (Singapur) (ap-southeast-1). Consulte la documentación de Amazon Route 53 para obtener más información. Puede usar el Get-R53Change cmdlet para sondear y determinar cuándo se han completado los cambios.**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Oregon load balancer 1"
$change1.ResourceRecordSet.Region = us-west-2
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-west-2.elb.amazonaws.com"
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Singapore load balancer 1"
$change2.ResourceRecordSet.Region = ap-southeast-1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z2222222222222"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.ap-southeast-1.elb.amazonaws.com"
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two latency resource record sets, one for the US West (Oregon) region and one for the Asia Pacific (Singapore) region."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
+ Para obtener más información sobre la API, consulte la *referencia [ChangeResourceRecordSets](https://docs.aws.amazon.com/powershell/v5/reference)de Herramientas de AWS para PowerShell cmdlets (V5*).
### `Get-R53AccountLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53AccountLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve el número máximo de zonas alojadas que se pueden crear con la cuenta actual.**
```
Get-R53AccountLimit -Type MAX_HOSTED_ZONES_BY_OWNER
```
**Salida:**
```
15
```
+ Para obtener más información sobre la API, consulte [GetAccountLimit](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-R53CheckerIpRanges`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53CheckerIpRanges`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo devuelve el valor de los comprobadores CIDRs de estado de Route53**
```
Get-R53CheckerIpRanges
```
**Salida:**
```
15.177.2.0/23
15.177.6.0/23
15.177.10.0/23
15.177.14.0/23
15.177.18.0/23
15.177.22.0/23
15.177.26.0/23
15.177.30.0/23
15.177.34.0/23
15.177.38.0/23
15.177.42.0/23
15.177.46.0/23
15.177.50.0/23
15.177.54.0/23
15.177.58.0/23
15.177.62.0/23
54.183.255.128/26
54.228.16.0/26
54.232.40.64/26
54.241.32.64/26
54.243.31.192/26
54.244.52.192/26
54.245.168.0/26
54.248.220.0/26
54.250.253.192/26
54.251.31.128/26
54.252.79.128/26
54.252.254.192/26
54.255.254.192/26
107.23.255.0/26
176.34.159.192/26
177.71.207.128/26
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [GetCheckerIpRanges](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-R53HostedZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53HostedZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los detalles de la zona alojada con el ID PJN98 FT9 Z1D633.**
```
Get-R53HostedZone -Id Z1D633PJN98FT9
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [GetHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-R53HostedZoneCount`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53HostedZoneCount`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve el número total de zonas alojadas públicas y privadas de la actual Cuenta de AWS.**
```
Get-R53HostedZoneCount
```
+ Para obtener más información sobre la API, consulte [GetHostedZoneCount Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-R53HostedZoneLimit`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53HostedZoneLimit`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se devuelve el límite del número máximo de registros que se pueden crear en la zona alojada especificada.**
```
Get-R53HostedZoneLimit -HostedZoneId Z3MEQ8T7HAAAAF -Type MAX_RRSETS_BY_ZONE
```
**Salida:**
```
5
```
+ Para obtener más información sobre la API, consulte [GetHostedZoneLimit](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-R53HostedZoneList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53HostedZoneList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: se muestra todas las zonas alojadas públicas y privadas.**
```
Get-R53HostedZoneList
```
**Ejemplo 2: Muestra todas las zonas alojadas asociadas al conjunto de delegación reutilizable que tiene el ID NZ8 X2CISAMPLE**
```
Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ListHostedZones](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-R53HostedZonesByName`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53HostedZonesByName`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: se devuelve todas las zonas alojadas públicas y privadas según el orden de la secuencia clasificación ASCII por nombre de dominio.**
```
Get-R53HostedZonesByName
```
**Ejemplo 2: se devuelve las zonas alojadas públicas y privadas, según el orden de la secuencia clasificación ASCII por nombre de dominio, empezando por el nombre de DNS especificado.**
```
Get-R53HostedZonesByName -DnsName example2.com
```
+ Para obtener más información sobre la API, consulte [ListHostedZonesByName](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-R53QueryLoggingConfigList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53QueryLoggingConfigList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo devuelve todas las configuraciones para el registro de consultas de DNS asociadas a la Cuenta de AWS actual.**
```
Get-R53QueryLoggingConfigList
```
**Salida:**
```
Id HostedZoneId CloudWatchLogsLogGroupArn
-- ------------ -------------------------
59b0fa33-4fea-4471-a88c-926476aaa40d Z385PDS6EAAAZR arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example1.com:*
ee528e95-4e03-4fdc-9d28-9e24ddaaa063 Z94SJHBV1AAAAZ arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example2.com:*
e38dddda-ceb6-45c1-8cb7-f0ae56aaaa2b Z3MEQ8T7AAA1BF arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example3.com:*
```
+ Para obtener más información sobre la API, consulte [ListQueryLoggingConfigs](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-R53ReusableDelegationSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-R53ReusableDelegationSet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recupera información acerca del conjunto de delegación especificado, incluidos los cuatro servidores de nombres que están asignados al conjunto de delegación.**
```
Get-R53ReusableDelegationSet -Id N23DS9X4AYEAAA
```
**Salida:**
```
Id CallerReference NameServers
-- --------------- -----------
/delegationset/N23DS9X4AYEAAA testcaller {ns-545.awsdns-04.net, ns-1264.awsdns-30.org, ns-2004.awsdns-58.co.uk, ns-240.awsdns-30.com}
```
+ Para obtener más información sobre la API, consulte [GetReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-R53HostedZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-R53HostedZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: crea una nueva zona alojada llamada “example.com”, asociada a un conjunto de delegación reutilizable. Tenga en cuenta que debe proporcionar un valor para el CallerReference parámetro de modo que las solicitudes se tengan que volver a intentar si es necesario sin correr el riesgo de ejecutar la operación dos veces. Como la zona alojada se crea en una VPC, es privada automáticamente y no se debe establecer el parámetro - HostedZoneConfig \$1PrivateZone .**
```
$params = @{
Name="example.com"
CallerReference="myUniqueIdentifier"
HostedZoneConfig_Comment="This is my first hosted zone"
DelegationSetId="NZ8X2CISAMPLE"
VPC_VPCId="vpc-1a2b3c4d"
VPC_VPCRegion="us-east-1"
}
New-R53HostedZone @params
```
+ Para obtener más información sobre la API, consulte [CreateHostedZone Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `New-R53QueryLoggingConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-R53QueryLoggingConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea una nueva configuración de registro de consultas de DNS de Route53 para la zona alojada especificada. Amazon Route53 publicará los registros de consultas de DNS en el grupo de registros de Cloudwatch especificado.**
```
New-R53QueryLoggingConfig -HostedZoneId Z3MEQ8T7HAAAAF -CloudWatchLogsLogGroupArn arn:aws:logs:us-east-1:111111111111:log-group:/aws/route53/example.com:*
```
**Salida:**
```
QueryLoggingConfig Location
------------------ --------
Amazon.Route53.Model.QueryLoggingConfig https://route53.amazonaws.com/2013-04-01/queryloggingconfig/ee5aaa95-4e03-4fdc-9d28-9e24ddaaaaa3
```
+ Para obtener más información sobre la API, consulte [CreateQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-R53ReusableDelegationSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-R53ReusableDelegationSet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo crea un conjunto de delegación reutilizable de cuatro servidores de nombres que pueden reutilizarse en varias zonas alojadas.**
```
New-R53ReusableDelegationSet -CallerReference testcallerreference
```
**Salida:**
```
DelegationSet Location
------------- --------
Amazon.Route53.Model.DelegationSet https://route53.amazonaws.com/2013-04-01/delegationset/N23DS9XAAAAAXM
```
+ Para obtener más información sobre la API, consulte [CreateReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-R53VPCWithHostedZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-R53VPCWithHostedZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia la VPC especificada a la zona alojada privada.**
```
Register-R53VPCWithHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**Salida:**
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C3SCAAA633Z6DX PENDING 01/28/2020 19:32:02
```
+ Para obtener más información sobre la API, consulte [Associate VPCWith HostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Remove-R53HostedZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-R53HostedZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: se elimina la zona alojada con el ID especificado. Antes de continuar con el comando, se le solicitará que lo confirme, a menos que añada el parámetro -Force switch.**
```
Remove-R53HostedZone -Id Z1PA6795UKMFR9
```
+ Para obtener más información sobre la API, consulte [DeleteHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-R53QueryLoggingConfig`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-R53QueryLoggingConfig`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la configuración especificado para el registro de consultas de DNS.**
```
Remove-R53QueryLoggingConfig -Id ee528e95-4e03-4fdc-9d28-9e24daaa20063
```
+ Para obtener más información sobre la API, consulte [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-R53ReusableDelegationSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-R53ReusableDelegationSet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el conjunto de delegación reutilizable especificado.**
```
Remove-R53ReusableDelegationSet -Id N23DS9X4AYAAAM
```
+ Para obtener más información sobre la API, consulte [DeleteReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-R53VPCFromHostedZone`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-R53VPCFromHostedZone`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se desvincula la VPC especificada de la zona alojada privada.**
```
Unregister-R53VPCFromHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**Salida:**
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C2XFCAAAA9HKZG PENDING 01/28/2020 10:35:55
```
+ Para obtener más información sobre la API, consulte [Disassociate VPCFrom HostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference* (V5).
### `Update-R53HostedZoneComment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-R53HostedZoneComment`.
** PowerShell Herramientas para la versión 5**
**Ejemplo 1: Este comando actualiza el comentario de la zona alojada especificada.**
```
Update-R53HostedZoneComment -Id Z385PDS6AAAAAR -Comment "This is my first hosted zone"
```
**Salida:**
```
Id : /hostedzone/Z385PDS6AAAAAR
Name : example.com.
CallerReference : C5B55555-7147-EF04-8341-69131E805C89
Config : Amazon.Route53.Model.HostedZoneConfig
ResourceRecordSetCount : 9
LinkedService :
```
+ Para obtener más información sobre la API, consulte [UpdateHostedZoneComment](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon S3 con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon S3.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Copy-S3Object`
En el siguiente ejemplo de código, se muestra cómo utilizar `Copy-S3Object`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: este comando copia el objeto “sample.txt” del bucket “test-files” al mismo bucket, pero con la nueva clave de “sample-copy.txt”.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -DestinationKey sample-copy.txt
```
**Ejemplo 2: este comando copia el objeto “sample.txt” del bucket “test-files” al mismo bucket “backup-files”, pero con la nueva clave de “sample-copy.txt”.**
```
Copy-S3Object -BucketName amzn-s3-demo-source-bucket -Key sample.txt -DestinationKey sample-copy.txt -DestinationBucket amzn-s3-demo-destination-bucket
```
**Ejemplo 3: este comando descarga el objeto “sample.txt” del bucket “test-files” a un archivo local con el nombre “local-sample.txt”.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -LocalFile local-sample.txt
```
**Ejemplo 4: descarga el objeto individual en el archivo especificado. El archivo descargado se encuentra en c:\$1downloads\$1data\$1archive.zip**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key data/archive.zip -LocalFolder c:\downloads
```
**Ejemplo 5: descarga todos los objetos que coinciden con el prefijo de clave especificado en la carpeta local. La jerarquía de claves relativa se conservará como subcarpetas en la ubicación general de descarga.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix data -LocalFolder c:\downloads
```
+ Para obtener más información sobre la API, consulte [CopyObject](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3Bucket`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3Bucket`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve todos los buckets de S3.**
```
Get-S3Bucket
```
**Ejemplo 2: este comando devuelve un bucket denominado “test-files”**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [ListBuckets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketACL`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketACL`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El comando obtiene los detalles del propietario del objeto de S3.**
```
(Get-S3BucketACL -BucketName 'amzn-s3-demo-bucket' -Select *).Owner
```
**Salida:**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ Para obtener más información sobre la API, consulte [GetBucketAcl](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketAccelerateConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketAccelerateConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el valor Enabled si la configuración de aceleración de transferencia está habilitada para el bucket especificado.**
```
Get-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Value
-----
Enabled
```
+ Para obtener más información sobre la API, consulte [GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketAnalyticsConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketAnalyticsConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve los detalles del filtro de análisis con el nombre “testfilter” en el bucket de S3 indicado.**
```
Get-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ Para obtener más información sobre la API, consulte [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketAnalyticsConfigurationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketAnalyticsConfigurationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve las primeras 100 configuraciones de análisis del bucket de S3 indicado.**
```
Get-S3BucketAnalyticsConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketEncryption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketEncryption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve todas las reglas de cifrado del servidor asociadas al bucket determinado.**
```
Get-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketInventoryConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketInventoryConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve los detalles del inventario con el nombre “testinventory” del bucket de S3 indicado.**
```
Get-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testinventory'
```
+ Para obtener más información sobre la API, consulte [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketInventoryConfigurationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketInventoryConfigurationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve las primeras 100 configuraciones de inventario del bucket de S3 indicado.**
```
Get-S3BucketInventoryConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketLocation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketLocation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve la restricción de ubicación del bucket “amzn-s3-demo-bucket”, si existe una restricción.**
```
Get-S3BucketLocation -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Value
-----
ap-south-1
```
+ Para obtener más información sobre la API, consulte [GetBucketLocation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketLogging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketLogging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el estado de registros del bucket especificado.**
```
Get-S3BucketLogging -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
TargetBucketName Grants TargetPrefix
---------------- ------ ------------
testbucket1 {} testprefix
```
+ Para obtener más información sobre la API, consulte [GetBucketLogging](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketMetricsConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketMetricsConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve los detalles del filro de métricas con el nombre “testfilter” del bucket de S3 indicado.**
```
Get-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testfilter'
```
+ Para obtener más información sobre la API, consulte [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketNotification`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketNotification`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera la configuración de notificaciones del bucket en cuestión**
```
Get-S3BucketNotification -BucketName amzn-s3-demo-bucket | select -ExpandProperty TopicConfigurations
```
**Salida:**
```
Id Topic
-- -----
mimo arn:aws:sns:eu-west-1:123456789012:topic-1
```
+ Para obtener más información sobre la API, consulte [GetBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando muestra la política de bucket asociada al bucket de S3 indicado.**
```
Get-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketPolicyStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketPolicyStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el estado de política del bucket específico de S3 e indica si el bucket es público.**
```
Get-S3BucketPolicyStatus -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketPolicyStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketReplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketReplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la información de configuración de replicación establecida en el bucket denominado “amzn-s3-demo-bucket”.**
```
Get-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [GetBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketRequestPayment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketRequestPayment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la configuración de pagos de solicitudes del bucket denominado “amzn-s3-demo-bucket”. De forma predeterminada, el propietario del bucket paga las descargas realizadas desde el bucket.**
```
Get-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [GetBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketTagging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketTagging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve todas las etiquetas asociadas al bucket indicado.**
```
Get-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketVersioning`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketVersioning`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el estado del control de versiones con respecto al bucket indicado.**
```
Get-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3BucketWebsite`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3BucketWebsite`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve los detalles de las configuraciones de sitio web estáticas del bucket de S3 indicado.**
```
Get-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3CORSConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3CORSConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve un objeto que contiene todas las reglas de configuración de CORS correspondientes al bucket de S3 especificado.**
```
Get-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket' -Select Configuration.Rules
```
**Salida:**
```
AllowedMethods : {PUT, POST, DELETE}
AllowedOrigins : {http://www.example1.com}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {*}
AllowedMethods : {PUT, POST, DELETE}
AllowedOrigins : {http://www.example2.com}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {*}
AllowedMethods : {GET}
AllowedOrigins : {*}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {}
```
+ Para obtener información sobre la API, consulte [Get CORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference (*V5).
### `Get-S3HeadBucket`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3HeadBucket`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve el resultado con el código de estado HTTP 200 OK para el bucket existente cuando el usuario tiene permiso para acceder a él. BucketArn El parámetro solo es compatible con los buckets de directorio de S3**.
```
Get-S3HeadBucket -BucketName amzn-s3-demo-bucket
```
**Salida:**
```
AccessPointAlias : False
BucketArn :
BucketLocationName :
BucketLocationType :
BucketRegion : us-east-2
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 0
HttpStatusCode : OK
```
**Ejemplo 2: Este comando arroja un error con el código de estado HTTP NotFound para un bucket inexistente.**
```
Get-S3HeadBucket -BucketName amzn-s3-non-existing-bucket
```
**Salida:**
```
Get-S3HeadBucket: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.
```
**Ejemplo 3: Este comando produce un error con el código de estado HTTP Forbidden para un bucket existente cuando el usuario no tiene permiso para acceder a él.**
```
Get-S3HeadBucket -BucketName amzn-s3-no-access-bucket
```
**Salida:**
```
Get-S3HeadBucket: Error making request with Error Code Forbidden and Http Status Code Forbidden. No further error information was returned by the service.
```
+ Para obtener más información sobre la API, consulte [HeadBucket Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-S3LifecycleConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3LifecycleConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recupera la configuración de ciclo de vida del bucket.**
```
Get-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket
```
**Salida:**
```
Rules
-----
{Remove-in-150-days, Archive-to-Glacier-in-30-days}
```
+ Para obtener más información sobre la API, consulte [GetLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3Object`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3Object`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando recupera la información sobre todos los elementos del bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket
```
**Ejemplo 2: este comando recupera la información sobre el elemento “sample.txt” del bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**Ejemplo 3: este comando recupera la información sobre todos los elementos con el prefijo “sample” del bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample
```
+ Para obtener más información sobre la API, consulte [ListObjects](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3ObjectACL`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3ObjectACL`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El comando obtiene los detalles del propietario del objeto de S3.**
```
(Get-S3ObjectACL -BucketName 'amzn-s3-demo-bucket' -key 'initialize.ps1' -Select *).Owner
```
**Salida:**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ Para obtener más información sobre la API, consulte [GetObjectAcl](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3ObjectLockConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3ObjectLockConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando devuelve el valor “Enabled” si la configuración de bloqueo de objetos está habilitada para el bucket de S3 indicado.**
```
Get-S3ObjectLockConfiguration -BucketName 'amzn-s3-demo-bucket' -Select ObjectLockConfiguration.ObjectLockEnabled
```
**Salida:**
```
Value
-----
Enabled
```
+ Para obtener más información sobre la API, consulte [GetObjectLockConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3ObjectMetadata`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3ObjectMetadata`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los metadatos del objeto con la clave 'ListTrusts.txt' en el bucket de S3 dado.**
```
Get-S3ObjectMetadata -BucketName 'amzn-s3-demo-bucket' -Key 'ListTrusts.txt'
```
**Salida:**
```
Headers : Amazon.S3.Model.HeadersCollection
Metadata : Amazon.S3.Model.MetadataCollection
DeleteMarker :
AcceptRanges : bytes
ContentRange :
Expiration :
RestoreExpiration :
RestoreInProgress : False
LastModified : 01/01/2020 08:02:05
ETag : "d000011112a222e333e3bb4ee5d43d21"
MissingMeta : 0
VersionId : null
Expires : 01/01/0001 00:00:00
WebsiteRedirectLocation :
ServerSideEncryptionMethod : AES256
ServerSideEncryptionCustomerMethod :
ServerSideEncryptionKeyManagementServiceKeyId :
ReplicationStatus :
PartsCount :
ObjectLockLegalHoldStatus :
ObjectLockMode :
ObjectLockRetainUntilDate : 01/01/0001 00:00:00
StorageClass :
RequestCharged :
```
+ Para obtener más información sobre la API, consulte [GetObjectMetadata Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-S3ObjectRetention`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3ObjectRetention`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando devuelve el modo y la fecha hasta que se retenga el objeto.**
```
Get-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt'
```
+ Para obtener más información sobre la API, consulte [GetObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3ObjectTagSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3ObjectTagSet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el ejemplo devuelve las etiquetas asociadas al objeto presentes en el bucket de S3 indicado.**
```
Get-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Key Value
--- -----
test value
```
+ Para obtener más información sobre la API, consulte [GetObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3PreSignedURL`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3PreSignedURL`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El comando devuelve la URL previamente firmada de una clave y una fecha de caducidad especificadas.**
```
Get-S3PreSignedURL -BucketName 'amzn-s3-demo-bucket' -Key 'testkey' -Expires '2023-11-16'
```
**Ejemplo 2: El comando devuelve la URL previamente firmada de un bucket de directorio con la clave y la fecha de caducidad especificadas.**
```
[Amazon.AWSConfigsS3]::UseSignatureVersion4 = $true
Get-S3PreSignedURL -BucketName amzn-s3-demo-bucket--usw2-az1--x-s3 -Key 'testkey' -Expire '2023-11-17'
```
+ Para obtener información sobre la API, consulte [GetPreSignedla URL en la](https://docs.aws.amazon.com/powershell/v5/reference) *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3PublicAccessBlock`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3PublicAccessBlock`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando devuelve la configuración de bloqueo de acceso público del bucket de S3 indicado.**
```
Get-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [GetPublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-S3Version`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-S3Version`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los metadatos sobre todas las versiones de los objetos en el bucket de S3 especificado.**
```
Get-S3Version -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
IsTruncated : False
KeyMarker :
VersionIdMarker :
NextKeyMarker :
NextVersionIdMarker :
Versions : {EC2.txt, EC2MicrosoftWindowsGuide.txt, ListDirectories.json, ListTrusts.json}
Name : amzn-s3-demo-bucket
Prefix :
MaxKeys : 1000
CommonPrefixes : {}
Delimiter :
```
+ Para obtener más información sobre la API, consulte [ListVersions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-S3Bucket`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-S3Bucket`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando crea un nuevo bucket privado denominado “sample-bucket”.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket
```
**Ejemplo 2: Este comando crea un nuevo bucket denominado “sample-bucket” con permisos de lectura y escritura.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadWrite
```
**Ejemplo 3: Este comando crea un nuevo bucket denominado “sample-bucket” con permisos de lectura y escritura.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadOnly
```
**Ejemplo 4: Este comando crea un nuevo bucket de directorio denominado «amzn-s3-demo-bucket--use1-az5--x-s3" con. PutBucketConfiguration**
```
$bucketConfiguration = @{
BucketInfo = @{
DataRedundancy = 'SingleAvailabilityZone'
Type = 'Directory'
}
Location = @{
Name = 'usw2-az1'
Type = 'AvailabilityZone'
}
}
New-S3Bucket -BucketName amzn-s3-demo-bucket--usw2-az1--x-s3 -BucketConfiguration $bucketConfiguration -Region us-west-2
```
+ Para obtener información [PutBucket](https://docs.aws.amazon.com/powershell/v5/reference)sobre *Herramientas de AWS para PowerShell la API,* consulte Cmdlet Reference (V5).
### `Read-S3Object`
En el siguiente ejemplo de código, se muestra cómo utilizar `Read-S3Object`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando recupera el elemento "sample.txt" del depósito «amzn-s3-demo-bucket» y lo guarda en un archivo denominado "local-sample.txt" en la ubicación actual. No es necesario que el archivo “local-sample.txt” exista para poder llamar a este comando.**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -File local-sample.txt
```
**Ejemplo 2: Este comando recupera el directorio virtual «DIR» del depósito «amzn-s3-demo-bucket» y lo guarda en una carpeta denominada «Local-dir» en la ubicación actual. No es necesario que la carpeta “Local-DIR” exista para poder llamar a este comando.**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix DIR -Folder Local-DIR
```
**Ejemplo 3: descarga todos los objetos cuyas claves terminan en “.json” de los buckets con “config” en el nombre del bucket a los archivos de la carpeta especificada. Las claves de objeto se utilizan para establecer los nombres de los archivos.**
```
Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
```
+ *Para obtener información sobre la API, consulte Cmdlet Reference (V5). [GetObject](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Remove-S3Bucket`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3Bucket`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando elimina todos los objetos y las versiones de los objetos del bucket “test-files” y, a continuación, elimina el bucket. El comando solicitará una confirmación antes de continuar. Añada el conmutador -Force para suprimir la confirmación. Tenga en cuenta que los buckets que no estén vacíos no se pueden eliminar.**
```
Remove-S3Bucket -BucketName amzn-s3-demo-bucket -DeleteBucketContent
```
+ Para obtener más información sobre la API, consulte [DeleteBucket](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketAnalyticsConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketAnalyticsConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando elimina el filtro de análisis con el nombre “testfilter” en el bucket de S3 indicado.**
```
Remove-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ Para obtener más información sobre la API, consulte [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketEncryption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketEncryption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: esto deshabilita el cifrado habilitado para el bucket de S3 proporcionado.**
```
Remove-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketEncryption (DeleteBucketEncryption)" on target "s3casetestbucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketInventoryConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketInventoryConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando elimina el inventario denominado 'testInventoryName' correspondiente al depósito S3 dado.**
```
Remove-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testInventoryName'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketInventoryConfiguration (DeleteBucketInventoryConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener información sobre la API, consulte [DeleteBucketInventoryConfiguration Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Remove-S3BucketMetricsConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketMetricsConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando elimina el filtro de métricas con el nombre “testmetrics” en el bucket de S3 indicado.**
```
Remove-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testmetrics'
```
+ Para obtener más información sobre la API, consulte [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketPolicy`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketPolicy`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando elimina la política de bucket asociada al bucket de S3 indicado.**
```
Remove-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [DeleteBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketReplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketReplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Elimina la configuración de replicación asociada al bucket denominado “amzn-s3-demo-bucket”. Tenga en cuenta que esta operación requiere permiso para la DeleteReplicationConfiguration acción s3:. Se le solicitará la confirmación antes de continuar con la operación; para suprimir la confirmación, utilice el conmutador -Force.**
```
Remove-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [DeleteBucketReplication Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-S3BucketTagging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketTagging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando elimina todas las etiquetas asociadas al bucket de S3 indicado.**
```
Remove-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketTagging (DeleteBucketTagging)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3BucketWebsite`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3BucketWebsite`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando deshabilita la propiedad de alojamiento de sitios web estáticos del bucket de S3 indicado.**
```
Remove-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketWebsite (DeleteBucketWebsite)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3CORSConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3CORSConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando elimina la configuración de CORS para el bucket de S3 especificado.**
```
Remove-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3CORSConfiguration (DeleteCORSConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [Eliminar CORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) en la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3LifecycleConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3LifecycleConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: El comando elimina todas las reglas de ciclo de vida del bucket de S3 especificado.**
```
Remove-S3LifecycleConfiguration -BucketName 'amzn-s3-demo-bucket'
```
+ Para obtener más información sobre la API, consulte [DeleteLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3MultipartUpload`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3MultipartUpload`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando anula las cargas multiparte creadas hace menos de 5 días.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -DaysBefore 5
```
**Ejemplo 2: este comando anula las cargas multiparte creadas antes del 2 de enero de 2014.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "Thursday, January 02, 2014"
```
**Ejemplo 3: este comando anula las cargas multiparte creadas antes del 2 de enero de 2014 a las 10:45:37.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "2014/01/02 10:45:37"
```
+ Para obtener más información sobre la API, consulte [AbortMultipartUpload](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3Object`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3Object`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando elimina el objeto “sample.txt” del bucket “test-files”. Antes de ejecutar el comando, se le solicitará que lo confirme; para suprimir el mensaje, utilice el conmutador -Force.**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**Ejemplo 2: este comando elimina la versión especificada del objeto “sample.txt” del bucket “test-files”, suponiendo que el bucket se haya configurado para habilitar las versiones de los objetos.**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt
```
**Ejemplo 3: este comando elimina los objetos “sample1.txt”, “sample2.txt” y “sample3.txt” del bucket “test-files” como una sola operación por lotes. La respuesta del servicio mostrará una lista de todas las claves procesadas, independientemente del estado de éxito o error de la eliminación. Para obtener únicamente los errores de las claves que el servicio no pudo procesar, añada el ReportErrorsOnly parámetro - (este parámetro también se puede especificar con el alias -Quiet).**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )
```
**Ejemplo 4: En este ejemplo se utiliza una expresión en línea con el KeyCollection parámetro - para obtener las claves de los objetos que se van a eliminar. Get-S3Objectdevuelve una colección de instancias de Amazon.S3.Model.S3Object, cada una de las cuales tiene un elemento clave del tipo string que identifica** el objeto.
```
Remove-S3Object -bucketname "amzn-s3-demo-bucket" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)
```
**Ejemplo 5: este ejemplo obtiene todos los objetos que tienen un prefijo de clave “prefijo/subprefijo” en el bucket y los elimina. Tenga en cuenta que los objetos entrantes se procesan de uno en uno. En el caso de colecciones grandes, considere la posibilidad de pasar la colección al parámetro - InputObject (alias -S3ObjectCollection) del cmdlet para permitir que la eliminación se realice por lotes con una sola llamada al servicio.**
```
Get-S3Object -BucketName "amzn-s3-demo-bucket" -KeyPrefix "prefix/subprefix" | Remove-S3Object -Force
```
**Ejemplo 6: en este ejemplo, se canaliza al cmdlet una colección de ObjectVersion instancias de Amazon.S3.Model.S3 que representan marcadores de eliminación para su eliminación. Tenga en cuenta que los objetos entrantes se procesan de uno en uno. En el caso de colecciones grandes, considere la posibilidad de pasarla al parámetro - InputObject (alias -S3ObjectCollection) del cmdlet para permitir que la eliminación se realice por lotes con una sola llamada al servicio.**
```
(Get-S3Version -BucketName "amzn-s3-demo-bucket").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-S3Object -Force
```
**Ejemplo 7: Este script muestra cómo realizar una eliminación por lotes de un conjunto de objetos (en este caso, eliminar marcadores) mediante la construcción de una matriz de objetos para utilizarlos con el parámetro -. KeyAndVersionCollection **
```
$keyVersions = @()
$markers = (Get-S3Version -BucketName $BucketName).Versions | Where {$_.IsDeleteMarker -eq "True"}
foreach ($marker in $markers) { $keyVersions += @{ Key = $marker.Key; VersionId = $marker.VersionId } }
Remove-S3Object -BucketName $BucketName -KeyAndVersionCollection $keyVersions -Force
```
+ Para obtener más información sobre la API, consulte [DeleteObjects Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-S3ObjectTagSet`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3ObjectTagSet`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando elimina todas las etiquetas asociadas con el objeto con la clave “testfile.txt” en el bucket de S3 indicado.**
```
Remove-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket' -Select '^Key'
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3ObjectTagSet (DeleteObjectTagging)" on target "testfile.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
testfile.txt
```
+ Para obtener más información sobre la API, consulte [DeleteObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-S3PublicAccessBlock`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-S3PublicAccessBlock`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando desactiva la configuración de bloqueo de acceso público para el bucket en cuestión.**
```
Remove-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket' -Force -Select '^BucketName'
```
**Salida:**
```
amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [DeletePublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-S3BucketEncryption`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-S3BucketEncryption`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando habilita el cifrado predeterminado AES256 del lado del servidor con claves administradas de Amazon S3 (SSE-S3) en el bucket determinado.**
```
$Encryptionconfig = @{ServerSideEncryptionByDefault = @{ServerSideEncryptionAlgorithm = "AES256"}}
Set-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket' -ServerSideEncryptionConfiguration_ServerSideEncryptionRule $Encryptionconfig
```
+ Para obtener más información sobre la API, consulte [PutBucketEncryption Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Test-S3Bucket`
En el siguiente ejemplo de código, se muestra cómo utilizar `Test-S3Bucket`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve True si el bucket existe y False en caso contrario. El comando devuelve True aunque el bucket no pertenezca al usuario.**
```
Test-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ Para obtener más información sobre la API, consulte [Test-S3Bucket](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-S3BucketAccelerateConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketAccelerateConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando habilita la aceleración de transferencia para el bucket de S3 indicado.**
```
$statusVal = New-Object Amazon.S3.BucketAccelerateStatus('Enabled')
Write-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket' -AccelerateConfiguration_Status $statusVal
```
+ Para obtener más información sobre la API, consulte [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-S3BucketNotification`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketNotification`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se configura la configuración del tema de SNS para el evento de S3 ObjectRemovedDelete y se habilita la notificación para el bucket de S3 en cuestión**
```
$topic = [Amazon.S3.Model.TopicConfiguration] @{
Id = "delete-event"
Topic = "arn:aws:sns:eu-west-1:123456789012:topic-1"
Event = [Amazon.S3.EventType]::ObjectRemovedDelete
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -TopicConfiguration $topic
```
**Ejemplo 2: En este ejemplo, se habilitan las notificaciones del ObjectCreatedAll bucket en cuestión y se envían a la función Lambda.**
```
$lambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:rdplock"
Id = "ObjectCreated-Lambda"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".pem"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $lambdaConfig
```
**Ejemplo 3: este ejemplo crea 2 configuraciones de Lambda diferentes sobre la base de un sufijo clave diferente y las configura en un solo comando. **
```
#Lambda Config 1
$firstLambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifynet"
Id = "ObjectCreated-dada-ps1"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".ps1"}
)
}
}
}
#Lambda Config 2
$secondlambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = [Amazon.S3.EventType]::ObjectCreatedAll
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifyssm"
Id = "ObjectCreated-dada-json"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".json"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $firstLambdaConfig,$secondlambdaConfig
```
+ Para obtener más información sobre la API, consulte [PutBucketNotification Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Write-S3BucketReplication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketReplication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo establece una configuración de replicación con una sola regla que permite replicar en el depósito «amzn-s3-demo-bucket» cualquier objeto nuevo creado con el prefijo de nombre clave «» en el depósito «amzn-s3-demo-bucket». TaxDocs**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
**Ejemplo 2: Este ejemplo establece una configuración de replicación con varias reglas que permiten replicar en el bucket 'amzn-s3-demo-bucket' cualquier objeto nuevo creado con el prefijo de nombre clave "TaxDocs" o OtherDocs "». Los prefijos de claves no deben superponerse.**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$rule2 = New-Object Amazon.S3.Model.ReplicationRule
$rule2.ID = "Rule-2"
$rule2.Status = "Enabled"
$rule2.Prefix = "OtherDocs"
$rule2.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1,$rule2
}
Write-S3BucketReplication @params
```
**Ejemplo 3: En este ejemplo, se actualiza la configuración de replicación del depósito especificado para inhabilitar la regla que controla la replicación de los objetos con el prefijo de nombre clave "" en el depósito «amzn-s3-demo-bucket». TaxDocs**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Disabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5). [PutBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)Herramientas de AWS para PowerShell *
### `Write-S3BucketRequestPayment`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketRequestPayment`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Actualiza la configuración de pago de solicitudes del bucket denominado “amzn-s3-demo-bucket'”, de modo que se cobre la descarga a la persona que solicita las descargas del bucket. De forma predeterminada, el propietario del bucket paga las descargas. Para volver a establecer el pago de la solicitud como predeterminado, utilice 'BucketOwner' para el parámetro RequestPaymentConfiguration \$1Payer.**
```
Write-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket -RequestPaymentConfiguration_Payer Requester
```
+ Para obtener más información sobre la API, consulte [PutBucketRequestPayment Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Write-S3BucketTagging`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketTagging`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando aplica dos etiquetas a un bucket denominado `cloudtrail-test-2018`, una etiqueta con una clave de Stage y un valor de Test, y una etiqueta con una clave de Environment y un valor de Alpha. Para comprobar que las etiquetas se han añadido al bucket, ejecute `Get-S3BucketTagging -BucketName bucket_name`. Los resultados deben mostrar las etiquetas que ha aplicado al bucket en el primer comando. Tenga en cuenta que `Write-S3BucketTagging` sobrescribe todo el conjunto de etiquetas existente en un bucket. Para añadir o eliminar etiquetas individuales, ejecute los cmdlets Resource Groups y Tagging API, `Add-RGTResourceTag` y `Remove-RGTResourceTag`. Como alternativa, puede utilizar el editor de etiquetas de la consola AWS de administración para gestionar las etiquetas de bucket de S3.**
```
Write-S3BucketTagging -BucketName amzn-s3-demo-bucket -TagSet @( @{ Key="Stage"; Value="Test" }, @{ Key="Environment"; Value="Alpha" } )
```
**Ejemplo 2: este comando canaliza un bucket denominado `cloudtrail-test-2018` al cmdlet de `Write-S3BucketTagging`. Aplica las etiquetas Stage:Production y Department:Finance al bucket. Tenga en cuenta que `Write-S3BucketTagging` sobrescribe todo el conjunto de etiquetas existente en un bucket.**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket | Write-S3BucketTagging -TagSet @( @{ Key="Stage"; Value="Production" }, @{ Key="Department"; Value="Finance" } )
```
+ Para obtener más información sobre la API, consulte [PutBucketTagging Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Write-S3BucketVersioning`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketVersioning`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando habilita el control de versiones para el bucket de S3 indicado.**
```
Write-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket' -VersioningConfig_Status Enabled
```
+ Para obtener más información sobre la API, consulte [PutBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-S3BucketWebsite`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3BucketWebsite`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando habilita el alojamiento de sitios web para el bucket indicado con el documento de índice como “index.html” y el documento de error como “error.html”.**
```
Write-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket' -WebsiteConfiguration_IndexDocumentSuffix 'index.html' -WebsiteConfiguration_ErrorDocument 'error.html'
```
+ Para obtener más información sobre la API, consulte [PutBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-S3LifecycleConfiguration`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3LifecycleConfiguration`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo escribe o reemplaza la configuración proporcionada en el \$1NewRule. Esta configuración se asegura de limitar los objetos del ámbito con valores de prefijo y etiqueta determinados.**
```
$NewRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = @{
Days= 50
}
Id = "Test-From-Write-cmdlet-1"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "non-use"
"Value" = "yes"
}
}
)
}
}
"Status"= 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 75
}
}
Write-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket -Configuration_Rule $NewRule
```
**Ejemplo 2: Este ejemplo establece varias reglas con filtrado. \$1 ArchiveRule establece que los objetos se archivarán en 30 días en Glacier y en 120 días DeepArchive. \$1 ExpireRule caduca tanto en la versión actual como en la anterior en 150 días para los objetos con el prefijo «py» y el prefijo tag:key «archivado» establecido en «sí».**
```
$ExpireRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = @{
Days= 150
}
Id = "Remove-in-150-days"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "archived"
"Value" = "yes"
}
}
)
}
}
Status= 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 150
}
}
$ArchiveRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = $null
Id = "Archive-to-Glacier-in-30-days"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "reviewed"
"Value" = "yes"
}
}
)
}
}
Status = 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 75
}
Transitions = @(
@{
Days = 30
"StorageClass"= 'Glacier'
},
@{
Days = 120
"StorageClass"= [Amazon.S3.S3StorageClass]::DeepArchive
}
)
}
Write-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket -Configuration_Rule $ExpireRule,$ArchiveRule
```
+ *Para obtener más información sobre la API, consulte Cmdlet Reference (V5 [PutLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)).Herramientas de AWS para PowerShell *
### `Write-S3Object`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3Object`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este comando carga el archivo único “local-sample.txt” a Amazon S3 y crea un objeto con la clave “sample.txt” en el bucket “test-files”.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -File .\local-sample.txt
```
**Ejemplo 2: este comando carga el archivo único “sample.txt” a Amazon S3 y crea un objeto con la clave “sample.txt” en el bucket “test-files”. Si no se proporciona el parámetro -Key, el nombre del archivo se utiliza como clave de objeto de S3.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File .\sample.txt
```
**Ejemplo 3: Este comando carga el único archivo "local-sample.txt" a Amazon S3 y crea un objeto con la clave "prefix/to/sample.txt» en el bucket «test-files».**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "prefix/to/sample.txt" -File .\local-sample.txt
```
**Ejemplo 4: Este comando carga todos los archivos del subdirectorio «Scripts» al bucket «test-files» y aplica el key prefijo común «» a cada objeto. SampleScripts Cada archivo cargado tendrá una clave de «SampleScripts/filename», donde la palabra «filename» variará.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\
```
**Ejemplo 5: Este comando carga todos los archivos\$1.ps1 del directorio local «Scripts» al depósito «archivos de prueba» y aplica el prefijo clave común «» a cada objeto. SampleScripts Cada archivo cargado tendrá una clave de "SampleScripts/nombrearchivo.ps1", donde el nombre de archivo variará.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\ -SearchPattern *.ps1
```
**Ejemplo 6: este comando crea un nuevo objeto S3 que contiene la cadena de contenido especificada con la clave “sample.txt”.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -Content "object contents"
```
**Ejemplo 7: este comando carga el archivo especificado (el nombre del archivo se usa como clave) y aplica las etiquetas especificadas al nuevo objeto.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File "sample.txt" -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
**Ejemplo 8: este comando carga de forma recursiva la carpeta especificada y aplica las etiquetas especificadas a todos los objetos nuevos.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder . -KeyPrefix "TaggedFiles" -Recurse -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
+ Para obtener información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet* Reference ([PutObject](https://docs.aws.amazon.com/powershell/v5/reference)V5).
### `Write-S3ObjectRetention`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-S3ObjectRetention`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: el comando habilita el modo de retención de gobierno hasta la fecha “31 de diciembre de 2019 a las 00:00:00” para el objeto “testfile.txt” del bucket de S3 indicado.**
```
Write-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt' -Retention_Mode GOVERNANCE -Retention_RetainUntilDate "2019-12-31T00:00:00"
```
+ Para obtener más información sobre la API, consulte [PutObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de CSPM de Security Hub con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Security Hub CSPM.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-SHUBFinding`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SHUBFinding`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: Este comando recupera los resultados de Security Hub del servicio Amazon EC2.**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.ResourceType = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'PREFIX'
Value = 'AwsEc2'
}
Get-SHUBFinding -Filter $filter
```
**Ejemplo 2: Este comando recupera los resultados de Security Hub del ID de AWS cuenta 123456789012.**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.AwsAccountId = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = '123456789012'
}
Get-SHUBFinding -Filter $filter
```
**Ejemplo 3: Este comando recupera los resultados de Security Hub generados para el estándar “pci-dss”.**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.GeneratorId = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'PREFIX'
Value = 'pci-dss'
}
Get-SHUBFinding -Filter $filter
```
**Ejemplo 4 Este comando recupera los resultados de gravedad crítica de Security Hub cuyo estado de flujo de trabajo es NOTIFIED.**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.SeverityLabel = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = 'CRITICAL'
}
$filter.WorkflowStatus = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = 'NOTIFIED'
}
Get-SHUBFinding -Filter $filter
```
+ Para obtener información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet* Reference ([GetFindings](https://docs.aws.amazon.com/powershell/v5/reference)V5).
# Ejemplos de Amazon SES con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon SES.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Get-SESIdentity`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SESIdentity`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este comando devuelve una lista que contiene todas las identidades (direcciones de correo electrónico y dominios) de una AWS cuenta específica, independientemente del estado de verificación.**
```
Get-SESIdentity
```
+ Para obtener más información sobre la API, consulte [ListIdentities Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-SESSendQuota`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SESSendQuota`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve los límites de envío actuales del usuario.**
```
Get-SESSendQuota
```
+ Para obtener más información sobre la API, consulte [GetSendQuota](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SESSendStatistic`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SESSendStatistic`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este comando devuelve las estadísticas de envío del usuario. El resultado es una lista de puntos de datos correspondiente a las últimas dos semanas de actividad de envío. Cada punto de datos de la lista contiene las estadísticas de un intervalo de 15 minutos.**
```
Get-SESSendStatistic
```
+ Para obtener más información sobre la API, consulte [GetSendStatistics](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de la API v2 de Amazon SES con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con la API de Amazon SES v2.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Send-SES2Email`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-SES2Email`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se muestra cómo enviar un mensaje de correo electrónico estándar.**
```
Send-SES2Email -FromEmailAddress "sender@example.com" -Destination_ToAddress "recipient@example.com" -Subject_Data "Email Subject" -Text_Data "Email Body"
```
+ Para obtener más información sobre la API, consulte [SendEmail](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon SNS con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon SNS.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Publish-SNSMessage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Publish-SNSMessage`.
**Herramientas para la V5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la publicación de un mensaje con una sola MessageAttribute línea declarada.**
```
Publish-SNSMessage -TopicArn "arn:aws:sns:us-west-2:123456789012:my-topic" -Message "Hello" -MessageAttribute @{'City'=[Amazon.SimpleNotificationService.Model.MessageAttributeValue]@{DataType='String'; StringValue ='AnyCity'}}
```
**Ejemplo 2: En este ejemplo se muestra la publicación de un mensaje con varios MessageAttributes declarados de antemano.**
```
$cityAttributeValue = New-Object Amazon.SimpleNotificationService.Model.MessageAttributeValue
$cityAttributeValue.DataType = "String"
$cityAttributeValue.StringValue = "AnyCity"
$populationAttributeValue = New-Object Amazon.SimpleNotificationService.Model.MessageAttributeValue
$populationAttributeValue.DataType = "Number"
$populationAttributeValue.StringValue = "1250800"
$messageAttributes = New-Object System.Collections.Hashtable
$messageAttributes.Add("City", $cityAttributeValue)
$messageAttributes.Add("Population", $populationAttributeValue)
Publish-SNSMessage -TopicArn "arn:aws:sns:us-west-2:123456789012:my-topic" -Message "Hello" -MessageAttribute $messageAttributes
```
+ Para obtener información sobre la API, consulte [Publish](https://docs.aws.amazon.com/powershell/v5/reference) en la *Referencia de cmdlets de Herramientas de AWS para PowerShell (V5)*.
# Ejemplos de Amazon SQS con Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon SQS.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-SQSPermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-SQSPermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo permite al especificado Cuenta de AWS enviar mensajes desde la cola especificada.**
```
Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [AddPermission Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Clear-SQSQueue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Clear-SQSQueue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se eliminan todos los mensajes de la cola especificada.**
```
Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [PurgeQueue](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-SQSMessageVisibility`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-SQSMessageVisibility`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se cambia el tiempo de espera de visibilidad del mensaje con el identificador de recibo especificado en la cola especificada a 10 horas (10 horas \$1 60 minutos \$1 60 segundos = 36000 segundos).**
```
Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000
```
+ Para obtener más información sobre la API, consulte [ChangeMessageVisibility](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-SQSMessageVisibilityBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-SQSMessageVisibilityBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se cambia el tiempo de espera de visibilidad de 2 mensajes con los identificadores de recibo especificado en la cola especificada. El valor de visibilidad del tiempo de espera del primer mensaje se cambia a 10 horas (10 horas \$1 60 minutos \$1 60 segundos = 36000 segundos). El valor de visibilidad del tiempo de espera del segundo mensaje se cambia a 5 horas (5 horas \$1 60 minutos \$1 60 segundos = 18000 segundos).**
```
$changeVisibilityRequest1 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry
$changeVisibilityRequest1.Id = "Request1"
$changeVisibilityRequest1.ReceiptHandle = "AQEBd329...v6gl8Q=="
$changeVisibilityRequest1.VisibilityTimeout = 36000
$changeVisibilityRequest2 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry
$changeVisibilityRequest2.Id = "Request2"
$changeVisibilityRequest2.ReceiptHandle = "AQEBgGDh...J/Iqww=="
$changeVisibilityRequest2.VisibilityTimeout = 18000
Edit-SQSMessageVisibilityBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $changeVisibilityRequest1, $changeVisibilityRequest2
```
**Salida:**
```
Failed Successful
------ ----------
{} {Request2, Request1}
```
+ Para obtener más información sobre la API, consulte [ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SQSDeadLetterSourceQueue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SQSDeadLetterSourceQueue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran URLs las colas que se basan en la cola especificada como cola de cartas muertas.**
```
Get-SQSDeadLetterSourceQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
**Salida:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [ListDeadLetterSourceQueues](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Get-SQSQueue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SQSQueue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se enumeran todas las colas.**
```
Get-SQSQueue
```
**Salida:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/AnotherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/DeadLetterQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
**Ejemplo 2: en este ejemplo se enumeran todas las colas que empiezan con el nombre especificado.**
```
Get-SQSQueue -QueueNamePrefix My
```
**Salida:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
+ Para obtener más información sobre la API, consulte [ListQueues](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SQSQueueAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SQSQueueAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todos los atributos de la cola especificada.**
```
Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Salida:**
```
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[QueueArn, arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue], [ApproximateNumberOfMessages, 0],
[ApproximateNumberOfMessagesNotVisible, 0], [ApproximateNumberOfMessagesDelayed, 0]...}
```
**Ejemplo 2: en este ejemplo se enumeran de forma separada solo los atributos de la cola especificada.**
```
Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Salida:**
```
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[MaximumMessageSize, 262144], [VisibilityTimeout, 30]}
```
+ Para obtener más información sobre la API, consulte [GetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SQSQueueUrl`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SQSQueueUrl`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la URL de la cola con el nombre especificado.**
```
Get-SQSQueueUrl -QueueName MyQueue
```
**Salida:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [GetQueueUrl](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SQSQueue`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SQSQueue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una cola con el nombre especificado.**
```
New-SQSQueue -QueueName MyQueue
```
**Salida:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [CreateQueue](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Receive-SQSMessage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Receive-SQSMessage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra la información de los 10 mensajes siguientes que se van a recibir en la cola especificada. La información contendrá valores para los atributos del mensaje especificado, si existen.**
```
Receive-SQSMessage -AttributeName SenderId, SentTimestamp -MessageAttributeName StudentName, StudentGrade -MessageCount 10 -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Salida:**
```
Attributes : {[SenderId, AIDAIAZKMSNQ7TEXAMPLE], [SentTimestamp, 1451495923744]}
Body : Information about John Doe's grade.
MD5OfBody : ea572796e3c231f974fe75d89EXAMPLE
MD5OfMessageAttributes : 48c1ee811f0fe7c4e88fbe0f5EXAMPLE
MessageAttributes : {[StudentGrade, Amazon.SQS.Model.MessageAttributeValue], [StudentName, Amazon.SQS.Model.MessageAttributeValue]}
MessageId : 53828c4b-631b-469b-8833-c093cEXAMPLE
ReceiptHandle : AQEBpfGp...20Q5cg==
```
+ Para obtener más información sobre la API, consulte [ReceiveMessage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SQSMessage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SQSMessage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se elimina el mensaje con el identificador de recibo especificado de la cola especificada.**
```
Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q==
```
+ Para obtener más información sobre la API, consulte [DeleteMessage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SQSMessageBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SQSMessageBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se eliminan 2 mensajes con los identificadores de recibo especificado de la cola especificada.**
```
$deleteMessageRequest1 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry
$deleteMessageRequest1.Id = "Request1"
$deleteMessageRequest1.ReceiptHandle = "AQEBX2g4...wtJSQg=="
$deleteMessageRequest2 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry
$deleteMessageRequest2.Id = "Request2"
$deleteMessageRequest2.ReceiptHandle = "AQEBqOVY...KTsLYg=="
Remove-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $deleteMessageRequest1, $deleteMessageRequest2
```
**Salida:**
```
Failed Successful
------ ----------
{} {Request1, Request2}
```
+ Para obtener más información sobre la API, consulte [DeleteMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SQSPermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SQSPermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se quita el permiso con la etiqueta especificada de la cola indicada.**
```
Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SQSQueue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SQSQueue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se elimina la cola especificada.**
```
Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [DeleteQueue](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Send-SQSMessage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-SQSMessage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se envía un mensaje con los atributos y el cuerpo del mensaje especificados a la cola especificada, con un retraso de 10 segundos en la entrega del mensaje.**
```
$cityAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$cityAttributeValue.DataType = "String"
$cityAttributeValue.StringValue = "AnyCity"
$populationAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$populationAttributeValue.DataType = "Number"
$populationAttributeValue.StringValue = "1250800"
$messageAttributes = New-Object System.Collections.Hashtable
$messageAttributes.Add("City", $cityAttributeValue)
$messageAttributes.Add("Population", $populationAttributeValue)
Send-SQSMessage -DelayInSeconds 10 -MessageAttributes $messageAttributes -MessageBody "Information about the largest city in Any Region." -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Salida:**
```
MD5OfMessageAttributes MD5OfMessageBody MessageId
---------------------- ---------------- ---------
1d3e51347bc042efbdf6dda31EXAMPLE 51b0a3256d59467f973009b73EXAMPLE c35fed8f-c739-4d0c-818b-1820eEXAMPLE
```
+ Para obtener más información sobre la API, consulte [SendMessage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Send-SQSMessageBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-SQSMessageBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo, se envían 2 mensajes con los atributos y los cuerpos de los mensajes especificados a la cola especificada. La entrega se retrasa 15 segundos para el primer mensaje y 10 segundos para el segundo mensaje.**
```
$student1NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student1NameAttributeValue.DataType = "String"
$student1NameAttributeValue.StringValue = "John Doe"
$student1GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student1GradeAttributeValue.DataType = "Number"
$student1GradeAttributeValue.StringValue = "89"
$student2NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student2NameAttributeValue.DataType = "String"
$student2NameAttributeValue.StringValue = "Jane Doe"
$student2GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student2GradeAttributeValue.DataType = "Number"
$student2GradeAttributeValue.StringValue = "93"
$message1 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry
$message1.DelaySeconds = 15
$message1.Id = "FirstMessage"
$message1.MessageAttributes.Add("StudentName", $student1NameAttributeValue)
$message1.MessageAttributes.Add("StudentGrade", $student1GradeAttributeValue)
$message1.MessageBody = "Information about John Doe's grade."
$message2 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry
$message2.DelaySeconds = 10
$message2.Id = "SecondMessage"
$message2.MessageAttributes.Add("StudentName", $student2NameAttributeValue)
$message2.MessageAttributes.Add("StudentGrade", $student2GradeAttributeValue)
$message2.MessageBody = "Information about Jane Doe's grade."
Send-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $message1, $message2
```
**Salida:**
```
Failed Successful
------ ----------
{} {FirstMessage, SecondMessage}
```
+ Para obtener más información sobre la API, consulte [SendMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Set-SQSQueueAttribute`
En el siguiente ejemplo de código, se muestra cómo utilizar `Set-SQSQueueAttribute`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra cómo establecer una política para suscribirse una cola a un tema de SNS. Cuando se publica un mensaje en un tema, se envía a la cola suscritas.**
```
# create the queue and topic to be associated
$qurl = New-SQSQueue -QueueName "myQueue"
$topicarn = New-SNSTopic -Name "myTopic"
# get the queue ARN to inject into the policy; it will be returned
# in the output's QueueARN member but we need to put it into a variable
# so text expansion in the policy string takes effect
$qarn = (Get-SQSQueueAttribute -QueueUrl $qurl -AttributeName "QueueArn").QueueARN
# construct the policy and inject arns
$policy = @"
{
"Version":"2012-10-17",
"Id": "$qarn/SQSPOLICY",
"Statement": [
{
"Sid": "1",
"Effect": "Allow",
"Principal": "*",
"Action": "SQS:SendMessage",
"Resource": "$qarn",
"Condition": {
"ArnEquals": {
"aws:SourceArn": "$topicarn"
}
}
}
]
}
"@
# set the policy
Set-SQSQueueAttribute -QueueUrl $qurl -Attribute @{ Policy=$policy }
```
**Ejemplo 2: en este ejemplo se establecen los atributos especificados de la cola especificada.**
```
Set-SQSQueueAttribute -Attribute @{"DelaySeconds" = "10"; "MaximumMessageSize" = "131072"} -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obtener más información sobre la API, consulte [SetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS STS ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS STS
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Convert-STSAuthorizationMessage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Convert-STSAuthorizationMessage`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: decodifica la información adicional incluida en el contenido del mensaje codificado suministrado que se devolvió en respuesta a una solicitud. La información adicional está codificada porque los detalles del estado de la autorización pueden constituir información privilegiada que el usuario que solicitó la acción no debería ver.**
```
Convert-STSAuthorizationMessage -EncodedMessage "...encoded message..."
```
+ Para obtener más información sobre la API, consulte [DecodeAuthorizationMessage](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-STSFederationToken`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-STSFederationToken`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: solicita un token federado válido durante una hora con “Bob” como nombre del usuario federado. Este nombre se puede usar para hacer referencia al nombre de usuario federado en una política basada en recursos (como una política de bucket de Amazon S3). La política de IAM proporcionada, en formato JSON, se utiliza para limitar los permisos disponibles para el usuario de IAM. La política proporcionada no puede conceder más permisos que los concedidos al usuario solicitante. Los permisos finales para el usuario federado son los más restrictivos, en función de la intersección de la política aprobada y la política de usuario de IAM.**
```
Get-STSFederationToken -Name "Bob" -Policy "...JSON policy..." -DurationInSeconds 3600
```
+ Para obtener más información sobre la API, consulte [GetFederationToken](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-STSSessionToken`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-STSSessionToken`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve una instancia `Amazon.RuntimeAWSCredentials` que contiene credenciales temporales válidas durante un período de tiempo determinado. Las credenciales utilizadas para solicitar credenciales temporales se deducen de los valores predeterminados actuales del intérprete de comandos. Para especificar otras credenciales, utilice los parámetros - ProfileName o - AccessKey /-SecretKey .**
```
Get-STSSessionToken
```
**Salida:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**Ejemplo 2: devuelve una instancia de `Amazon.RuntimeAWSCredentials` que contiene credenciales temporales válidas durante una hora. Las credenciales utilizadas para realizar la solicitud se obtienen del perfil especificado.**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile
```
**Salida:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**Ejemplo 3: devuelve una instancia `Amazon.RuntimeAWSCredentials` que contiene credenciales temporales válidas durante una hora con el número de identificación del dispositivo MFA asociado a la cuenta, cuyas credenciales se especifican en el perfil “myprofilename” y el valor proporcionado por el dispositivo.**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile -SerialNumber YourMFADeviceSerialNumber -TokenCode 123456
```
**Salida:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
+ Para obtener más información sobre la API, consulte [GetSessionToken Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Use-STSRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Use-STSRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve un conjunto de credenciales temporales (clave de acceso, clave secreta y token de sesión) que se pueden usar durante una hora para acceder a AWS recursos a los que el usuario solicitante normalmente no tendría acceso. Las credenciales devueltas tienen los permisos permitidos por la política de acceso del rol que se está asumiendo y por la política proporcionada (no se puede usar la política proporcionada para conceder permisos superiores a los definidos en la política de acceso del rol que se está asumiendo).**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -Policy "...JSON policy..." -DurationInSeconds 3600
```
**Ejemplo 2: devuelve un conjunto de credenciales temporales, válidas durante una hora, que tienen los mismos permisos que se definen en la política de acceso del rol que se está asumiendo.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600
```
**Ejemplo 3: devuelve un conjunto de credenciales temporales que proporcionan el número de serie y el token generado a partir de una MFA asociada a las credenciales de usuario utilizadas para ejecutar el cmdlet.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -SerialNumber "GAHT12345678" -TokenCode "123456"
```
**Ejemplo 4: devuelve un conjunto de credenciales temporales que han asumido un rol definido en la cuenta de un cliente. Para cada función que el tercero pueda asumir, la cuenta del cliente debe crear una función con un identificador que se debe introducir en el ExternalId parámetro - cada vez que se asuma la función.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -ExternalId "ABC123"
```
+ Para obtener información sobre la API, consulte [AssumeRole Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Use-STSWebIdentityRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Use-STSWebIdentityRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: devuelve un conjunto temporal de credenciales, válido durante una hora, para un usuario que se ha autenticado con el proveedor de identidad Inicio de sesión con Amazon. Las credenciales asumen la política de acceso asociada al rol identificado por el ARN del rol. Si lo desea, puede pasar una política de JSON al parámetro -Policy para perfeccionar aún más los permisos de acceso (no puede conceder más permisos de los disponibles en los permisos asociados al rol). El valor proporcionado a - WebIdentityToken es el identificador de usuario único que devolvió el proveedor de identidad.**
```
Use-STSWebIdentityRole -DurationInSeconds 3600 -ProviderId "www.amazon.com" -RoleSessionName "app1" -RoleArn "arn:aws:iam::123456789012:role/FederatedWebIdentityRole" -WebIdentityToken "Atza...DVI0r1"
```
+ Para obtener más información sobre la API, consulte [AssumeRoleWithWebIdentity Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
# Soporte ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. Soporte
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-ASACommunicationToCase`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-ASACommunicationToCase`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Añade el cuerpo de una comunicación por correo electrónico al caso especificado.**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"
```
**Ejemplo 2: Añade el cuerpo de una comunicación por correo electrónico al caso especificado más una o varias direcciones de correo electrónico o más incluidas en la línea CC del correo electrónico.**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
```
+ Para obtener más información sobre la API, consulte [AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASACase`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASACase`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los detalles de todos los casos de soporte.**
```
Get-ASACase
```
**Ejemplo 2: Devuelve los detalles de todos los casos de soporte desde la fecha y hora especificadas.**
```
Get-ASACase -AfterTime "2013-09-10T03:06Z"
```
**Ejemplo 3: Devuelve los detalles de los primeros 10 casos de soporte, incluidos los que se han resuelto.**
```
Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
```
**Ejemplo 4: Devuelve los detalles del único caso de soporte especificado.**
```
Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**Ejemplo 5: Devuelve los detalles de los casos de soporte especificados.**
```
Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
```
+ Para obtener más información sobre la API, consulte [DescribeCases](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASACommunication`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASACommunication`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve todas las comunicaciones del caso especificado.**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**Ejemplo 2: Devuelve todas las comunicaciones desde la medianoche (horario UTC) del 1 de enero de 2012 para el caso especificado.**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ Para obtener más información sobre la API, consulte [DescribeCommunications](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASAService`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASAService`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve todos los códigos, nombres y categorías de servicio disponibles.**
```
Get-ASAService
```
**Ejemplo 2: Devuelve el nombre y las categorías del servicio con el código especificado.**
```
Get-ASAService -ServiceCodeList "amazon-cloudfront"
```
**Ejemplo 3: Devuelve el nombre y las categorías de los códigos de servicio especificados.**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")
```
**Ejemplo 4: Devuelve el nombre y las categorías (en japonés) de los códigos de servicio especificados. Actualmente, se admiten los códigos de idioma inglés (“en”) y japonés (“ja”).**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
```
+ Para obtener más información sobre la API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASASeverityLevel`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASASeverityLevel`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la lista de niveles de gravedad que se pueden asignar a un caso de AWS Support.**
```
Get-ASASeverityLevel
```
**Ejemplo 2: Devuelve la lista de niveles de gravedad que se pueden asignar a un caso de AWS Support. Los nombres de los niveles se devuelven en japonés.**
```
Get-ASASeverityLevel -Language "ja"
```
+ Para obtener más información sobre la API, consulte [DescribeSeverityLevels Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ASATrustedAdvisorCheck`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASATrustedAdvisorCheck`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve la colección de comprobaciones de Trusted Advisor. Debe especificar el parámetro Language, que puede aceptar “en” para la salida en inglés o “ja” para la salida en japonés.**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ Para obtener más información sobre la API, consulte [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-ASATrustedAdvisorCheckRefreshStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASATrustedAdvisorCheckRefreshStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve el estado actual de las solicitudes de actualización para las comprobaciones especificadas. Solicitud: se ASATrusted AdvisorCheckRefresh puede utilizar para solicitar que se actualice la información de estado de las comprobaciones.**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ Para obtener más información sobre la API, consulte [DescribeTrustedAdvisorCheckRefreshStatuses Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-ASATrustedAdvisorCheckResult`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASATrustedAdvisorCheckResult`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve los resultados de una comprobación de Trusted Advisor. La lista de comprobaciones de Trusted Advisor disponibles se puede obtener mediante Get- ASATrustedAdvisorChecks. El resultado contiene el estado general de la comprobación, la fecha y hora en la que se ejecutó por última vez y el identificador único de la comprobación específica. Si desea que los resultados se muestren en japonés, añada el parámetro -Language “ja”.**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ Para obtener más información sobre la API, consulte [DescribeTrustedAdvisorCheckResult Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-ASATrustedAdvisorCheckSummary`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-ASATrustedAdvisorCheckSummary`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve el resumen más reciente de la comprobación especificada de Trusted Advisor.**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**Ejemplo 2: Devuelve los resúmenes más recientes de las comprobaciones especificadas de Trusted Advisor.**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ Para obtener más información sobre la API, consulte [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-ASACase`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-ASACase`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Crea un nuevo caso en el AWS Support Center. Los valores de los CategoryCode parámetros - ServiceCode y - se pueden obtener mediante el Get-ASAService cmdlet. El valor del SeverityCode parámetro - se puede obtener mediante el Get-ASASeverityLevel cmdlet. El valor del IssueType parámetro - puede ser «servicio al cliente» o «técnico». Si tiene éxito, se AWS mostrará el número de caso de Support. Por defecto, el caso se gestiona en inglés, pero si desea usarlo en japonés, añada el parámetro -Language “ja”. Los CommunicationBody parámetros -ServiceCode, -CategoryCode, -Asunto y - son obligatorios.**
```
New-ASACase -ServiceCode "amazon-cloudfront" -CategoryCode "APIs" -SeverityCode "low" -Subject "subject text" -CommunicationBody "description of the case" -CcEmailAddress @("email1@domain.com", "email2@domain.com") -IssueType "technical"
```
+ Para obtener información sobre la API, consulte [CreateCase Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Request-ASATrustedAdvisorCheckRefresh`
En el siguiente ejemplo de código, se muestra cómo utilizar `Request-ASATrustedAdvisorCheckRefresh`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Solicita una actualización para la comprobación especificada de Trusted Advisor.**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ Para obtener más información sobre la API, consulte [RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Resolve-ASACase`
En el siguiente ejemplo de código, se muestra cómo utilizar `Resolve-ASACase`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Devuelve el estado inicial del caso especificado y su estado actual una vez que se completa la llamada para resolverlo.**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ Para obtener más información sobre la API, consulte [ResolveCase](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Systems Manager con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Systems Manager.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Add-SSMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Add-SSMResourceTag`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: en este ejemplo se actualiza un periodo de mantenimiento con etiquetas nuevas. No se obtienen resultados si el comando se ejecuta correctamente. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
$option1 = @{Key="Stack";Value=@("Production")}
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear cada etiqueta. No se obtienen resultados si el comando se ejecuta correctamente.**
```
$tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag
$tag1.Key = "Stack"
$tag1.Value = "Production"
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1
```
+ Para obtener más información sobre la API, consulte [AddTagsToResource Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Edit-SSMDocumentPermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-SSMDocumentPermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se agregan permisos para “compartir” a todas las cuentas de un documento. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all
```
**Ejemplo 2: en este ejemplo se agregan permisos para “compartir” a una cuenta específica de un documento. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"
```
+ Para obtener más información sobre la API, consulte [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMActivation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMActivation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se proporcionan detalles sobre las activaciones de su cuenta.**
```
Get-SSMActivation
```
**Salida:**
```
ActivationId : 08e51e79-1e36-446c-8e63-9458569c1363
CreatedDate : 3/1/2017 12:01:51 AM
DefaultInstanceName : MyWebServers
Description :
ExpirationDate : 3/2/2017 12:01:51 AM
Expired : False
IamRole : AutomationRole
RegistrationLimit : 10
RegistrationsCount : 0
```
+ Para obtener más información sobre la API, consulte [DescribeActivations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se describe la asociación entre una instancia y un documento.**
```
Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent"
```
**Salida:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temp_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ Para obtener más información sobre la API, consulte [DescribeAssociation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAssociationExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAssociationExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelven las ejecuciones del ID de asociación proporcionado**
```
Get-SSMAssociationExecution -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**Salida:**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 123a45a0-c678-9012-3456-78901234db5e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=4}
Status : Success
```
+ Para obtener más información sobre la API, consulte [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAssociationExecutionTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAssociationExecutionTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra el ID del recurso y su estado de ejecución que forman parte de los destinos de ejecución de la asociación**
```
Get-SSMAssociationExecutionTarget -AssociationId 123a45a0-c678-9012-3456-78901234db5e -ExecutionId 123a45a0-c678-9012-3456-78901234db5e | Select-Object ResourceId, Status
```
**Salida:**
```
ResourceId Status
---------- ------
i-0b1b2a3456f7a890b Success
i-01c12a45d6fc7a89f Success
i-0a1caf234f56d7dc8 Success
i-012a3fd45af6dbcfe Failed
i-0ddc1df23c4a5fb67 Success
```
**Ejemplo 2: este comando comprueba la ejecución concreta de una automatización concreta desde ayer, a la que está asociado un documento de comandos. Además, también comprueba si se ha producido un error en la ejecución de la asociación y, de ser así, mostrará los detalles de la invocación del comando junto con el ID de la instancia**
```
$AssociationExecution= Get-SSMAssociationExecutionTarget -AssociationId 1c234567-890f-1aca-a234-5a678d901cb0 -ExecutionId 12345ca12-3456-2345-2b45-23456789012 |
Where-Object {$_.LastExecutionDate -gt (Get-Date -Hour 00 -Minute 00).AddDays(-1)}
foreach ($execution in $AssociationExecution) {
if($execution.Status -ne 'Success'){
Write-Output "There was an issue executing the association $($execution.AssociationId) on $($execution.ResourceId)"
Get-SSMCommandInvocation -CommandId $execution.OutputSource.OutputSourceId -Detail:$true | Select-Object -ExpandProperty CommandPlugins
}
}
```
**Salida:**
```
There was an issue executing the association 1c234567-890f-1aca-a234-5a678d901cb0 on i-0a1caf234f56d7dc8
Name : aws:runPowerShellScript
Output :
----------ERROR-------
failed to run commands: exit status 1
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 1
ResponseFinishDateTime : 5/29/2019 11:04:49 AM
ResponseStartDateTime : 5/29/2019 11:04:49 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Failed
StatusDetails : Failed
```
+ Para obtener más información sobre la API, consulte [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAssociationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAssociationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las asociaciones de una instancia. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
$filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")}
Get-SSMAssociationList -AssociationFilterList $filter1
```
**Salida:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**Ejemplo 2: en este ejemplo se enumeran todas las asociaciones de un documento de configuración. La sintaxis utilizada en este ejemplo requiere PowerShell la versión 3 o posterior.**
```
$filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")}
Get-SSMAssociationList -AssociationFilterList $filter2
```
**Salida:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**Ejemplo 3: Con la PowerShell versión 2, debe usar New-Object para crear cada filtro.**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter
$filter1.Key = "InstanceId"
$filter1.Value = "i-0000293ffd8c57862"
Get-SSMAssociationList -AssociationFilterList $filter1
```
**Salida:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
+ Para obtener más información sobre la API, consulte [ListAssociations Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-SSMAssociationVersionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAssociationVersionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recuperan todas las versiones de la asociación proporcionada.**
```
Get-SSMAssociationVersionList -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**Salida:**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName :
AssociationVersion : 2
ComplianceSeverity :
CreatedDate : 3/12/2019 9:21:01 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression :
Targets : {InstanceIds}
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName : test-case-1234567890
AssociationVersion : 1
ComplianceSeverity :
CreatedDate : 3/2/2019 8:53:29 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression : rate(30minutes)
Targets : {InstanceIds}
```
+ Para obtener más información sobre la API, consulte [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAutomationExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAutomationExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles de una ejecución de Automatización.**
```
Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
**Salida:**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
FailureMessage : Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded
authorization failure message: B_V2QyyN7NhSZQYpmVzpEc4oSnj2GLTNYnXUHsTbqJkNMoDgubmbtthLmZyaiUYekORIrA42-fv1x-04q5Fjff6glh
Yb6TI5b0GQeeNrpwNvpDzmO-PSR1swlAbg9fdM9BcNjyrznspUkWpuKu9EC1Ou6v3OXU1KC9nZ7mPlWMFZNkSioQqpwWEvMw-GZktsQzm67qOhUhBNOLWYhbS
pkfiqzY-5nw3S0obx30fhd3EJa5O_-GjV_a0nFXQJa70ik40bFOrEh3MtCSbrQT6--DvFy_FQ8TKvkIXadyVskeJI84XOF5WmA60f1pi5GI08i-nRfZS6oDeU
gELBjjoFKD8s3L2aI0B6umWVxnQOjqhQRxwJ53b54sZJ2PW3v_mtg9-q0CK0ezS3xfh_y0ilaUGOAZG-xjQFuvU_JZedWpla3xi-MZsmblAifBI
(Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID:
6a002f94-ba37-43fd-99e6-39517715fce5)
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
Parameters : {[AutomationAssumeRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [InstanceIamRole,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [SourceAmiId,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
StepExecutions : {launchInstance, updateOSSoftware, stopInstance, createImage...}
```
**Ejemplo 2: en este ejemplo se enumeran los detalles de los pasos del identificador de ejecución de automatización indicado**
```
Get-SSMAutomationExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object -ExpandProperty StepExecutions | Select-Object StepName, Action, StepStatus, ValidNextSteps
```
**Salida:**
```
StepName Action StepStatus ValidNextSteps
-------- ------ ---------- --------------
LaunchInstance aws:runInstances Success {OSCompatibilityCheck}
OSCompatibilityCheck aws:runCommand Success {RunPreUpdateScript}
RunPreUpdateScript aws:runCommand Success {UpdateEC2Config}
UpdateEC2Config aws:runCommand Cancelled {}
UpdateSSMAgent aws:runCommand Pending {}
UpdateAWSPVDriver aws:runCommand Pending {}
UpdateAWSEnaNetworkDriver aws:runCommand Pending {}
UpdateAWSNVMe aws:runCommand Pending {}
InstallWindowsUpdates aws:runCommand Pending {}
RunPostUpdateScript aws:runCommand Pending {}
RunSysprepGeneralize aws:runCommand Pending {}
StopInstance aws:changeInstanceState Pending {}
CreateImage aws:createImage Pending {}
TerminateInstance aws:changeInstanceState Pending {}
```
+ Para obtener más información sobre la API, consulte [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAutomationExecutionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAutomationExecutionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se describen todas las ejecuciones de Automatización activas y finalizadas asociadas a su cuenta.**
```
Get-SSMAutomationExecutionList
```
**Salida:**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutedBy : admin
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
LogFile :
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
```
**Ejemplo 2: Este ejemplo muestra el identificador de ejecución, el documento y la marca de start/end tiempo de ejecución para las ejecuciones con AutomationExecutionStatus un resultado distinto al de «éxito»**
```
Get-SSMAutomationExecutionList | Where-Object AutomationExecutionStatus -ne "Success" | Select-Object AutomationExecutionId, DocumentName, AutomationExecutionStatus, ExecutionStartTime, ExecutionEndTime | Format-Table -AutoSize
```
**Salida:**
```
AutomationExecutionId DocumentName AutomationExecutionStatus ExecutionStartTime ExecutionEndTime
--------------------- ------------ ------------------------- ------------------ ----------------
e1d2bad3-4567-8901-ae23-456c7c8901be AWS-UpdateWindowsAmi Cancelled 4/16/2019 5:37:04 AM 4/16/2019 5:47:29 AM
61234567-a7f8-90e1-2b34-567b8bf9012c Fixed-UpdateAmi Cancelled 4/16/2019 5:33:04 AM 4/16/2019 5:40:15 AM
91234d56-7e89-0ac1-2aee-34ea5d6a7c89 AWS-UpdateWindowsAmi Failed 4/16/2019 5:22:46 AM 4/16/2019 5:27:29 AM
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)*Reference (V5).
### `Get-SSMAutomationStepExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAutomationStepExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra información acerca de todas las ejecuciones de pasos activas y finalizadas en un flujo de trabajo de Automatización.**
```
Get-SSMAutomationStepExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object StepName, Action, StepStatus
```
**Salida:**
```
StepName Action StepStatus
-------- ------ ----------
LaunchInstance aws:runInstances Success
OSCompatibilityCheck aws:runCommand Success
RunPreUpdateScript aws:runCommand Success
UpdateEC2Config aws:runCommand Cancelled
UpdateSSMAgent aws:runCommand Pending
UpdateAWSPVDriver aws:runCommand Pending
UpdateAWSEnaNetworkDriver aws:runCommand Pending
UpdateAWSNVMe aws:runCommand Pending
InstallWindowsUpdates aws:runCommand Pending
RunPostUpdateScript aws:runCommand Pending
RunSysprepGeneralize aws:runCommand Pending
StopInstance aws:changeInstanceState Pending
CreateImage aws:createImage Pending
TerminateInstance aws:changeInstanceState Pending
```
+ Para obtener más información sobre la API, consulte [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMAvailablePatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMAvailablePatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen todas las revisiones de Windows Server 2012 que tienen una gravedad de MSRC crítica. La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
$filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")}
$filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")}
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**Salida:**
```
Classification : SecurityUpdates
ContentUrl : https://support.microsoft.com/en-us/kb/2727528
Description : A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control
over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to
restart your system.
Id : 1eb507be-2040-4eeb-803d-abc55700b715
KbNumber : KB2727528
Language : All
MsrcNumber : MS12-072
MsrcSeverity : Critical
Product : WindowsServer2012
ProductFamily : Windows
ReleaseDate : 11/13/2012 6:00:00 PM
Title : Security Update for Windows Server 2012 (KB2727528)
Vendor : Microsoft
...
```
**Ejemplo 2: Con la PowerShell versión 2, debe usar New-Object para crear cada filtro.**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "PRODUCT"
$filter1.Values = "WindowsServer2012"
$filter2 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter2.Key = "MSRC_SEVERITY"
$filter2.Values = "Critical"
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**Ejemplo 3: en este ejemplo se muestran todas las actualizaciones publicadas en los últimos 20 días y aplicables a los productos correspondientes a 2019 WindowsServer**
```
Get-SSMAvailablePatch | Where-Object ReleaseDate -ge (Get-Date).AddDays(-20) | Where-Object Product -eq "WindowsServer2019" | Select-Object ReleaseDate, Product, Title
```
**Salida:**
```
ReleaseDate Product Title
----------- ------- -----
4/9/2019 5:00:12 PM WindowsServer2019 2019-04 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4493478)
4/9/2019 5:00:06 PM WindowsServer2019 2019-04 Cumulative Update for Windows Server 2019 for x64-based Systems (KB4493509)
4/2/2019 5:00:06 PM WindowsServer2019 2019-03 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB4493510)
```
+ Para obtener más información sobre la API, consulte [DescribeAvailablePatches Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-SSMCommand`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMCommand`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todos los comandos solicitados.**
```
Get-SSMCommand
```
**Salida:**
```
CommandId : 4b75a163-d39a-4d97-87c9-98ae52c6be35
Comment : Apply association with id at update time: 4cc73e42-d5ae-4879-84f8-57e09c0efcd0
CompletedCount : 1
DocumentName : AWS-RefreshAssociation
ErrorCount : 0
ExpiresAfter : 2/24/2017 3:19:08 AM
InstanceIds : {i-0cb2b964d3e14fd9f}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[associationIds, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 2/24/2017 3:18:08 AM
ServiceRole :
Status : Success
StatusDetails : Success
TargetCount : 1
Targets : {}
```
**Ejemplo 2: en este ejemplo se obtiene el estado de un comando específico.**
```
Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"
```
**Ejemplo 3: en este ejemplo se recuperan todos los comandos de SSM invocados después de 2019-04-01T00:00:00Z **
```
Get-SSMCommand -Filter @{Key="InvokedAfter";Value="2019-04-01T00:00:00Z"} | Select-Object CommandId, DocumentName, Status, RequestedDateTime | Sort-Object -Property RequestedDateTime -Descending
```
**Salida:**
```
CommandId DocumentName Status RequestedDateTime
--------- ------------ ------ -----------------
edb1b23e-456a-7adb-aef8-90e-012ac34f AWS-RunPowerShellScript Cancelled 4/16/2019 5:45:23 AM
1a2dc3fb-4567-890d-a1ad-234b5d6bc7d9 AWS-ConfigureAWSPackage Success 4/6/2019 9:19:42 AM
12c3456c-7e90-4f12-1232-1234f5b67893 KT-Retrieve-Cloud-Type-Win Failed 4/2/2019 4:13:07 AM
fe123b45-240c-4123-a2b3-234bdd567ecf AWS-RunInspecChecks Failed 4/1/2019 2:27:31 PM
1eb23aa4-567d-4123-12a3-4c1c2ab34561 AWS-RunPowerShellScript Success 4/1/2019 1:05:55 PM
1c2f3bb4-ee12-4bc1-1a23-12345eea123e AWS-RunInspecChecks Failed 4/1/2019 11:13:09 AM
```
+ Para obtener más información sobre la API, consulte [ListCommands](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMCommandInvocation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMCommandInvocation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las invocaciones de un comando.**
```
Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true
```
**Salida:**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
CommandPlugins : {aws:runShellScript}
Comment : IP config
DocumentName : AWS-RunShellScript
InstanceId : i-0cb2b964d3e14fd9f
InstanceName :
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
RequestedDateTime : 2/22/2017 8:13:16 PM
ServiceRole :
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
TraceOutput :
```
**Ejemplo 2: En este ejemplo se muestra la invocación del identificador de comando CommandPlugins e1eb2e3c-ed4c-5123-45c1-234f5612345f**
```
Get-SSMCommandInvocation -CommandId e1eb2e3c-ed4c-5123-45c1-234f5612345f -Detail:$true | Select-Object -ExpandProperty CommandPlugins
```
**Salida:**
```
Name : aws:runPowerShellScript
Output : Completed 17.7 KiB/17.7 KiB (40.1 KiB/s) with 1 file(s) remainingdownload: s3://dd-aess-r-ctmer/KUMO.png to ..\..\programdata\KUMO.png
kumo available
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 0
ResponseFinishDateTime : 4/3/2019 11:53:23 AM
ResponseStartDateTime : 4/3/2019 11:53:21 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ *Herramientas de AWS para PowerShell Para obtener información [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v5/reference)sobre la API, consulte* Cmdlet Reference (V5).
### `Get-SSMCommandInvocationDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMCommandInvocationDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles de un comando ejecutado en una instancia.**
```
Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44"
```
**Salida:**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
Comment : IP config
DocumentName : AWS-RunShellScript
ExecutionElapsedTime : PT0.004S
ExecutionEndDateTime : 2017-02-22T20:13:16.651Z
ExecutionStartDateTime : 2017-02-22T20:13:16.651Z
InstanceId : i-0cb2b964d3e14fd9f
PluginName : aws:runShellScript
ResponseCode : 0
StandardErrorContent :
StandardErrorUrl :
StandardOutputContent :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ Para obtener más información sobre la API, consulte [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMComplianceItemList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMComplianceItemList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran los elementos de conformidad para el identificador y el tipo de recurso indicados, filtrando el tipo de conformidad por “Asociación”**
```
Get-SSMComplianceItemList -ResourceId i-1a2caf345f67d0dc2 -ResourceType ManagedInstance -Filter @{Key="ComplianceType";Values="Association"}
```
**Salida:**
```
ComplianceType : Association
Details : {[DocumentName, AWS-GatherSoftwareInventory], [DocumentVersion, 1]}
ExecutionSummary : Amazon.SimpleSystemsManagement.Model.ComplianceExecutionSummary
Id : 123a45a1-c234-1234-1245-67891236db4e
ResourceId : i-1a2caf345f67d0dc2
ResourceType : ManagedInstance
Severity : UNSPECIFIED
Status : COMPLIANT
Title :
```
+ Para obtener más información sobre la API, consulte [ListComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMComplianceSummaryList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMComplianceSummaryList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve un recuento resumido de los recursos conformes y no conformes correspondientes a todos los tipos de conformidad. **
```
Get-SSMComplianceSummaryList
```
**Salida:**
```
ComplianceType CompliantSummary NonCompliantSummary
-------------- ---------------- -------------------
FleetTotal Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Association Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Custom:InSpec Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Patch Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
```
+ Para obtener más información sobre la API, consulte [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMConnectionStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMConnectionStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se recupera el estado de conexión del Administrador de sesiones de una instancia para determinar si está conectada y lista para recibir las conexiones del Administrador de sesiones. **
```
Get-SSMConnectionStatus -Target i-0a1caf234f12d3dc4
```
**Salida:**
```
Status Target
------ ------
Connected i-0a1caf234f12d3dc4
```
+ Para obtener más información sobre la API, consulte [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDefaultPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDefaultPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra la línea de base de revisiones predeterminada.**
```
Get-SSMDefaultPatchBaseline
```
**Salida:**
```
arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966
```
+ Para obtener más información sobre la API, consulte [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDeployablePatchSnapshotForInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDeployablePatchSnapshotForInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra la instantánea actual de la línea de base de revisiones que usa una instancia. Este comando debe ejecutarse desde la instancia con las credenciales de la instancia. Para garantizar que utiliza las credenciales de la instancia, en el ejemplo pasa un objeto `Amazon.Runtime.InstanceProfileAWSCredentials` al parámetro Credentials.**
```
$credentials = [Amazon.Runtime.InstanceProfileAWSCredentials]::new()
Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" -Credentials $credentials
```
**Salida:**
```
InstanceId SnapshotDownloadUrl
---------- -------------------
i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...
```
**Ejemplo 2: En este ejemplo se muestra cómo obtener el contenido completo SnapshotDownloadUrl. Este comando debe ejecutarse desde la instancia con las credenciales de la instancia. Para garantizar que utiliza las credenciales de la instancia, en el ejemplo se configura la PowerShell sesión para que utilice un `Amazon.Runtime.InstanceProfileAWSCredentials` objeto.**
```
Set-AWSCredential -Credential ([Amazon.Runtime.InstanceProfileAWSCredentials]::new())
(Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl
```
**Salida:**
```
https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...
```
+ Para obtener información sobre la API, consulte [GetDeployablePatchSnapshotForInstance Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-SSMDocument`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDocument`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve el contenido de un documento.**
```
Get-SSMDocument -Name "RunShellScript"
```
**Salida:**
```
Content
-------
{...
```
**Ejemplo 2: en este ejemplo se muestra el contenido completo de un documento.**
```
(Get-SSMDocument -Name "RunShellScript").Content
{
"schemaVersion":"2.0",
"description":"Run an updated script",
"parameters":{
"commands":{
"type":"StringList",
"description":"(Required) Specify a shell script or a command to run.",
"minItems":1,
"displayType":"textarea"
}
},
"mainSteps":[
{
"action":"aws:runShellScript",
"name":"runShellScript",
"inputs":{
"commands":"{{ commands }}"
}
},
{
"action":"aws:runPowerShellScript",
"name":"runPowerShellScript",
"inputs":{
"commands":"{{ commands }}"
}
}
]
}
```
+ Para obtener más información sobre la API, consulte [GetDocument](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDocumentDescription`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDocumentDescription`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se devuelve información sobre un documento.**
```
Get-SSMDocumentDescription -Name "RunShellScript"
```
**Salida:**
```
CreatedDate : 2/24/2017 5:25:13 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 123456789012
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Active
```
+ Para obtener más información sobre la API, consulte [DescribeDocument](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDocumentList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDocumentList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran todos los documentos de configuración de su cuenta.**
```
Get-SSMDocumentList
```
**Salida:**
```
DocumentType : Command
DocumentVersion : 1
Name : AWS-ApplyPatchBaseline
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureAWSPackage
Owner : Amazon
PlatformTypes : {Windows, Linux}
SchemaVersion : 2.0
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureCloudWatch
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
...
```
**Ejemplo 2: en este ejemplo se recuperan todos los documentos de automatización cuyo nombre coincida con “Platform”**
```
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
```
**Salida:**
```
DocumentFormat : JSON
DocumentType : Automation
DocumentVersion : 7
Name : KT-Get-Platform
Owner : 987654123456
PlatformTypes : {Windows, Linux}
SchemaVersion : 0.3
Tags : {}
TargetType :
VersionName :
```
+ Para obtener más información sobre la API, consulte [ListDocuments](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDocumentPermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDocumentPermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las versiones de un documento.**
```
Get-SSMDocumentVersionList -Name "RunShellScript"
```
**Salida:**
```
CreatedDate DocumentVersion IsDefaultVersion Name
----------- --------------- ---------------- ----
2/24/2017 5:25:13 AM 1 True RunShellScript
```
+ Para obtener más información sobre la API, consulte [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMDocumentVersionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMDocumentVersionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las versiones de un documento.**
```
Get-SSMDocumentVersionList -Name "AWS-UpdateSSMAgent"
```
**Salida:**
```
CreatedDate : 6/1/2021 5:19:10 PM
DocumentFormat : JSON
DocumentVersion : 1
IsDefaultVersion : True
Name : AWS-UpdateSSMAgent
Status : Active
```
+ Para obtener más información sobre la API, consulte [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMEffectiveInstanceAssociationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMEffectiveInstanceAssociationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se describen las asociaciones efectivas de una instancia.**
```
Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5
```
**Salida:**
```
AssociationId Content
------------- -------
d8617c07-2079-4c18-9847-1655fc2698b0 {...
```
**Ejemplo 2: en este ejemplo se muestra el contenido de las asociaciones efectivas de una instancia.**
```
(Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content
```
**Salida:**
```
{
"schemaVersion": "1.2",
"description": "Update the Amazon SSM Agent to the latest version or specified version.",
"parameters": {
"version": {
"default": "",
"description": "(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agen
t will be updated to the latest version.",
"type": "String"
},
"allowDowngrade": {
"default": "false",
"description": "(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set
to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.",
"type": "String",
"allowedValues": [
"true",
"false"
]
}
},
"runtimeConfig": {
"aws:updateSsmAgent": {
"properties": [
{
"agentName": "amazon-ssm-agent",
"source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
"allowDowngrade": "{{ allowDowngrade }}",
"targetVersion": "{{ version }}"
}
]
}
}
}
```
+ Para obtener más información sobre la API, consulte [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMEffectivePatchesForPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMEffectivePatchesForPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las líneas de base de revisiones con una lista de resultados máxima de 1.**
```
Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1
```
**Salida:**
```
Patch PatchStatus
----- -----------
Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus
```
**Ejemplo 2: en este ejemplo se muestran los estados de revisión de todas las líneas de base de revisiones con una lista de resultados máxima de 1.**
```
(Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus
```
**Salida:**
```
ApprovalDate DeploymentStatus
------------ ----------------
12/21/2010 6:00:00 PM APPROVED
```
+ Para obtener más información sobre la API, consulte [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInstanceAssociationsStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInstanceAssociationsStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles de las asociaciones de una instancia.**
```
Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"
```
**Salida:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DetailedStatus : Pending
DocumentVersion : 1
ErrorCode :
ExecutionDate : 2/20/2015 8:31:11 AM
ExecutionSummary : temp_status_change
InstanceId : i-0000293ffd8c57862
Name : AWS-UpdateSSMAgent
OutputUrl :
Status : Pending
```
**Ejemplo 2: en este ejemplo se comprueba el estado de la asociación de instancias para el ID de instancia dado y, además, se muestra el estado de ejecución de esas asociaciones**
```
Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}
```
**Salida:**
```
AssociationId : 512a34a5-c678-1234-1234-12345678db9e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 512a34a5-c678-1234-1234-12345678db9e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=9}
Status : Success
```
+ Para obtener más información sobre la API, consulte [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInstanceInformation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInstanceInformation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles de cada una de las instancias.**
```
Get-SSMInstanceInformation
```
**Salida:**
```
ActivationId :
AgentVersion : 2.0.672.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : ip-172-31-44-222.us-west-2.compute.internal
IamRole :
InstanceId : i-0cb2b964d3e14fd9f
IPAddress : 172.31.44.222
IsLatestVersion : True
LastAssociationExecutionDate : 2/24/2017 3:18:09 AM
LastPingDateTime : 2/24/2017 3:35:03 AM
LastSuccessfulAssociationExecutionDate : 2/24/2017 3:18:09 AM
Name :
PingStatus : ConnectionLost
PlatformName : Amazon Linux AMI
PlatformType : Linux
PlatformVersion : 2016.09
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**Ejemplo 2: En este ejemplo se muestra cómo utilizar el parámetro -Filter para filtrar los resultados solo a las instancias de AWS Systems Manager de la región `us-east-1` con un `AgentVersion` de`2.2.800.0`. Puedes encontrar una lista de valores clave de -Filter válidos en el tema de referencia de la InstanceInformation API (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1 InstanceInformation .html \$1systemsmanager -Type- -). InstanceInformation ActivationId**
```
$Filters = @{
Key="AgentVersion"
Values="2.2.800.0"
}
Get-SSMInstanceInformation -Region us-east-1 -Filter $Filters
```
**Salida:**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.01
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.02
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**Ejemplo 3: En este ejemplo se muestra cómo utilizar el InstanceInformationFilterList parámetro - para filtrar los resultados solo a las instancias de AWS Systems Manager `PlatformTypes` de la región `us-east-1` con `Windows` o`Linux`. Puedes encontrar una lista de valores InstanceInformationFilterList clave válidos en el tema de referencia de la InstanceInformationFilter API (https://docs.aws.amazon.com/systems-manager/latest/APIReference/APIInstanceInformationFilter\$1.html).**
```
$Filters = @{
Key="PlatformTypes"
ValueSet=("Windows","Linux")
}
Get-SSMInstanceInformation -Region us-east-1 -InstanceInformationFilterList $Filters
```
**Salida:**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.27
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Ubuntu Server 18.04 LTS
PlatformType : Linux
PlatformVersion : 18.04
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.100
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**Ejemplo 4: en este ejemplo se enumeran las instancias gestionadas por SSM y las exportaciones InstanceId PingStatus, así LastPingDateTime como PlatformName a un archivo csv.**
```
Get-SSMInstanceInformation | Select-Object InstanceId, PingStatus, LastPingDateTime, PlatformName | Export-Csv Instance-details.csv -NoTypeInformation
```
+ Para obtener más información sobre la API, consulte [DescribeInstanceInformation Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-SSMInstancePatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInstancePatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los detalles de conformidad de las revisiones de una instancia.**
```
Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"
```
+ Para obtener más información sobre la API, consulte [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInstancePatchState`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInstancePatchState`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los estados resumidos de las revisiones en una instancia.**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"
```
**Ejemplo 2: en este ejemplo se obtienen los estados resumidos de las revisiones en dos instancias.**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"
```
+ Para obtener más información sobre la API, consulte [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInstancePatchStatesForPatchGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInstancePatchStatesForPatchGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los estados resumidos de las revisiones por instancia en un grupo de revisiones.**
```
Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"
```
+ Para obtener más información sobre la API, consulte [DescribeInstancePatchStatesForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInventory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInventory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los metadatos personalizados del inventario.**
```
Get-SSMInventory
```
**Salida:**
```
Data Id
---- --
{[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f
```
+ Para obtener más información sobre la API, consulte [GetInventory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInventoryEntriesList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInventoryEntriesList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las entradas de inventario personalizadas de una instancia.**
```
Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo"
```
**Salida:**
```
CaptureTime : 2016-08-22T10:01:01Z
Entries : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,System.String]}
InstanceId : i-0cb2b964d3e14fd9f
NextToken :
SchemaVersion : 1.0
TypeName : Custom:RackInfo
```
**Ejemplo 2: en este ejemplo se enumeran los detalles.**
```
(Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries
```
**Salida:**
```
Key Value
--- -----
RackLocation Bay B/Row C/Rack D/Shelf E
```
+ Para obtener más información sobre la API, consulte [ListInventoryEntries](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMInventoryEntryList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInventoryEntryList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se recuperan las entradas de inventario de tipo `AWS:Network` para la instancia.**
```
Get-SSMInventoryEntryList -InstanceId mi-088dcb0ecea37b076 -TypeName AWS:Network | Select-Object -ExpandProperty Entries
```
**Salida:**
```
Key Value
--- -----
DHCPServer 172.31.11.2
DNSServer 172.31.0.1
Gateway 172.31.11.2
IPV4 172.31.11.222
IPV6 fe12::3456:7da8:901a:12a3
MacAddress 1A:23:4E:5B:FB:67
Name Amazon Elastic Network Adapter
SubnetMask 255.255.240.0
```
+ Para [obtener información sobre la API, consulte la referencia del Herramientas de AWS para PowerShell cmdlet Get- SSMInventory EntryList](https://docs.aws.amazon.com/powershell/v5/reference) *in (*V5).
### `Get-SSMInventorySchema`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMInventorySchema`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo devuelve una lista con los nombres de los tipos de inventario de la cuenta.**
```
Get-SSMInventorySchema
```
+ Para obtener más información sobre la API, consulte [GetInventorySchema](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMLatestEC2Image`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMLatestEC2Image`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran todas las versiones más recientes de Windows. AMIs**
```
PS Get-SSMLatestEC2Image -Path ami-windows-latest
```
**Salida:**
```
Name Value
---- -----
Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Express ami-0e5ddd288daff4fab
Windows_Server-2012-R2_RTM-Chinese_Simplified-64Bit-Base ami-0c5ea64e6bec1cb50
Windows_Server-2012-R2_RTM-Chinese_Traditional-64Bit-Base ami-09775eff0bf8c113d
Windows_Server-2012-R2_RTM-Dutch-64Bit-Base ami-025064b67e28cf5df
...
```
**Ejemplo 2: En este ejemplo se recupera el identificador de AMI de una imagen específica de Amazon Linux para la región us-west-2.**
```
PS Get-SSMLatestEC2Image -Path ami-amazon-linux-latest -ImageName amzn-ami-hvm-x86_64-ebs -Region us-west-2
```
**Salida:**
```
ami-09b92cd132204c704
```
**Ejemplo 3: En este ejemplo se muestran las últimas ventanas que AMIs coinciden con la expresión comodín especificada.**
```
Get-SSMLatestEC2Image -Path ami-windows-latest -ImageName *Windows*2019*English*
```
**Salida:**
```
Name Value
---- -----
Windows_Server-2019-English-Full-SQL_2017_Web ami-085e9d27da5b73a42
Windows_Server-2019-English-STIG-Core ami-0bfd85c29148c7f80
Windows_Server-2019-English-Full-SQL_2019_Web ami-02099560d7fb11f20
Windows_Server-2019-English-Full-SQL_2016_SP2_Standard ami-0d7ae2d81c07bd598
...
```
+ Para obtener más información sobre la API, consulte [Get- SSMLatest EC2 Image](https://docs.aws.amazon.com/powershell/v5/reference) in *Herramientas de AWS para PowerShell Cmdlet Reference* (V5).
### `Get-SSMMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtienen los detalles sobre un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d"
```
**Salida:**
```
AllowUnassociatedTargets : False
CreatedDate : 2/20/2017 6:14:05 PM
Cutoff : 1
Duration : 2
Enabled : True
ModifiedDate : 2/20/2017 6:14:05 PM
Name : TestMaintWin
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ Para obtener más información sobre la API, consulte [GetMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumera la información sobre una tarea ejecutada como parte de una ejecución de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Salida:**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
TaskIds : {ac0c6ae1-daa3-4a89-832e-d384503b6586}
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ Para obtener más información sobre la API, consulte [GetMaintenanceWindowExecution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowExecutionList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowExecutionList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las ejecuciones de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d"
```
**Salida:**
```
EndTime : 2/20/2017 6:30:17 PM
StartTime : 2/20/2017 6:30:16 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
WindowExecutionId : 6f3215cf-4101-4fa0-9b7b-9523269599c7
WindowId : mw-03eb9db42890fb82d
```
**Ejemplo 2: en este ejemplo se enumeran todas las ejecuciones de un periodo de mantenimiento antes de una fecha especificada.**
```
$option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
**Ejemplo 3: en este ejemplo se enumeran todas las ejecuciones de un periodo de mantenimiento después de una fecha especificada.**
```
$option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindowExecutions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowExecutionTask`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowExecutionTask`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumera la información sobre una tarea ejecutada que formaba parte de una ejecución de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Salida:**
```
EndTime : 2/21/2017 4:00:35 PM
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRole : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The maximum error count was exceeded.
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskParameters : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskPara
meterValueExpression]}
Type : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ Para obtener más información sobre la API, consulte [GetMaintenanceWindowExecutionTask](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowExecutionTaskInvocationList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowExecutionTaskInvocationList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se enumeran las invocaciones de una tarea ejecutada como parte de una ejecución de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Salida:**
```
EndTime : 2/21/2017 4:00:34 PM
ExecutionId :
InvocationId : e274b6e1-fe56-4e32-bd2a-8073c6381d8b
OwnerInformation :
Parameters : {"documentName":"AWS-RunShellScript","instanceIds":["i-0000293ffd8c57862"],"parameters":{"commands":["df"]},"maxConcurrency":"1",
"maxErrors":"1"}
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The instance IDs list contains an invalid entry.
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
WindowTargetId :
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindowExecutionTaskInvocations](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowExecutionTaskList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowExecutionTaskList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran las tareas asociadas a la ejecución de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Salida:**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : SUCCESS
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskType : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindowExecutionTasks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todos los periodos de mantenimiento de su cuenta.**
```
Get-SSMMaintenanceWindowList
```
**Salida:**
```
Cutoff : 1
Duration : 4
Enabled : True
Name : My-First-Maintenance-Window
WindowId : mw-06d59c1a07c022145
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindows](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowTarget`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowTarget`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todos los destinos de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f"
```
**Salida:**
```
OwnerInformation : Single instance
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : 350d44e6-28cc-44e2-951f-4b2c985838f6
OwnerInformation : Two instances in a list
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : e078a987-2866-47be-bedd-d9cf49177d3a
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindowTargets](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMMaintenanceWindowTaskList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMMaintenanceWindowTaskList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las tareas de un periodo de mantenimiento.**
```
Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f"
```
**Salida:**
```
LoggingInfo :
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRoleArn : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
Targets : {InstanceIds}
TaskArn : AWS-RunShellScript
TaskParameters : {[commands, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression]}
Type : RUN_COMMAND
WindowId : mw-06cf17cbefcb4bf4f
WindowTaskId : a23e338d-ff30-4398-8aa3-09cd052ebf17
```
+ Para obtener más información sobre la API, consulte [DescribeMaintenanceWindowTasks](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMParameterHistory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMParameterHistory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumera el historial de valores de un parámetro.**
```
Get-SSMParameterHistory -Name "Welcome"
```
**Salida:**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:55:25 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
Value : helloWorld
```
+ Para obtener más información sobre la API, consulte [GetParameterHistory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMParameterList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMParameterList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todos los parámetros.**
```
Get-SSMParameterList
```
**Salida:**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ Para obtener más información sobre la API, consulte [DescribeParameters](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMParameterValue`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMParameterValue`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran los valores de un parámetro.**
```
Get-SSMParameterValue -Name "Welcome"
```
**Salida:**
```
InvalidParameters Parameters
----------------- ----------
{} {Welcome}
```
**Ejemplo 2: en este ejemplo se enumeran los detalles del valor.**
```
(Get-SSMParameterValue -Name "Welcome").Parameters
```
**Salida:**
```
Name Type Value
---- ---- -----
Welcome String Good day, Sunshine!
```
+ Para obtener más información sobre la API, consulte [GetParameters](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran todas las líneas de base de revisiones.**
```
Get-SSMPatchBaseline
```
**Salida:**
```
BaselineDescription BaselineId BaselineName
------------------- ---------- ------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultP...
Baseline containing all updates approved for production systems pb-045f10b4f382baeda Production-B...
Baseline containing all updates approved for production systems pb-0a2f1059b670ebd31 Production-B...
```
**Ejemplo 2: En este ejemplo se enumeran todas las líneas base de los parches proporcionadas por. AWS La sintaxis utilizada en este ejemplo requiere la PowerShell versión 3 o posterior.**
```
$filter1 = @{Key="OWNER";Values=@("AWS")}
```
**Salida:**
```
Get-SSMPatchBaseline -Filter $filter1
```
**Ejemplo 3: en este ejemplo se enumeran todas las líneas de base de revisiones en las que usted es propietario. La sintaxis utilizada en este ejemplo requiere PowerShell la versión 3 o posterior.**
```
$filter1 = @{Key="OWNER";Values=@("Self")}
```
**Salida:**
```
Get-SSMPatchBaseline -Filter $filter1
```
**Ejemplo 4: Con la PowerShell versión 2, debe usar New-Object para crear cada etiqueta.**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "OWNER"
$filter1.Values = "AWS"
Get-SSMPatchBaseline -Filter $filter1
```
**Salida:**
```
BaselineDescription BaselineId BaselineName DefaultBaselin
e
------------------- ---------- ------------ --------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultPatchBaseline True
```
+ Para obtener más información sobre la API, consulte [DescribePatchBaselines Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Get-SSMPatchBaselineDetail`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMPatchBaselineDetail`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestran los detalles de una línea de base de revisiones.**
```
Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639"
```
**Salida:**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:02:19 PM
Name : Production-Baseline
PatchGroups : {}
RejectedPatches : {}
```
+ Para obtener más información sobre la API, consulte [GetPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMPatchBaselineForPatchGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMPatchBaselineForPatchGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se muestra la línea de base de revisiones para un grupo de revisiones.**
```
Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production"
```
**Salida:**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ Para obtener más información sobre la API, consulte [GetPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMPatchGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMPatchGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran los registros de los grupos de revisiones.**
```
Get-SSMPatchGroup
```
**Salida:**
```
BaselineIdentity PatchGroup
---------------- ----------
Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production
```
+ Para obtener más información sobre la API, consulte [DescribePatchGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMPatchGroupState`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMPatchGroupState`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtiene un resumen general de conformidad de las revisiones de un grupo de revisiones.**
```
Get-SSMPatchGroupState -PatchGroup "Production"
```
**Salida:**
```
Instances : 4
InstancesWithFailedPatches : 1
InstancesWithInstalledOtherPatches : 4
InstancesWithInstalledPatches : 3
InstancesWithMissingPatches : 0
InstancesWithNotApplicablePatches : 0
```
+ Para obtener más información sobre la API, consulte [DescribePatchGroupState](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-SSMResourceComplianceSummaryList`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMResourceComplianceSummaryList`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se obtiene un recuento resumido para cada recurso. En el resumen se incluye información sobre los estados conformes y no conformes y recuentos detallados de la gravedad de los elementos de conformidad de los productos que coinciden con “Windows10”. Como el valor MaxResult predeterminado es 100 si no se especifica el parámetro y este valor no es válido, se agrega el MaxResult parámetro y el valor se establece en 50.**
```
$FilterValues = @{
"Key"="Product"
"Type"="EQUAL"
"Values"="Windows10"
}
Get-SSMResourceComplianceSummaryList -Filter $FilterValues -MaxResult 50
```
+ Para obtener más información sobre la API, consulte [ListResourceComplianceSummaries Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Get-SSMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-SSMResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se enumeran las etiquetas de un periodo de mantenimiento.**
```
Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow"
```
**Salida:**
```
Key Value
--- -----
Stack Production
```
+ Para obtener más información sobre la API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SSMActivation`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMActivation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una instancia administrada.**
```
New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10
```
**Salida:**
```
ActivationCode ActivationId
-------------- ------------
KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363
```
+ Para obtener más información sobre la API, consulte [CreateActivation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SSMAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se asocia un documento de configuración a una instancia, mediante instance IDs.**
```
New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
**Salida:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Associated
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : Associated with AWS-UpdateSSMAgent
Status.AdditionalInfo :
```
**Ejemplo 2: en este ejemplo se asocia un documento de configuración a una instancia mediante destinos.**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $target
```
**Salida:**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**Ejemplo 3: en este ejemplo se asocia un documento de configuración a una instancia mediante destinos y parámetros.**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
$params = @{
"action"="configure"
"mode"="ec2"
"optionalConfigurationSource"="ssm"
"optionalConfigurationLocation"=""
"optionalRestart"="yes"
}
New-SSMAssociation -Name "Configure-CloudWatch" -AssociationName "CWConfiguration" -Target $target -Parameter $params
```
**Salida:**
```
Name : Configure-CloudWatch
InstanceId :
Date : 5/17/2018 3:17:44 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**Ejemplo 4: en este ejemplo se crea una asociación a todas las instancias de la región con `AWS-GatherSoftwareInventory`. También se proporcionan archivos personalizados y ubicaciones de registro en los parámetros que se van a recopilar**
```
$params = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$params["windowsRegistry"] ='[{"Path":"HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\MachineImage","Recursive":false,"ValueNames":["AMIName"]}]'
$params["files"] = '[{"Path":"C:\Program Files","Pattern":["*.exe"],"Recursive":true}, {"Path":"C:\ProgramData","Pattern":["*.log"],"Recursive":true}]'
New-SSMAssociation -AssociationName new-in-mum -Name AWS-GatherSoftwareInventory -Target @{Key="instanceids";Values="*"} -Parameter $params -region ap-south-1 -ScheduleExpression "rate(720 minutes)"
```
**Salida:**
```
Name : AWS-GatherSoftwareInventory
InstanceId :
Date : 6/9/2019 8:57:56 AM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ Para obtener más información sobre la API, consulte [CreateAssociation Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-SSMAssociationFromBatch`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMAssociationFromBatch`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se asocia un documento de configuración a varias instancias. El resultado devuelve una lista de operaciones correctas y con errores, si corresponde.**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
New-SSMAssociationFromBatch -Entry $option1,$option2
```
**Salida:**
```
Failed Successful
------ ----------
{} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...
```
**Ejemplo 2: en este ejemplo se muestran todos los detalles de una operación correcta.**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
(New-SSMAssociationFromBatch -Entry $option1,$option2).Successful
```
+ Para obtener más información sobre la API, consulte [CreateAssociationBatch](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SSMDocument`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMDocument`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un documento en su cuenta. El documento debe estar en formato JSON. Para obtener más información sobre cómo escribir un documento de configuración, consulte Configuration Document en la Referencia de la API de SSM.**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**Salida:**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ Para obtener más información sobre la API, consulte [CreateDocument](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SSMMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un nuevo periodo de mantenimiento con el nombre especificado que se ejecuta a las 16:00 h todos los martes durante 4 horas, con un límite de 1 hora y que permite la asignación de destinos no asociados.**
```
New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)"
```
**Salida:**
```
mw-03eb53e1ea7383998
```
+ Para obtener más información sobre la API, consulte [CreateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-SSMPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-SSMPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una línea de base de revisiones que aprueba las revisiones siete días después de que Microsoft las publique, para las instancias administradas que ejecutan Windows Server 2019 en un entorno de producción.**
```
$rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule
$rule.ApproveAfterDays = 7
$ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
$patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$patchFilter.Key="PRODUCT"
$patchFilter.Values="WindowsServer2019"
$severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$severityFilter.Key="MSRC_SEVERITY"
$severityFilter.Values.Add("Critical")
$severityFilter.Values.Add("Important")
$severityFilter.Values.Add("Moderate")
$classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$classificationFilter.Key = "CLASSIFICATION"
$classificationFilter.Values.Add( "SecurityUpdates" )
$classificationFilter.Values.Add( "Updates" )
$classificationFilter.Values.Add( "UpdateRollups" )
$classificationFilter.Values.Add( "CriticalUpdates" )
$ruleFilters.PatchFilters.Add($severityFilter)
$ruleFilters.PatchFilters.Add($classificationFilter)
$ruleFilters.PatchFilters.Add($patchFilter)
$rule.PatchFilterGroup = $ruleFilters
New-SSMPatchBaseline -Name "Production-Baseline-Windows2019" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule
```
**Salida:**
```
pb-0z4z6221c4296b23z
```
+ Para obtener más información sobre la API, consulte [CreatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-SSMDefaultPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-SSMDefaultPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se registra una línea de base de revisiones como la línea de base de revisiones predeterminada.**
```
Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639"
```
**Salida:**
```
pb-03da896ca3b68b639
```
+ Para obtener más información sobre la API, consulte [RegisterDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-SSMPatchBaselineForPatchGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-SSMPatchBaselineForPatchGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se registra una línea de base de revisiones para un grupo de revisiones.**
```
Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production"
```
**Salida:**
```
BaselineId PatchGroup
---------- ----------
pb-03da896ca3b68b639 Production
```
+ Para obtener más información sobre la API, consulte [RegisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-SSMTargetWithMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-SSMTargetWithMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se registra una instancia con un periodo de mantenimiento.**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**Salida:**
```
d8e47760-23ed-46a5-9f28-927337725398
```
**Ejemplo 2: en este ejemplo se registran varias instancias con un periodo de mantenimiento.**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**Salida:**
```
6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
**Ejemplo 3: en este ejemplo se registra una instancia con un periodo de mantenimiento mediante etiquetas de EC2.**
```
$option1 = @{Key="tag:Environment";Values=@("Production")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE"
```
**Salida:**
```
2994977e-aefb-4a71-beac-df620352f184
```
+ Para obtener más información sobre la API, consulte [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-SSMTaskWithMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-SSMTaskWithMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se registra una tarea con un periodo de mantenimiento mediante un ID de instancia. El resultado es el ID de la tarea.**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**Salida:**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**Ejemplo 2: en este ejemplo se registra una tarea con un periodo de mantenimiento mediante un ID de destino. El resultado es el ID de la tarea.**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**Salida:**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**Ejemplo 3: en este ejemplo se crea un objeto de parámetro para el documento de ejecución de comandos `AWS-RunPowerShellScript` y se crea una tarea con un periodo de mantenimiento determinado mediante el ID de destino. El resultado devuelto es el ID de la tarea.**
```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))
$props = @{
WindowId = "mw-0123e4cce56ff78ae"
ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
MaxConcurrency = 1
MaxError = 1
TaskType = "RUN_COMMAND"
TaskArn = "AWS-RunPowerShellScript"
Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
Priority = 1
RunCommand_Parameter = $parameters
Name = "set-via-cmdlet"
}
Register-SSMTaskWithMaintenanceWindow @props
```
**Salida:**
```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**Ejemplo 4: En este ejemplo se registra una tarea de automatización de AWS Systems Manager mediante un documento denominado`Create-Snapshots`.**
```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
-ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
-MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
-Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
-TaskType "AUTOMATION"`
-Priority 4`
-Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+ Para obtener más información sobre la API, consulte [RegisterTaskWithMaintenanceWindow Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Remove-SSMActivation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMActivation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina una activación. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"
```
+ Para obtener más información sobre la API, consulte [DeleteActivation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina la asociación entre una instancia y un documento. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
+ Para obtener más información sobre la API, consulte [DeleteAssociation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMDocument`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMDocument`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina un documento. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Remove-SSMDocument -Name "RunShellScript"
```
+ Para obtener más información sobre la API, consulte [DeleteDocument](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina un periodo de mantenimiento.**
```
Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145"
```
**Salida:**
```
mw-06d59c1a07c022145
```
+ Para obtener más información sobre la API, consulte [DeleteMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMParameter`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMParameter`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina un parámetro. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Remove-SSMParameter -Name "helloWorld"
```
+ Para obtener más información sobre la API, consulte [DeleteParameter](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina una línea de base de revisiones.**
```
Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda"
```
**Salida:**
```
pb-045f10b4f382baeda
```
+ Para obtener más información sobre la API, consulte [DeletePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-SSMResourceTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-SSMResourceTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina una etiqueta de un periodo de mantenimiento. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"
```
+ Para obtener más información sobre la API, consulte [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Send-SSMCommand`
En el siguiente ejemplo de código, se muestra cómo utilizar `Send-SSMCommand`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se ejecuta un comando echo en una instancia de destino.**
```
Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
```
**Salida:**
```
CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524
Comment :
CompletedCount : 0
DocumentName : AWS-RunPowerShellScript
ErrorCount : 0
ExpiresAfter : 3/7/2017 10:48:37 PM
InstanceIds : {}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 3/7/2017 9:48:37 PM
ServiceRole :
Status : Pending
StatusDetails : Pending
TargetCount : 0
Targets : {instanceids}
```
**Ejemplo 2: en este ejemplo se muestra cómo ejecutar un comando que acepte parámetros anidados.**
```
Send-SSMCommand -DocumentName "AWS-RunRemoteScript" -Parameter @{ sourceType="GitHub";sourceInfo='{"owner": "me","repository": "amazon-ssm","path": "Examples/Install-Win32OpenSSH"}'; "commandLine"=".\Install-Win32OpenSSH.ps1"} -InstanceId i-0cb2b964d3e14fd9f
```
+ Para obtener más información sobre la API, consulte [SendCommand](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-SSMAutomationExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-SSMAutomationExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se ejecuta un documento que especifica un rol de Automatización, un ID de origen de AMI y un rol de instancia de Amazon EC2.**
```
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
```
**Salida:**
```
3a532a4f-0382-11e7-9df7-6f11185f6dd1
```
+ Para obtener más información sobre la API, consulte [StartAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Start-SSMSession`
En el siguiente ejemplo de código, se muestra cómo utilizar `Start-SSMSession`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: este ejemplo inicia una conexión a un destino para una sesión de Session Manager, lo que habilita el reenvío de puertos. Nota: Debe agregar el parámetro de región si aún no lo ha configurado utilizando AWSCredentials.**
```
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' } -Region 'us-west-1'
```
**Salida:**
```
Starting session with SessionId: testUser-xi4glew849asyeryde34u4dfsdfy
Port 8080 opened for sessionId testUser-xi4glew849asyeryde34u4dfsdfy.
Waiting for connections...
```
**Ejemplo 2: este ejemplo crea una sesión interactiva con una instancia específica para una sesión del Session Manager.**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1'
```
**Salida:**
```
Starting session with SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Install the latest PowerShell for new features and improvements!
PS C:\Windows\system32> whoami
ec2amaz-fnsdrwv\ec2-test-user
PS C:\Windows\system32>
```
**Ejemplo 3: Este ejemplo crea una sesión sin conectarse a ella y devuelve las TokenValue propiedades SessionId StreamUrl, y necesarias para conectarse a la sesión.**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1' -DisablePluginInvocation
```
**Salida:**
```
SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
StreamUrl : {StreamUrl value redacted}
TokenValue : {Token value redacted}
ContentLength : 1207
HttpStatusCode : OK
```
+ Para obtener información sobre la API, consulte [StartSession Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Stop-SSMAutomationExecution`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-SSMAutomationExecution`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se detiene una ejecución de Automatización. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
+ Para obtener más información sobre la API, consulte [StopAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Stop-SSMCommand`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-SSMCommand`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se intenta cancelar un comando. No se obtienen resultados si la operación se ejecuta correctamente.**
```
Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"
```
+ Para obtener más información sobre la API, consulte [CancelCommand](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-SSMManagedInstance`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-SSMManagedInstance`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se anula el registro de una instancia administrada. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"
```
+ Para obtener más información sobre la API, consulte [DeregisterManagedInstance](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-SSMPatchBaselineForPatchGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-SSMPatchBaselineForPatchGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se anula el registro de un grupo de revisiones de una línea de base de revisiones.**
```
Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production"
```
**Salida:**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ Para obtener más información sobre la API, consulte [DeregisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-SSMTargetFromMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-SSMTargetFromMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina un destino de un periodo de mantenimiento.**
```
Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f"
```
**Salida:**
```
WindowId WindowTargetId
-------- --------------
mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
+ Para obtener más información sobre la API, consulte [DeregisterTargetFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Unregister-SSMTaskFromMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-SSMTaskFromMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se elimina una tarea de un periodo de mantenimiento.**
```
Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0"
```
**Salida:**
```
WindowId WindowTaskId
-------- ------------
mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
+ Para obtener más información sobre la API, consulte [DeregisterTaskFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-SSMAssociation`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMAssociation`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza una asociación con una nueva versión del documento.**
```
Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1"
```
**Salida:**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ Para obtener más información sobre la API, consulte [UpdateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-SSMAssociationStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMAssociationStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el estado de la asociación entre una instancia y un documento de configuración.**
```
Update-SSMAssociationStatus -Name "AWS-UpdateSSMAgent" -InstanceId "i-0000293ffd8c57862" -AssociationStatus_Date "2015-02-20T08:31:11Z" -AssociationStatus_Name "Pending" -AssociationStatus_Message "temporary_status_change" -AssociationStatus_AdditionalInfo "Additional-Config-Needed"
```
**Salida:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temporary_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ Para obtener más información sobre la API, consulte [UpdateAssociationStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-SSMDocument`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMDocument`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea una nueva versión de un documento con el contenido actualizado del archivo JSON que especifique. El documento debe estar en formato JSON. Puede obtener la versión del documento con el cmdlet «Get- SSMDocumentVersionList».**
```
Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json")
```
**Salida:**
```
CreatedDate : 3/1/2017 2:59:17 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 2
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 2
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Updating
```
+ Para obtener más información sobre la API, consulte la *referencia [UpdateDocument](https://docs.aws.amazon.com/powershell/v5/reference)de Herramientas de AWS para PowerShell cmdlets (V5*).
### `Update-SSMDocumentDefaultVersion`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMDocumentDefaultVersion`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza la versión predeterminada de un documento. Puede obtener las versiones de documentos disponibles con el cmdlet «Get- SSMDocumentVersionList».**
```
Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2"
```
**Salida:**
```
DefaultVersion Name
-------------- ----
2 RunShellScript
```
+ Para obtener más información sobre la API, consulte [UpdateDocumentDefaultVersion](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia del Herramientas de AWS para PowerShell cmdlet (V5*).
### `Update-SSMMaintenanceWindow`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMMaintenanceWindow`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el nombre de un periodo de mantenimiento.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW"
```
**Salida:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**Ejemplo 2: en este ejemplo se activa un periodo de mantenimiento.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true
```
**Salida:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**Ejemplo 3: en este ejemplo se desactiva un periodo de mantenimiento.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false
```
**Salida:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : False
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ Para obtener más información sobre la API, consulte [UpdateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-SSMManagedInstanceRole`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMManagedInstanceRole`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se actualiza el rol de una instancia administrada. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"
```
+ Para obtener más información sobre la API, consulte [UpdateManagedInstanceRole](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Update-SSMPatchBaseline`
En el siguiente ejemplo de código, se muestra cómo utilizar `Update-SSMPatchBaseline`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se agregan dos revisiones como rechazadas y una revisión como aprobada a una línea de base de revisiones existente.**
```
Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261"
```
**Salida:**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {KB2124261}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:22:10 PM
Name : Production-Baseline
RejectedPatches : {KB2032276, MS10-048}
```
+ Para obtener más información sobre la API, consulte [UpdatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-SSMComplianceItem`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-SSMComplianceItem`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se escribe un elemento de conformidad personalizado para la instancia administrada especificada**
```
$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new()
$item.Id = "07Jun2019-3"
$item.Severity="LOW"
$item.Status="COMPLIANT"
$item.Title="Fin-test-1 - custom"
Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
```
+ Para obtener más información sobre la API, consulte [PutComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-SSMInventory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-SSMInventory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se asigna información de ubicación de bastidores a una instancia. No se obtienen resultados si el comando se ejecuta correctamente.**
```
$data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]"
$data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F")
$items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]"
$items.Add($data)
$customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem
$customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z"
$customInventoryItem.Content = $items
$customInventoryItem.TypeName = "Custom:TestRackInfo2"
$customInventoryItem.SchemaVersion = "1.0"
$inventoryItems = @($customInventoryItem)
Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems
```
+ Para obtener más información sobre la API, consulte [PutInventory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Write-SSMParameter`
En el siguiente ejemplo de código, se muestra cómo utilizar `Write-SSMParameter`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se crea un parámetro. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"
```
**Ejemplo 2: en este ejemplo se modifica un parámetro. No se obtienen resultados si el comando se ejecuta correctamente.**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
```
+ Para obtener más información sobre la API, consulte [PutParameter](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# Ejemplos de Amazon Translate con Tools for PowerShell V5
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con Amazon Translate.
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `ConvertTo-TRNTargetLanguage`
En el siguiente ejemplo de código, se muestra cómo utilizar `ConvertTo-TRNTargetLanguage`.
**Herramientas para la versión PowerShell 5**
**Ejemplo 1: Convierte el texto en inglés especificado en francés. El texto que se va a convertir también se puede pasar como parámetro -Text.**
```
"Hello World" | ConvertTo-TRNTargetLanguage -SourceLanguageCode en -TargetLanguageCode fr
```
+ Para obtener más información sobre la API, consulte [TranslateText](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
# AWS WAFV2 ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. AWS WAFV2
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `New-WAF2WebACL`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-WAF2WebACL`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: Este comando crea una nueva ACL web denominada “waf-test”. Tenga en cuenta que, según la documentación de la API de servicio, DefaultAction «» es una propiedad obligatoria. Por lo tanto, se debe especificar el valor de '- DefaultAction and/or \$1Allow' '- DefaultAction \$1Block'. Como '- DefaultAction \$1Allow' y '- DefaultAction \$1Block' no son las propiedades obligatorias, el valor '@ \$1\$1 'podría usarse como marcador de posición, como se muestra en el ejemplo anterior.**
```
New-WAF2WebACL -Name "waf-test" -Scope REGIONAL -Region eu-west-1 -VisibilityConfig_CloudWatchMetricsEnabled $true -VisibilityConfig_SampledRequestsEnabled $true -VisibilityConfig_MetricName "waf-test" -Description "Test" -DefaultAction_Allow @{}
```
**Salida:**
```
ARN : arn:aws:wafv2:eu-west-1:139480602983:regional/webacl/waf-test/19460b3f-db14-4b9a-8e23-a417e1eb007f
Description : Test
Id : 19460b3f-db14-4b9a-8e23-a417e1eb007f
LockToken : 5a0cd5eb-d911-4341-b313-b429e6d6b6ab
Name : waf-test
```
+ *Para obtener más información sobre la API, consulte la referencia del cmdlet (V5 [CreateWebAcl](https://docs.aws.amazon.com/powershell/v5/reference)).Herramientas de AWS para PowerShell *
# WorkSpaces ejemplos de uso de Tools for V5 PowerShell
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso de la Herramientas de AWS para PowerShell V5 con. WorkSpaces
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.
**Topics**
+ [Acciones](#actions)
## Acciones
### `Approve-WKSIpRule`
En el siguiente ejemplo de código, se muestra cómo utilizar `Approve-WKSIpRule`.
**Herramientas para la PowerShell V5**
**Ejemplo 1: En este ejemplo se añaden reglas a un grupo de IP existente**
```
$Rule = @(
@{IPRule = "10.1.0.0/0"; RuleDesc = "First Rule Added"},
@{IPRule = "10.2.0.0/0"; RuleDesc = "Second Rule Added"}
)
Approve-WKSIpRule -GroupId wsipg-abcnx2fcw -UserRule $Rule
```
+ Para obtener más información sobre la API, consulte [AuthorizeIpRules](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Copy-WKSWorkspaceImage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Copy-WKSWorkspaceImage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: en este ejemplo se copia la imagen del espacio de trabajo con el identificador especificado de us-west-2 a la región actual con el nombre "» CopiedImageTest**
```
Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6
```
**Salida:**
```
wsi-456abaqfe
```
+ Para obtener más información sobre la API, consulte [CopyWorkspaceImage Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference* (V5).
### `Edit-WKSClientProperty`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSClientProperty`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Este ejemplo permite la reconexión del cliente de Workspaces.**
```
Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369
```
+ Para obtener más información sobre la API, consulte [ModifyClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-WKSSelfServicePermission`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSSelfServicePermission`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se habilitan los permisos de autoservicio para cambiar el tipo de computación y aumentar el tamaño del volumen del directorio especificado.**
```
Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED
```
+ Para obtener más información sobre la API, consulte [ModifySelfservicePermissions](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-WKSWorkspaceAccessProperty`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSWorkspaceAccessProperty`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se permite el acceso a la instancia de WorkSpaces en Android y Chrome OS para el directorio especificado.**
```
Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceAccessProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-WKSWorkspaceCreationProperty`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSWorkspaceCreationProperty`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se establece el acceso a Internet y el modo de mantenimiento en true como valores predeterminados al crear un espacio de trabajo**.
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-WKSWorkspaceProperty`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSWorkspaceProperty`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia la propiedad del modo de ejecución del espacio de trabajo a Parada automática para el espacio de trabajo especificado**.
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Edit-WKSWorkspaceState`
En el siguiente ejemplo de código, se muestra cómo utilizar `Edit-WKSWorkspaceState`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el estado del espacio de trabajo especificado a Disponible**.
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSClientProperty`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSClientProperty`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen las propiedades de cliente del cliente de WorkSpaces para el directorio especificado.**
```
Get-WKSClientProperty -ResourceId d-223562a123
```
+ Para obtener más información sobre la API, consulte [DescribeClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSIpGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSIpGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los detalles del grupo de IP especificado en la región especificada.**
```
Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45
```
**Salida:**
```
GroupDesc GroupId GroupName UserRules
--------- ------- --------- ---------
wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}
```
+ Para obtener más información sobre la API, consulte [DescribeIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se busca la etiqueta del espacio de trabajo especificado**.
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Salida:**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obtener más información sobre la API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recupera los detalles de todos los que llevas WorkSpaces a la canalización.**
```
Get-WKSWorkspace
```
**Salida:**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de `WorkSpaceProperties` para un espacio de trabajo de la región `us-west-2`. Para obtener más información sobre las propiedades secundarias de`WorkSpaceProperties`, consulte https://docs.aws.amazon.com/workspaces/ latest/api/API \$1 WorkspaceProperties .html.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**Salida:**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Ejemplo 3: Este comando muestra el valor de la propiedad secundaria `RootVolumeSizeGib` de `WorkSpaceProperties` para un espacio de trabajo en la región `us-west-2`. El tamaño del volumen de la raíz, en GiB, es 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Salida:**
```
80
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Get-WKSWorkspaceBundle`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspaceBundle`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los detalles de todas las agrupaciones del espacio de trabajo de la región actual**.
```
Get-WKSWorkspaceBundle
```
**Salida:**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSWorkspaceDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspaceDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los detalles de directorio de los directorios registrados**.
```
Get-WKSWorkspaceDirectory
```
**Salida:**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSWorkspaceImage`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspaceImage`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los detalles de todas las imágenes de la región**.
```
Get-WKSWorkspaceImage
```
**Salida:**
```
Description :This image is copied from another image
ErrorCode :
ErrorMessage :
ImageId : wsi-345ahdjgo
Name : CopiedImageTest
OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem
RequiredTenancy : DEFAULT
State : AVAILABLE
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceImages](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSWorkspaceSnapshot`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspaceSnapshot`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestra la marca de tiempo de la instantánea más reciente creada para la instancia de WorkSpaces especificada.**
```
Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v
```
**Salida:**
```
RebuildSnapshots RestoreSnapshots
---------------- ----------------
{Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Get-WKSWorkspacesConnectionStatus`
En el siguiente ejemplo de código, se muestra cómo utilizar `Get-WKSWorkspacesConnectionStatus`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene el estado de la conexión del espacio de trabajo especificado.**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-WKSIpGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-WKSIpGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se crea un grupo de IP vacío denominado FreshEmptyIpGroup**
```
New-WKSIpGroup -GroupName "FreshNewIPGroup"
```
**Salida:**
```
wsipg-w45rty4ty
```
+ Para obtener información sobre la API, consulte [CreateIpGroup Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `New-WKSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-WKSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade una etiqueta nueva a un espacio de trabajo denominado `ws-wsname`. La etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**Ejemplo 2: En este ejemplo se añaden varias etiquetas a un espacio de trabajo denominado `ws-wsname`. Una etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`; la otra etiqueta tiene la clave de etiqueta “Stage” y el valor de clave “Test”.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ Para obtener más información sobre la API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `New-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `New-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: cree un WorkSpace para el paquete, el directorio y el usuario proporcionados.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Ejemplo 2: En este ejemplo se crean varios WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obtener más información sobre la API, consulte [CreateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Register-WKSIpGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-WKSIpGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra el grupo de direcciones IP especificado en el directorio especificado.**
```
Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
```
+ Para obtener más información sobre la API, consulte [AssociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Register-WKSWorkspaceDirectory`
En el siguiente ejemplo de código, se muestra cómo utilizar `Register-WKSWorkspaceDirectory`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra el directorio especificado para Workspaces Service**.
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obtener más información sobre la API, consulte [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-WKSIpGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-WKSIpGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina el grupo de direcciones IP especificado**.
```
Remove-WKSIpGroup -GroupId wsipg-32fhgtred
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSIpGroup (DeleteIpGroup)" on target "wsipg-32fhgtred".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteIpGroup](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-WKSTag`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-WKSTag`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta asociada a la instancia de WorkSpaces**.
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
### `Remove-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `Remove-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Termina varios WorkSpaces. El uso del modificador -Force impide que el cmdlet solicite confirmación.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Remove-WKSWorkspace, finalizando todos los. WorkSpaces El cmdlet avisará antes de que finalice cada uno de ellos. WorkSpace Añada el modificador -Force para suprimir la solicitud de confirmación.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Ejemplo 3: en este ejemplo se muestra cómo pasar los TerminateRequest objetos que definen lo que se va WorkSpaces a terminar. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [TerminateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Reset-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `Reset-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Reconstruye lo especificado. WorkSpace**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los IDs canaliza al WorkSpaceId parámetro de restablecimientoWKSWorkspace, lo que provoca su WorkSpaces reconstrucción.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte [RebuildWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
### `Restart-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `Restart-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Reinicia lo especificado. WorkSpace**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: Reinicia varios. WorkSpaces**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Ejemplo 3: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Restart-WKSWorkspace, lo que provoca que se WorkSpaces reinicie.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
### `Stop-WKSWorkspace`
En el siguiente ejemplo de código, se muestra cómo utilizar `Stop-WKSWorkspace`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Detiene varios WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Ejemplo 2: recupera la colección de todos sus datos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro Stop, WKSWorkspace lo que provoca WorkSpaces que se detenga.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Ejemplo 3: En este ejemplo se muestra cómo pasar StopRequest los objetos que definen lo WorkSpaces que se debe detener.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [StopWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
### `Unregister-WKSIpGroup`
En el siguiente ejemplo de código, se muestra cómo utilizar `Unregister-WKSIpGroup`.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se anula el registro del grupo de direcciones IP especificado en el directorio especificado.**
```
Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123
```
+ Para obtener más información sobre la API, consulte [DisassociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).