A versão 5 (V5) do Ferramentas da AWS para PowerShell foi lançada\$1
Para obter informações sobre mudanças significativas e migrar seus aplicativos, consulte o [tópico de migração](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html).
[https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html)
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Ferramentas para exemplos de código PowerShell V5
Os exemplos de código neste tópico mostram como usar o Ferramentas da AWS para PowerShell V5 com AWS.
As *noções básicas* são exemplos de código que mostram como realizar as operações essenciais em um serviço.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
*Cenários* são exemplos de código que mostram como realizar tarefas específicas chamando várias funções dentro de um serviço ou combinadas com outros Serviços da AWS.
Alguns serviços contêm categorias de exemplo adicionais que mostram como utilizar bibliotecas ou funções específicas do serviço.
**Topics**
+ [ACM](powershell_acm_code_examples.md)
+ [Application Auto Scaling](powershell_application-auto-scaling_code_examples.md)
+ [WorkSpaces Aplicações](powershell_appstream_code_examples.md)
+ [Aurora](powershell_aurora_code_examples.md)
+ [ajuste de escala automático](powershell_auto-scaling_code_examples.md)
+ [AWS Budgets](powershell_budgets_code_examples.md)
+ [AWS Cloud9](powershell_cloud9_code_examples.md)
+ [CloudFormation](powershell_cloudformation_code_examples.md)
+ [CloudFront](powershell_cloudfront_code_examples.md)
+ [CloudTrail](powershell_cloudtrail_code_examples.md)
+ [CloudWatch](powershell_cloudwatch_code_examples.md)
+ [CodeCommit](powershell_codecommit_code_examples.md)
+ [CodeDeploy](powershell_codedeploy_code_examples.md)
+ [CodePipeline](powershell_codepipeline_code_examples.md)
+ [Identidade do Amazon Cognito](powershell_cognito-identity_code_examples.md)
+ [AWS Config](powershell_config-service_code_examples.md)
+ [Device Farm](powershell_device-farm_code_examples.md)
+ [Directory Service](powershell_directory-service_code_examples.md)
+ [AWS DMS](powershell_database-migration-service_code_examples.md)
+ [DynamoDB](powershell_dynamodb_code_examples.md)
+ [Amazon EC2](powershell_ec2_code_examples.md)
+ [Amazon ECR](powershell_ecr_code_examples.md)
+ [Amazon ECS](powershell_ecs_code_examples.md)
+ [Amazon EFS](powershell_efs_code_examples.md)
+ [Amazon EKS](powershell_eks_code_examples.md)
+ [Elastic Load Balancing Versão 1](powershell_elastic-load-balancing_code_examples.md)
+ [Elastic Load Balancing Versão 2](powershell_elastic-load-balancing-v2_code_examples.md)
+ [Amazon FSx](powershell_fsx_code_examples.md)
+ [Amazon Glacier](powershell_glacier_code_examples.md)
+ [AWS Glue](powershell_glue_code_examples.md)
+ [AWS Health](powershell_health_code_examples.md)
+ [IAM](powershell_iam_code_examples.md)
+ [Kinesis](powershell_kinesis_code_examples.md)
+ [Lambda](powershell_lambda_code_examples.md)
+ [Amazon ML](powershell_machine-learning_code_examples.md)
+ [Macie](powershell_macie2_code_examples.md)
+ [AWS Price List](powershell_pricing_code_examples.md)
+ [Resource Groups (Grupos de recursos)](powershell_resource-groups_code_examples.md)
+ [Resource Groups Tagging API](powershell_resource-groups-tagging-api_code_examples.md)
+ [Route 53](powershell_route-53_code_examples.md)
+ [Amazon S3](powershell_s3_code_examples.md)
+ [CSPM do Security Hub](powershell_securityhub_code_examples.md)
+ [Amazon SES](powershell_ses_code_examples.md)
+ [API v2 do Amazon SES](powershell_sesv2_code_examples.md)
+ [Amazon SNS](powershell_sns_code_examples.md)
+ [Amazon SQS](powershell_sqs_code_examples.md)
+ [AWS STS](powershell_sts_code_examples.md)
+ [Suporte](powershell_support_code_examples.md)
+ [Systems Manager](powershell_ssm_code_examples.md)
+ [Amazon Translate](powershell_translate_code_examples.md)
+ [AWS WAFV2](powershell_wafv2_code_examples.md)
+ [WorkSpaces](powershell_workspaces_code_examples.md)
# Exemplos de ACM usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o ACM.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-ACMCertificate`
O código de exemplo a seguir mostra como usar `Get-ACMCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra como retornar um certificado e sua cadeia usando o ARN do certificado.**
```
Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Para obter detalhes da API, consulte [GetCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ACMCertificateDetail`
O código de exemplo a seguir mostra como usar `Get-ACMCertificateDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna detalhes do certificado especificado.**
```
Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ACMCertificateList`
O código de exemplo a seguir mostra como usar `Get-ACMCertificateList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera uma lista de todos os seus certificados ARNs e o nome de domínio de cada um. O cmdlet paginará automaticamente para recuperar todos os. ARNs Para controlar manualmente a paginação, use o MaxItem parâmetro - para controlar quantos certificados ARNs são retornados para cada chamada de serviço e o NextToken parâmetro - para indicar o ponto de partida de cada chamada.**
```
Get-ACMCertificateList
```
**Saída**:
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com
```
**Exemplo 2: Recupera uma lista de todos os seus certificados ARNs em que o status do certificado corresponde aos estados fornecidos.**
```
Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"
```
**Exemplo 3: esse exemplo retorna uma lista de todos os certificados na região us-east-1 que têm um tipo de chave RSA\$12048 e um uso estendido da chave, ou uma finalidade, de CODE\$1SIGNING. Você pode encontrar os valores desses parâmetros de filtragem no tópico de referência da 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
```
**Saída**:
```
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 obter detalhes da API, consulte [ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ACMCertificate`
O código de exemplo a seguir mostra como usar `New-ACMCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um certificado. O serviço retorna o ARN do novo certificado.**
```
New-ACMCertificate -DomainName "www.example.com"
```
**Saída**:
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
**Exemplo 2: cria um certificado. O serviço retorna o ARN do novo certificado.**
```
New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"
```
**Saída**:
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
+ Para obter detalhes da API, consulte [RequestCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ACMCertificate`
O código de exemplo a seguir mostra como usar `Remove-ACMCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o certificado identificado pelo ARN fornecido e pela chave privada associada. O cmdlet solicitará confirmação antes de prosseguir. Adicione a opção -Force para ignorar a confirmação.**
```
Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ Para obter detalhes da API, consulte [DeleteCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Send-ACMValidationEmail`
O código de exemplo a seguir mostra como usar `Send-ACMValidationEmail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: solicita que o e-mail para validar a propriedade do domínio para “www.example.com” seja enviado. Se o \$1 do seu shell ConfirmPreference estiver definido como 'Médio' ou inferior, o cmdlet solicitará a confirmação antes de continuar. Adicione a opção -Force para ignorar as solicitações de confirmação.**
```
$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 obter detalhes da API, consulte [ResendValidationEmail](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Application Auto Scaling usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Application Auto Scaling.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-AASScalableTarget`
O código de exemplo a seguir mostra como usar `Add-AASScalableTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet registra ou atualiza um destino escalável. Um destino escalável é um recurso cuja escala pode ser aumentada ou reduzida horizontalmente pelo Application Auto Scaling.**
```
Add-AASScalableTarget -ServiceNamespace AppStream -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -MinCapacity 2 -MaxCapacity 10
```
+ Para obter detalhes da API, consulte [RegisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-AASScalableTarget`
O código de exemplo a seguir mostra como usar `Get-AASScalableTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo fornecerá informações sobre os destinos escaláveis do Application Auto Scaling no namespace especificado.**
```
Get-AASScalableTarget -ServiceNamespace "AppStream"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeScalableTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-AASScalingActivity`
O código de exemplo a seguir mostra como usar `Get-AASScalingActivity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: fornece informações descritivas sobre as atividades de escalabilidade no namespace especificado das últimas seis semanas.**
```
Get-AASScalingActivity -ServiceNamespace AppStream
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-AASScalingPolicy`
O código de exemplo a seguir mostra como usar `Get-AASScalingPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet descreve as políticas de escalabilidade do Application Auto Scaling para o namespace de serviço especificado.**
```
Get-AASScalingPolicy -ServiceNamespace AppStream
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeScalingPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-AASScheduledAction`
O código de exemplo a seguir mostra como usar `Get-AASScheduledAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet lista as ações programadas para o grupo do Auto Scaling que ainda não foram executadas ou que ainda não atingiram o horário de término.**
```
Get-AASScheduledAction -ServiceNamespace AppStream
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-AASScalableTarget`
O código de exemplo a seguir mostra como usar `Remove-AASScalableTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet cancela o registro de um destino escalável do Application Auto Scaling. O cancelamento do registro de um destino escalável exclui as políticas de escalabilidade associadas a ele.**
```
Remove-AASScalableTarget -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -ServiceNamespace AppStream
```
**Saída**:
```
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 obter detalhes da API, consulte [DeregisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-AASScalingPolicy`
O código de exemplo a seguir mostra como usar `Remove-AASScalingPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui a política de escalabilidade especificada para um destino escalável do Application Auto Scaling.**
```
Remove-AASScalingPolicy -ServiceNamespace AppStream -PolicyName "default-scale-out" -ResourceId fleet/Test -ScalableDimension appstream:fleet:DesiredCapacity
```
+ Para obter detalhes da API, consulte [DeleteScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-AASScheduledAction`
O código de exemplo a seguir mostra como usar `Remove-AASScheduledAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui a ação programada especificada para um destino escalável do Application Auto Scaling.**
```
Remove-AASScheduledAction -ServiceNamespace AppStream -ScheduledActionName WeekDaysFleetScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-AASScalingPolicy`
O código de exemplo a seguir mostra como usar `Set-AASScalingPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet cria ou atualiza uma política para um destino escalável do Application Auto Scaling. Cada destino escalável é identificado por um namespace de serviço, ID de recurso e dimensão escalável.**
```
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}
```
**Saída**:
```
Alarms PolicyARN
------ ---------
{} arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
```
+ Para obter detalhes da API, consulte [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-AASScheduledAction`
O código de exemplo a seguir mostra como usar `Set-AASScheduledAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet cria ou atualiza uma ação programada para um destino escalável do Application Auto Scaling. Cada destino escalável é identificado por um namespace de serviço, ID de recurso e dimensão escalável.**
```
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 obter detalhes da API, consulte [PutScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# WorkSpaces Exemplos de aplicativos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com WorkSpaces aplicativos.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-APSResourceTag`
O código de exemplo a seguir mostra como usar `Add-APSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona uma tag de recurso ao AppStream recurso**
```
Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^Tag
```
**Saída**:
```
Name Value
---- -----
StackState Test
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Copy-APSImage`
O código de exemplo a seguir mostra como usar `Copy-APSImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra copia uma imagem para outra região**
```
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell
```
**Saída**:
```
TestImageCopy
```
+ Para obter detalhes da API, consulte [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-APSUSer`
O código de exemplo a seguir mostra como usar `Disable-APSUSer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra desativa um usuário em USERPOOL**
```
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obter detalhes da API, consulte [DisableUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-APSUser`
O código de exemplo a seguir mostra como usar `Enable-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra ativa um usuário desativado em USERPOOL**
```
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ Para obter detalhes da API, consulte [EnableUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSAssociatedFleetList`
O código de exemplo a seguir mostra como usar `Get-APSAssociatedFleetList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a frota associada a uma pilha**
```
Get-APSAssociatedFleetList -StackName PowershellStack
```
**Saída**:
```
PowershellFleet
```
+ Para obter detalhes da API, consulte [ListAssociatedFleets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSAssociatedStackList`
O código de exemplo a seguir mostra como usar `Get-APSAssociatedStackList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a frota associada a uma frota**
```
Get-APSAssociatedStackList -FleetName PowershellFleet
```
**Saída**:
```
PowershellStack
```
+ Para obter detalhes da API, consulte [ListAssociatedStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSDirectoryConfigList`
O código de exemplo a seguir mostra como usar `Get-APSDirectoryConfigList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe as configurações de diretório criadas em AppStream**
```
Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTime
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeDirectoryConfigs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSFleetList`
O código de exemplo a seguir mostra como usar `Get-APSFleetList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe detalhes de uma frota**
```
Get-APSFleetList -Name Test
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeFleets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImageBuilderList`
O código de exemplo a seguir mostra como usar `Get-APSImageBuilderList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra exibe detalhes de um ImageBuilder**
```
Get-APSImageBuilderList -Name TestImage
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeImageBuilders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImageList`
O código de exemplo a seguir mostra como usar `Get-APSImageList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe AppStream imagens privadas**
```
Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arn
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSImagePermission`
O código de exemplo a seguir mostra como usar `Get-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe permissões de imagem em uma AppStream imagem compartilhada**
```
Get-APSImagePermission -Name Powershell | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}
```
**Saída**:
```
SharedAccountId AllowFleet AllowImageBuilder
--------------- ---------- -----------------
123456789012 True True
```
+ Para obter detalhes da API, consulte [DescribeImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSSessionList`
O código de exemplo a seguir mostra como usar `Get-APSSessionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de sessões de uma frota**
```
Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStack
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSessions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSStackList`
O código de exemplo a seguir mostra como usar `Get-APSStackList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe uma lista de AppStream pilhas**
```
Get-APSStackList | Select DisplayName, Arn, CreatedTime
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSTagsForResourceList`
O código de exemplo a seguir mostra como usar `Get-APSTagsForResourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe tags em um AppStream recurso**
```
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest
```
**Saída**:
```
Key Value
--- -----
StackState Test
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `Get-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exibe detalhes AppStreamUsageReport de configuração**
```
Get-APSUsageReportSubscription
```
**Saída**:
```
LastGeneratedReportDate S3BucketName Schedule SubscriptionErrors
----------------------- ------------ -------- ------------------
1/1/0001 12:00:00 AM appstream-logs-us-east-1-123456789012-sik1hnxe DAILY {}
```
+ Para obter detalhes da API, consulte [DescribeUsageReportSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUser`
O código de exemplo a seguir mostra como usar `Get-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de usuários com status ativado**
```
Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, Enabled
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeUsers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-APSUserStackAssociation`
O código de exemplo a seguir mostra como usar `Get-APSUserStackAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe a lista de usuários atribuídos a uma pilha**
```
Get-APSUserStackAssociation -StackName PowershellStack
```
**Saída**:
```
AuthenticationType SendEmailNotification StackName UserName
------------------ --------------------- --------- --------
USERPOOL False PowershellStack TestUser1@lab.com
USERPOOL False PowershellStack TestUser2@lab.com
```
+ Para obter detalhes da API, consulte [DescribeUserStackAssociations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `New-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo cria uma configuração de diretório no AppStream**
```
New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSFleet`
O código de exemplo a seguir mostra como usar `New-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova AppStream frota**
```
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
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSImageBuilder`
O código de exemplo a seguir mostra como usar `New-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um Image Builder em 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
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSImageBuilderStreamingURL`
O código de exemplo a seguir mostra como usar `New-APSImageBuilderStreamingURL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um URL ImageBuilder de streaming com validade de 2 horas**
```
New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2
```
**Saída**:
```
Expires StreamingURL
------- ------------
12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F
```
+ Para obter detalhes da API, consulte [CreateImageBuilderStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência do Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `New-APSStack`
O código de exemplo a seguir mostra como usar `New-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova AppStream pilha**
```
New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSStreamingURL`
O código de exemplo a seguir mostra como usar `New-APSStreamingURL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cria um URL de streaming da pilha**
```
New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUser
```
**Saída**:
```
Expires StreamingURL
------- ------------
12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2
```
+ Para obter detalhes da API, consulte [CreateStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência do Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `New-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `New-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo habilita relatórios AppStream de uso**
```
New-APSUsageReportSubscription
```
**Saída**:
```
S3BucketName Schedule
------------ --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
```
+ Para obter detalhes da API, consulte [CreateUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-APSUser`
O código de exemplo a seguir mostra como usar `New-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cria um usuário em USERPOOL**
```
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName
```
**Saída**:
```
Test@lab.com
```
+ Para obter detalhes da API, consulte [CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-APSFleet`
O código de exemplo a seguir mostra como usar `Register-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra registra a frota com uma pilha**
```
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obter detalhes da API, consulte [AssociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-APSUserStackBatch`
O código de exemplo a seguir mostra como usar `Register-APSUserStackBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atribui a pilha a um usuário em USERPOOL**
```
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obter detalhes da API, consulte [BatchAssociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `Remove-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove a configuração AppStream do diretório**
```
Remove-APSDirectoryConfig -DirectoryName contoso.com
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSFleet`
O código de exemplo a seguir mostra como usar `Remove-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove e exclui uma frota AppStream **
```
Remove-APSFleet -Name TestFleet -Region us-west-2
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImage`
O código de exemplo a seguir mostra como usar `Remove-APSImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui uma imagem**
```
Remove-APSImage -Name TestImage -Region us-west-2
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Remove-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui um ImageBuilder**
```
Remove-APSImageBuilder -Name TestIB -Region us-west-2
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSImagePermission`
O código de exemplo a seguir mostra como usar `Remove-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra remove as permissões de uma imagem**
```
Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSResourceTag`
O código de exemplo a seguir mostra como usar `Remove-APSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove uma tag de recurso do AppStream recurso**
```
Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackState
```
**Saída**:
```
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 obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSStack`
O código de exemplo a seguir mostra como usar `Remove-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui uma pilha**
```
Remove-APSStack -Name TestStack -Region us-west-2
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSUsageReportSubscription`
O código de exemplo a seguir mostra como usar `Remove-APSUsageReportSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo desativa a assinatura do Relatório AppStream de Uso**
```
Remove-APSUsageReportSubscription
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-APSUser`
O código de exemplo a seguir mostra como usar `Remove-APSUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exclui um usuário de USERPOOL**
```
Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOL
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Revoke-APSSession`
O código de exemplo a seguir mostra como usar `Revoke-APSSession`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo revoga uma sessão para a frota AppStream **
```
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
```
+ Para obter detalhes da API, consulte [ExpireSession](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-APSFleet`
O código de exemplo a seguir mostra como usar `Start-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra inicia uma frota**
```
Start-APSFleet -Name PowershellFleet
```
+ Para obter detalhes da API, consulte [StartFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Start-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra inicia um ImageBuilder**
```
Start-APSImageBuilder -Name TestImage
```
**Saída**:
```
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 obter detalhes da API, consulte [StartImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-APSFleet`
O código de exemplo a seguir mostra como usar `Stop-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra interrompe uma frota**
```
Stop-APSFleet -Name PowershellFleet
```
+ Para obter detalhes da API, consulte [StopFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-APSImageBuilder`
O código de exemplo a seguir mostra como usar `Stop-APSImageBuilder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esta amostra interrompe um ImageBuilder**
```
Stop-APSImageBuilder -Name TestImage
```
**Saída**:
```
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 obter detalhes da API, consulte [StopImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-APSFleet`
O código de exemplo a seguir mostra como usar `Unregister-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cancela o registro de uma frota da pilha**
```
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ Para obter detalhes da API, consulte [DisassociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-APSUserStackBatch`
O código de exemplo a seguir mostra como usar `Unregister-APSUserStackBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra remove um usuário de uma pilha atribuída**
```
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ Para obter detalhes da API, consulte [BatchDisassociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSDirectoryConfig`
O código de exemplo a seguir mostra como usar `Update-APSDirectoryConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza a configuração do diretório criada no AppStream**
```
Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSFleet`
O código de exemplo a seguir mostra como usar `Update-APSFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atualiza as propriedades de uma frota**
```
Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSImagePermission`
O código de exemplo a seguir mostra como usar `Update-APSImagePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esta amostra compartilha uma AppStream imagem com outra conta**
```
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
```
+ Para obter detalhes da API, consulte [UpdateImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-APSStack`
O código de exemplo a seguir mostra como usar `Update-APSStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra atualiza (ativa) a persistência das configurações do aplicativo e as pastas pessoais em uma pilha**
```
Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Aurora usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Aurora.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-RDSOrderableDBInstanceOption`
O código de exemplo a seguir mostra como usar `Get-RDSOrderableDBInstanceOption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo lista as versões do mecanismo de banco de dados compatíveis com uma classe de instância de banco de dados em uma Região da AWS.**
```
$params = @{
Engine = 'aurora-postgresql'
DBInstanceClass = 'db.r5.large'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
**Exemplo 2: este exemplo lista as classes de instância de bancos de dados compatíveis com uma versão específica do mecanismo de banco de dados em uma Região da AWS.**
```
$params = @{
Engine = 'aurora-postgresql'
EngineVersion = '13.6'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
+ Para obter detalhes da API, consulte [DescribeOrderableDBInstanceOpções](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de Ferramentas da AWS para PowerShell Cmdlet (V5)*.
# Exemplos de Auto Scaling usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Auto Scaling.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-ASLoadBalancer`
O código de exemplo a seguir mostra como usar `Add-ASLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo anexa o Balanceador de Carga especificado ao grupo do Auto Scaling especificado.**
```
Add-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [AttachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Complete-ASLifecycleAction`
O código de exemplo a seguir mostra como usar `Complete-ASLifecycleAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo conclui a ação de ciclo de vida especificada.**
```
Complete-ASLifecycleAction -LifecycleHookName myLifecycleHook -AutoScalingGroupName my-asg -LifecycleActionResult CONTINUE -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ Para obter detalhes da API, consulte [CompleteLifecycleAction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-ASMetricsCollection`
O código de exemplo a seguir mostra como usar `Disable-ASMetricsCollection`.
**Ferramentas para PowerShell V5**
**Example 1: Desativa o monitoramento de métricas especificadas para o grupo de Auto Scaling.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg -Metric @("GroupMinSize", "GroupMaxSize")
```
**Exemplo 2: Esse exemplo desativa o monitoramento de todas as métricas do grupo do Auto Scaling especificado.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [DisableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-ASInstance`
O código de exemplo a seguir mostra como usar `Dismount-ASInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo desvincula a instância especificada do grupo do Auto Scaling especificado e diminui a capacidade desejada para que o Auto Scaling não inicie uma instância substituta.**
```
Dismount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Saída**:
```
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 :
```
**Exemplo 2: Este exemplo desvincula a instância especificada do grupo de Auto Scaling especificado sem diminuir a capacidade desejada. O Auto Scaling inicia uma nova instância de substituição.**
```
Dismount-ASInstance -InstanceId i-7bf746a2 -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Saída**:
```
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 obter detalhes da API, consulte [DetachInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-ASLoadBalancer`
O código de exemplo a seguir mostra como usar `Dismount-ASLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo desvincula o balanceador de carga especificado do grupo de Auto Scaling especificado.**
```
Dismount-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [DetachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-ASMetricsCollection`
O código de exemplo a seguir mostra como usar `Enable-ASMetricsCollection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Ativa o monitoramento de métricas especificadas para o grupo de Auto Scaling.**
```
Enable-ASMetricsCollection -Metric @("GroupMinSize", "GroupMaxSize") -AutoScalingGroupName my-asg -Granularity 1Minute
```
**Exemplo 2: Este exemplo permite o monitoramento de todas as métricas do grupo do Auto Scaling especificado.**
```
Enable-ASMetricsCollection -AutoScalingGroupName my-asg -Granularity 1Minute
```
+ Para obter detalhes da API, consulte [EnableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enter-ASStandby`
O código de exemplo a seguir mostra como usar `Enter-ASStandby`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo coloca a instância especificada em modo de espera e diminui a capacidade desejada para que o Auto Scaling não inicie uma instância substituta.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Saída**:
```
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 :
```
**Exemplo 2: Este exemplo coloca a instância especificada em modo de espera sem diminuir a capacidade desejada. O Auto Scaling inicia uma nova instância de substituição.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Saída**:
```
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 obter detalhes da API, consulte [EnterStandby](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Exit-ASStandby`
O código de exemplo a seguir mostra como usar `Exit-ASStandby`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo tira as instâncias especificadas do modo de espera.**
```
Exit-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
**Saída**:
```
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 obter detalhes da API, consulte [ExitStandby](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAccountLimit`
O código de exemplo a seguir mostra como usar `Get-ASAccountLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve os limites de recursos do Auto Scaling para sua AWS conta.**
```
Get-ASAccountLimit
```
**Saída**:
```
MaxNumberOfAutoScalingGroups : 20
MaxNumberOfLaunchConfigurations : 100
```
+ Para obter detalhes da API, consulte [DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAdjustmentType`
O código de exemplo a seguir mostra como usar `Get-ASAdjustmentType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve os tipos de ajuste que são compatíveis com o Auto Scaling.**
```
Get-ASAdjustmentType
```
**Saída**:
```
Type
----
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
```
+ Para obter detalhes da API, consulte [DescribeAdjustmentTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAutoScalingGroup`
O código de exemplo a seguir mostra como usar `Get-ASAutoScalingGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os nomes de seus grupos do Auto Scaling.**
```
Get-ASAutoScalingGroup | format-table -property AutoScalingGroupName
```
**Saída**:
```
AutoScalingGroupName
--------------------
my-asg-1
my-asg-2
my-asg-3
my-asg-4
my-asg-5
my-asg-6
```
**Exemplo 2: Este exemplo descreve o grupo do Auto Scaling especificado.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1
```
**Saída**:
```
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
```
**Exemplo 3: Este exemplo descreve os grupos do Auto Scaling especificados.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName @("my-asg-1", "my-asg-2")
```
**Exemplo 4: Este exemplo descreve as instâncias do Auto Scaling do grupo do Auto Scaling especificado.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1).Instances
```
**Exemplo 5: Este exemplo descreve todos os seus grupos do Auto Scaling.**
```
Get-ASAutoScalingGroup
```
**Exemplo 6: Este LaunchTemplate exemplo descreve o grupo de Auto Scaling especificado. Este exemplo pressupõe que as “Opções de compra de instância” estejam definidas como “Aderir ao modelo de lançamento”. Caso essa opção esteja definida como “Combinar opções de compra e tipos de instância”, LaunchTemplate pode ser acessada usando "MixedInstancesPolicy. LaunchTemplate” propriedade.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-ag-1).LaunchTemplate
```
**Saída**:
```
LaunchTemplateId LaunchTemplateName Version
---------------- ------------------ -------
lt-06095fd619cb40371 test-launch-template $Default
```
+ Para obter detalhes da API, consulte [DescribeAutoScalingGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAutoScalingInstance`
O código de exemplo a seguir mostra como usar `Get-ASAutoScalingInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista as instâncias IDs do Auto Scaling.**
```
Get-ASAutoScalingInstance | format-table -property InstanceId
```
**Saída**:
```
InstanceId
----------
i-12345678
i-87654321
i-abcd1234
```
**Exemplo 2: Este exemplo descreve a instância do Auto Scaling especificada.**
```
Get-ASAutoScalingInstance -InstanceId i-12345678
```
**Saída**:
```
AutoScalingGroupName : my-asg
AvailabilityZone : us-west-2b
HealthStatus : HEALTHY
InstanceId : i-12345678
LaunchConfigurationName : my-lc
LifecycleState : InService
```
**Exemplo 3: Este exemplo descreve duas instâncias do Auto Scaling especificadas.**
```
Get-ASAutoScalingInstance -InstanceId @("i-12345678", "i-87654321")
```
**Exemplo 4: Este exemplo descreve as instâncias do Auto Scaling do grupo do Auto Scaling especificado.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg).Instances | Get-ASAutoScalingInstance
```
**Exemplo 5: Este exemplo descreve todas as instâncias do Auto Scaling.**
```
Get-ASAutoScalingInstance
```
+ Para obter detalhes da API, consulte [DescribeAutoScalingInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAutoScalingNotificationType`
O código de exemplo a seguir mostra como usar `Get-ASAutoScalingNotificationType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os tipos de notificação compatíveis com o Auto Scaling.**
```
Get-ASAutoScalingNotificationType
```
**Saída**:
```
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
```
+ Para obter detalhes da API, consulte [DescribeAutoScalingNotificationTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASLaunchConfiguration`
O código de exemplo a seguir mostra como usar `Get-ASLaunchConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os nomes de suas configurações de execução.**
```
Get-ASLaunchConfiguration | format-table -property LaunchConfigurationName
```
**Saída**:
```
LaunchConfigurationName
-----------------------
my-lc-1
my-lc-2
my-lc-3
my-lc-4
my-lc-5
```
**Exemplo 2: Este exemplo descreve a configuração de execução especificada.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName my-lc-1
```
**Saída**:
```
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 :
```
**Exemplo 3: Este exemplo descreve as duas configurações de execução especificadas.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName @("my-lc-1", "my-lc-2")
```
**Exemplo 4: Este exemplo descreve todas as suas configurações de execução.**
```
Get-ASLaunchConfiguration
```
+ Para obter detalhes da API, consulte [DescribeLaunchConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASLifecycleHook`
O código de exemplo a seguir mostra como usar `Get-ASLifecycleHook`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o gancho do ciclo de vida especificado.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Saída**:
```
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
```
**Exemplo 2: Descreve os ganchos do ciclo de vida do grupo de Auto Scaling especificado.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg
```
**Exemplo 3: Este exemplo descreve todos ganchos do ciclo de vida os todos seus grupos do Auto Scaling.**
```
Get-ASLifecycleHook
```
+ Para obter detalhes da API, consulte [DescribeLifecycleHooks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASLifecycleHookType`
O código de exemplo a seguir mostra como usar `Get-ASLifecycleHookType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os tipos de gancho do ciclo de vida compatíveis com o Auto Scaling.**
```
Get-ASLifecycleHookType
```
**Saída**:
```
autoscaling:EC2_INSTANCE_LAUNCHING
auto-scaling:EC2_INSTANCE_TERMINATING
```
+ Para obter detalhes da API, consulte [DescribeLifecycleHookTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASLoadBalancer`
O código de exemplo a seguir mostra como usar `Get-ASLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Descreve os load balancers do grupo de Auto Scaling especificado.**
```
Get-ASLoadBalancer -AutoScalingGroupName my-asg
```
**Saída**:
```
LoadBalancerName State
---------------- -----
my-lb Added
```
+ Para obter detalhes da API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASMetricCollectionType`
O código de exemplo a seguir mostra como usar `Get-ASMetricCollectionType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os tipos de coleta de métricas compatíveis com o Auto Scaling.**
```
(Get-ASMetricCollectionType).Metrics
```
**Saída**:
```
Metric
------
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupStandbyInstances
GroupTotalInstances
```
**Exemplo 2: Este exemplo lista as granularidades correspondentes.**
```
(Get-ASMetricCollectionType).Granularities
```
**Saída**:
```
Granularity
-----------
1Minute
```
+ Para obter detalhes da API, consulte [DescribeMetricCollectionTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASNotificationConfiguration`
O código de exemplo a seguir mostra como usar `Get-ASNotificationConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo descreve as ações de notificação associadas ao grupo de Auto Scaling especificado.**
```
Get-ASNotificationConfiguration -AutoScalingGroupName my-asg | format-list
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo descreve as ações de notificação associadas a todos os seus grupos do Auto Scaling.**
```
Get-ASNotificationConfiguration
```
+ Para obter detalhes da API, consulte [DescribeNotificationConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASPolicy`
O código de exemplo a seguir mostra como usar `Get-ASPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo descreve o grupo do Auto Scaling especificado.**
```
Get-ASPolicy -AutoScalingGroupName my-asg
```
**Saída**:
```
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 : {}
```
**Exemplo 2: Este exemplo descreve duas políticas especificadas para o grupo do Auto Scaling especificado.**
```
Get-ASPolicy -AutoScalingGroupName my-asg -PolicyName @("myScaleOutPolicy", "myScaleInPolicy")
```
**Exemplo 3: Este exemplo descreve todas as políticas para todos os seus grupos do Auto Scaling.**
```
Get-ASPolicy
```
+ Para obter detalhes da API, consulte [DescribePolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASScalingActivity`
O código de exemplo a seguir mostra como usar `Get-ASScalingActivity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve as ações de escalabilidade das últimas seis semanas do grupo do Auto Scaling especificado.**
```
Get-ASScalingActivity -AutoScalingGroupName my-asg
```
**Saída**:
```
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 :
```
**Exemplo 2: Este exemplo descreve a atividade de escala especificada.**
```
Get-ASScalingActivity -ActivityId "063308ae-aa22-4a9b-94f4-9fae4EXAMPLE"
```
**Exemplo 3: Este exemplo descreve as atividades de escala das últimas seis semanas para todos os seus grupos do Auto Scaling.**
```
Get-ASScalingActivity
```
+ Para obter detalhes da API, consulte [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASScalingProcessType`
O código de exemplo a seguir mostra como usar `Get-ASScalingProcessType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista os tipos de processo compatíveis com o Auto Scaling.**
```
Get-ASScalingProcessType
```
**Saída**:
```
ProcessName
-----------
AZRebalance
AddToLoadBalancer
AlarmNotification
HealthCheck
Launch
ReplaceUnhealthy
ScheduledActions
Terminate
```
+ Para obter detalhes da API, consulte [DescribeScalingProcessTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASScheduledAction`
O código de exemplo a seguir mostra como usar `Get-ASScheduledAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve as ações de escalabilidade agendadas do grupo do Auto Scaling especificado.**
```
Get-ASScheduledAction -AutoScalingGroupName my-asg
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo descreve as ações de escala programada especificadas.**
```
Get-ASScheduledAction -ScheduledActionName @("myScheduledScaleOut", "myScheduledScaleIn")
```
**Exemplo 3: Este exemplo descreve as ações de escala programadas que começam no horário especificado.**
```
Get-ASScheduledAction -StartTime "2015-12-01T08:00:00Z"
```
**Exemplo 4: Este exemplo descreve as ações de escala programadas que terminam no horário especificado.**
```
Get-ASScheduledAction -EndTime "2015-12-30T08:00:00Z"
```
**Exemplo 5: Este exemplo descreve as ações de escala programadas para todos os seus grupos do Auto Scaling.**
```
Get-ASScheduledAction
```
+ Para obter detalhes da API, consulte [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASTag`
O código de exemplo a seguir mostra como usar `Get-ASTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve as tags com um valor-chave de “myTag” ou “myTag2”. Os valores possíveis para o nome do filtro são auto-scaling-group '', 'chave', 'valor' e 'propagate-at-launch'. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Get-ASTag -Filter @( @{ Name="key"; Values=@("myTag", "myTag2") } )
```
**Saída**:
```
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
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar o filtro para o 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 )
```
**Exemplo 3: Este exemplo descreve todas as tags para tudos seus grupos do Auto Scaling.**
```
Get-ASTag
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASTerminationPolicyType`
O código de exemplo a seguir mostra como usar `Get-ASTerminationPolicyType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as políticas de terminação que são compatíveis com o Auto Scaling.**
```
Get-ASTerminationPolicyType
```
**Saída**:
```
ClosestToNextInstanceHour
Default
NewestInstance
OldestInstance
OldestLaunchConfiguration
```
+ Para obter detalhes da API, consulte [DescribeTerminationPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Mount-ASInstance`
O código de exemplo a seguir mostra como usar `Mount-ASInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo anexa o grupo de destino especificado ao grupo do Auto Scaling especificado. O Auto Scaling aumenta automaticamente a capacidade desejada do grupo do Auto Scaling.**
```
Mount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [AttachInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ASAutoScalingGroup`
O código de exemplo a seguir mostra como usar `New-ASAutoScalingGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um grupo do Auto Scaling com o nome e os atributos especificados. A capacidade desejada padrão é o tamanho mínimo. Portanto, esse grupo do Auto Scaling inicia duas instâncias, uma em cada uma das duas zonas de disponibilidade especificadas.**
```
New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
```
+ Para obter detalhes da API, consulte [CreateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ASLaunchConfiguration`
O código de exemplo a seguir mostra como usar `New-ASLaunchConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma configuração de inicialização chamada “my-lc”. As EC2 instâncias iniciadas pelos grupos do Auto Scaling que usam essa configuração de execução usam o tipo de instância, a AMI, o grupo de segurança e a função do IAM especificados.**
```
New-ASLaunchConfiguration -LaunchConfigurationName my-lc -InstanceType "m3.medium" -ImageId "ami-12345678" -SecurityGroup "sg-12345678" -IamInstanceProfile "myIamRole"
```
+ Para obter detalhes da API, consulte [CreateLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASAutoScalingGroup`
O código de exemplo a seguir mostra como usar `Remove-ASAutoScalingGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui o grupo do Auto Scaling especificado se ele não tiver instâncias em execução. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -Force
```
**Exemplo 3: Este exemplo exclui o grupo do Auto Scaling especificado e encerra todas as instâncias em execução que ele contém.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -ForceDelete $true -Force
```
+ Para obter detalhes da API, consulte [DeleteAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASLaunchConfiguration`
O código de exemplo a seguir mostra como usar `Remove-ASLaunchConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui a configuração de inicialização especificada se ela não estiver anexada a um grupo do Auto Scaling. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc -Force
```
+ Para obter detalhes da API, consulte [DeleteLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASLifecycleHook`
O código de exemplo a seguir mostra como usar `Remove-ASLifecycleHook`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o gancho do ciclo de vida especificado para o grupo do Auto Scaling especificado. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -Force
```
+ Para obter detalhes da API, consulte [DeleteLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASNotificationConfiguration`
O código de exemplo a seguir mostra como usar `Remove-ASNotificationConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui a ação de notificação especificada. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic" -Force
```
+ Para obter detalhes da API, consulte [DeleteNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASPolicy`
O código de exemplo a seguir mostra como usar `Remove-ASPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui a política especificada para o grupo do Auto Scaling especificado. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy -Force
```
+ Para obter detalhes da API, consulte [DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASScheduledAction`
O código de exemplo a seguir mostra como usar `Remove-ASScheduledAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui a política especificada para o grupo do Auto Scaling especificado. A confirmação será solicitada antes que a operação continue.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction"
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction" -Force
```
+ Para obter detalhes da API, consulte [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ASTag`
O código de exemplo a seguir mostra como usar `Remove-ASTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag especificada do grupo do Auto Scaling especificado. A confirmação será solicitada antes que a operação continue. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } )
```
**Saída**:
```
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"):
```
**Exemplo 2: Se você especificar o parâmetro Force, não será solicitada a confirmação antes de prosseguir com a operação.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } ) -Force
```
**Exemplo 3: com o PowerShell versão, é necessário usar New-Object para criar a tag para o parâmetro de Tag.**
```
$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 obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Resume-ASProcess`
O código de exemplo a seguir mostra como usar `Resume-ASProcess`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo reinicia o processo do Auto Scaling especificado para o grupo de Auto Scaling especificado.**
```
Resume-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Exemplo 2: Este exemplo retoma todos os processos suspensos do Auto Scaling para o grupo do Auto Scaling especificado.**
```
Resume-ASProcess -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [ResumeProcesses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ASDesiredCapacity`
O código de exemplo a seguir mostra como usar `Set-ASDesiredCapacity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Define o tamanho do grupo de Auto Scaling especificado.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2
```
**Exemplo 2: Este exemplo define o tamanho do grupo do Auto Scaling especificado e aguarda a conclusão do período de espera antes de fazer o escalonamento para o novo tamanho.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2 -HonorCooldown $true
```
+ Para obter detalhes da API, consulte [SetDesiredCapacity](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ASInstanceHealth`
O código de exemplo a seguir mostra como usar `Set-ASInstanceHealth`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo define o status da instância especificada como “Não saudável”, tirando-a de serviço. O Auto Scaling termina e substitui a instância.**
```
Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b
```
**Exemplo 2: Este exemplo define o status da instância especificada como “Saudável”, mantendo-a em serviço. Definir um período de carência da verificação de integridade para um grupo do Auto Scaling**
```
Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
```
+ Para obter detalhes da API, consulte [SetInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ASInstanceProtection`
O código de exemplo a seguir mostra como usar `Set-ASInstanceProtection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo habilita a proteção de instância na a instância especificada.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $true
```
**Exemplo 2: Este exemplo desabilita a proteção de instância na instância especificada.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $false
```
+ Para obter detalhes da API, consulte [SetInstanceProtection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ASTag`
O código de exemplo a seguir mostra como usar `Set-ASTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona uma única tag ao grupo do Auto Scaling especificado. A chave da tag é 'myTag' e o valor da tag é 'myTagValue'. O Auto Scaling propaga essa tag para as EC2 instâncias subsequentes iniciadas pelo grupo Auto Scaling. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Set-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag"; Value="myTagValue"; PropagateAtLaunch=$true} )
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar a tag para o 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 obter detalhes da API, consulte [CreateOrUpdateTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-ASPolicy`
O código de exemplo a seguir mostra como usar `Start-ASPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo executa a política especificada para o grupo do Auto Scaling especificado.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy"
```
**Exemplo 2: Este exemplo executa a política especificada para o grupo do Auto Scaling especificado, depois de aguardar a conclusão do período de espera.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy" -HonorCooldown $true
```
+ Para obter detalhes da API, consulte [ExecutePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-ASInstanceInAutoScalingGroup`
O código de exemplo a seguir mostra como usar `Stop-ASInstanceInAutoScalingGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo encerra a instância especificada e diminui a capacidade desejada de seu grupo do Auto Scaling para que o Auto Scaling não inicie uma instância substituta.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $true
```
**Saída**:
```
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 :
```
**Exemplo 2: Este exemplo encerra a instância especificada sem diminuir a capacidade desejada de seu grupo do Auto Scaling. Auto Scaling inicia uma nova instância de substituição.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $false
```
**Saída**:
```
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 obter detalhes da API, consulte [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Suspend-ASProcess`
O código de exemplo a seguir mostra como usar `Suspend-ASProcess`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo suspende o processo de escalabilidade especificado para o grupo do Auto Scaling especificado.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Exemplo 2: Este exemplo suspende todos os processos do Auto Scaling para o grupo do Auto Scaling especificado.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg
```
+ Para obter detalhes da API, consulte [SuspendProcesses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-ASAutoScalingGroup`
O código de exemplo a seguir mostra como usar `Update-ASAutoScalingGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza o tamanho mínimo e máximo do grupo do Auto Scaling especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
```
**Exemplo 2: Este exemplo atualiza o período de espera padrão do grupo do Auto Scaling especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
```
**Exemplo 3: Este exemplo atualiza as zonas de disponibilidade do grupo do Auto Scaling especificado.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
```
**Exemplo 4: Este exemplo atualiza o grupo do Auto Scaling especificado para usar verificações de integridade do Elastic Load Balancing.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
```
+ Para obter detalhes da API, consulte [UpdateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-ASLifecycleActionHeartbeat`
O código de exemplo a seguir mostra como usar `Write-ASLifecycleActionHeartbeat`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo registra uma pulsação para a ação de ciclo de vida especificada. Isso mantém a instância em um estado pendente até que você conclua a ação personalizada.**
```
Write-ASLifecycleActionHeartbeat -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ Para obter detalhes da API, consulte [RecordLifecycleActionHeartbeat](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-ASLifecycleHook`
O código de exemplo a seguir mostra como usar `Write-ASLifecycleHook`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona o gancho do ciclo de vida especificado ao grupo do Auto Scaling 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 obter detalhes da API, consulte [PutLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-ASNotificationConfiguration`
O código de exemplo a seguir mostra como usar `Write-ASNotificationConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo configura o grupo de Auto Scaling especificado para enviar uma notificação ao tópico do SNS especificado quando ele executa instâncias. EC2 **
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType "autoscaling:EC2_INSTANCE_LAUNCH" -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Exemplo 2: Este exemplo configura o grupo de Auto Scaling especificado para enviar uma notificação ao tópico do SNS especificado quando ele inicia ou encerra instâncias. 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 obter detalhes da API, consulte [PutNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-ASScalingPolicy`
O código de exemplo a seguir mostra como usar `Write-ASScalingPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona a política especificada ao grupo do Auto Scaling especificado. O tipo de ajuste especificado determina como interpretar o ScalingAdjustment parâmetro. Com 'ChangeInCapacity', um valor positivo aumenta a capacidade pelo número especificado de instâncias e um valor negativo diminui a capacidade pelo número especificado de instâncias.**
```
Write-ASScalingPolicy -AutoScalingGroupName my-asg -AdjustmentType "ChangeInCapacity" -PolicyName "myScaleInPolicy" -ScalingAdjustment -1
```
**Saída**:
```
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef:autoScalingGroupName/my-asg
:policyName/myScaleInPolicy
```
+ Para obter detalhes da API, consulte [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-ASScheduledUpdateGroupAction`
O código de exemplo a seguir mostra como usar `Write-ASScheduledUpdateGroupAction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria ou atualiza uma ação programada única para alterar a capacidade desejada na hora de início especificada.**
```
Write-ASScheduledUpdateGroupAction -AutoScalingGroupName my-asg -ScheduledActionName "myScheduledAction" -StartTime "2015-12-01T00:00:00Z" -DesiredCapacity 10
```
+ Para obter detalhes da API, consulte [PutScheduledUpdateGroupAction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Budgets exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Budgets.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `New-BGTBudget`
O código de exemplo a seguir mostra como usar `New-BGTBudget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um orçamento com as restrições orçamentárias e de tempo especificadas com notificações por e-mail.**
```
$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 obter detalhes da API, consulte [CreateBudget](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Cloud9 exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Cloud9.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-C9EnvironmentData`
O código de exemplo a seguir mostra como usar `Get-C9EnvironmentData`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém informações sobre os ambientes de desenvolvimento do AWS Cloud9 especificados.**
```
Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX,1980b80e5f584920801c09086667f0EX
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo obtém informações sobre o status do ciclo de vida do ambiente de desenvolvimento Cloud9 especificado AWS .**
```
(Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX).Lifecycle
```
**Saída**:
```
FailureResource Reason Status
--------------- ------ ------
CREATED
```
+ Para obter detalhes da API, consulte [DescribeEnvironments](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-C9EnvironmentList`
O código de exemplo a seguir mostra como usar `Get-C9EnvironmentList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém uma lista dos identificadores de ambiente de desenvolvimento do AWS Cloud9 disponíveis.**
```
Get-C9EnvironmentList
```
**Saída**:
```
685f892f431b45c2b28cb69eadcdb0EX
1980b80e5f584920801c09086667f0EX
```
+ Para obter detalhes da API, consulte [ListEnvironments](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-C9EnvironmentMembershipList`
O código de exemplo a seguir mostra como usar `Get-C9EnvironmentMembershipList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém informações sobre os membros do ambiente do ambiente de desenvolvimento AWS Cloud9 especificado.**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo obtém informações sobre o proprietário do ambiente de desenvolvimento AWS Cloud9 especificado.**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission owner
```
**Saída**:
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
**Exemplo 3: Este exemplo obtém informações sobre o membro do ambiente especificado para vários ambientes de desenvolvimento do AWS Cloud9.**
```
Get-C9EnvironmentMembershipList -UserArn arn:aws:iam::123456789012:user/MyDemoUser
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeEnvironmentMemberships](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-C9EnvironmentStatus`
O código de exemplo a seguir mostra como usar `Get-C9EnvironmentStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém informações de status para o ambiente de desenvolvimento AWS Cloud9 especificado.**
```
Get-C9EnvironmentStatus -EnvironmentId 349c86d4579e4e7298d500ff57a6b2EX
```
**Saída**:
```
Message Status
------- ------
Environment is ready to use ready
```
+ Para obter detalhes da API, consulte [DescribeEnvironmentStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-C9EnvironmentEC2`
O código de exemplo a seguir mostra como usar `New-C9EnvironmentEC2`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um ambiente de desenvolvimento AWS Cloud9 com as configurações especificadas, inicia uma instância do Amazon Elastic Compute Cloud ( EC2Amazon) e, em seguida, se conecta da instância ao ambiente.**
```
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
```
**Saída**:
```
ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obter detalhes da API, consulte [CreateEnvironmentEc2](https://docs.aws.amazon.com/powershell/v5/reference) em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-C9EnvironmentMembership`
O código de exemplo a seguir mostra como usar `New-C9EnvironmentMembership`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo adiciona o membro do ambiente especificado ao ambiente de desenvolvimento do AWS Cloud9 especificado.**
```
New-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-write
```
**Saída**:
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-write
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ Para obter detalhes da API, consulte [CreateEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-C9Environment`
O código de exemplo a seguir mostra como usar `Remove-C9Environment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui o ambiente de desenvolvimento AWS Cloud9 especificado. Se uma EC2 instância da Amazon estiver conectada ao ambiente, a instância também será encerrada.**
```
Remove-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obter detalhes da API, consulte [DeleteEnvironment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-C9EnvironmentMembership`
O código de exemplo a seguir mostra como usar `Remove-C9EnvironmentMembership`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui o membro do ambiente especificado do ambiente de desenvolvimento AWS Cloud9 especificado.**
```
Remove-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ Para obter detalhes da API, consulte [DeleteEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-C9Environment`
O código de exemplo a seguir mostra como usar `Update-C9Environment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo altera as configurações especificadas do ambiente de desenvolvimento AWS Cloud9 existente especificado.**
```
Update-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Description "My changed demonstration development environment." -Name my-changed-demo-env
```
+ Para obter detalhes da API, consulte [UpdateEnvironment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-C9EnvironmentMembership`
O código de exemplo a seguir mostra como usar `Update-C9EnvironmentMembership`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo altera as configurações do membro do ambiente existente especificado para o ambiente de desenvolvimento AWS Cloud9 especificado.**
```
Update-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-only
```
**Saída**:
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-only
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ Para obter detalhes da API, consulte [UpdateEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# CloudFormation exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CloudFormation.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-CFNStack`
O código de exemplo a seguir mostra como usar `Get-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna um conjunto de instâncias de pilha descrevendo todas as pilhas do usuário.**
```
Get-CFNStack
```
**Exemplo 2: retorna uma instância de pilha descrevendo a pilha especificada**
```
Get-CFNStack -StackName "myStack"
```
+ Para obter detalhes da API, consulte [DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNStackEvent`
O código de exemplo a seguir mostra como usar `Get-CFNStackEvent`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todos os eventos relacionados à pilha especificada.**
```
Get-CFNStackEvent -StackName "myStack"
```
+ Para obter detalhes da API, consulte [DescribeStackEvents](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNStackResource`
O código de exemplo a seguir mostra como usar `Get-CFNStackResource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna a descrição de um recurso identificado no modelo associado à pilha especificada pelo ID lógico DBInstance “Meu”.**
```
Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance"
```
+ Para obter detalhes da API, consulte [DescribeStackResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNStackResourceList`
O código de exemplo a seguir mostra como usar `Get-CFNStackResourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna as descrições dos AWS recursos de até 100 recursos associados à pilha especificada. Para obter detalhes de todos os recursos associados a uma pilha, use o Get- CFNStackResourceSummary, que também oferece suporte à paginação manual dos resultados.**
```
Get-CFNStackResourceList -StackName "myStack"
```
**Exemplo 2: Retorna a descrição da EC2 instância Amazon identificada no modelo associado à pilha especificada pelo ID lógico “Ec2Instance”.**
```
Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"
```
**Exemplo 3: retorna a descrição de até 100 recursos associados à pilha que contém uma instância da Amazon identificada pelo ID de EC2 instância “i-123456". Para obter detalhes de todos os recursos associados a uma pilha, use o Get- CFNStackResourceSummary, que também oferece suporte à paginação manual dos resultados.**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456"
```
**Exemplo 4: Retorna a descrição da EC2 instância da Amazon identificada pelo ID lógico “Ec2Instance” no modelo de uma pilha. A pilha é identificada usando o ID do recurso físico de um recurso que ela contém; nesse caso, também uma instância da Amazon com o ID de EC2 instância “i-123456". Um outro recurso físico também poderia ser usado para identificar a pilha, dependendo do conteúdo do modelo, por exemplo, um bucket do Amazon S3.**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"
```
+ Para obter detalhes da API, consulte [DescribeStackResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNStackResourceSummary`
O código de exemplo a seguir mostra como usar `Get-CFNStackResourceSummary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna as descrições de todos os recursos associados à pilha especificada.**
```
Get-CFNStackResourceSummary -StackName "myStack"
```
+ Para obter detalhes da API, consulte [ListStackResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNStackSummary`
O código de exemplo a seguir mostra como usar `Get-CFNStackSummary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna informações resumidas de todas as pilhas.**
```
Get-CFNStackSummary
```
**Exemplo 2: retorna informações resumidas de todas as pilhas que estão sendo criadas no momento.**
```
Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"
```
**Exemplo 3: retorna informações resumidas de todas as pilhas que estão sendo criadas ou atualizadas no momento.**
```
Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")
```
+ Para obter detalhes da API, consulte [ListStacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFNTemplate`
O código de exemplo a seguir mostra como usar `Get-CFNTemplate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o modelo associado à pilha especificada.**
```
Get-CFNTemplate -StackName "myStack"
```
+ Para obter detalhes da API, consulte [GetTemplate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Measure-CFNTemplateCost`
O código de exemplo a seguir mostra como usar `Measure-CFNTemplateCost`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna uma URL AWS simples da calculadora mensal com uma sequência de caracteres de consulta que descreve os recursos necessários para executar o modelo. O modelo é obtido da URL do Amazon S3 especificada e do único parâmetro de personalização aplicado. O parâmetro também pode ser especificado usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'.**
```
Measure-CFNTemplateCost -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Region us-west-1 `
-Parameter @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" }
```
**Exemplo 2: retorna uma URL AWS simples da calculadora mensal com uma sequência de caracteres de consulta que descreve os recursos necessários para executar o modelo. O modelo é analisado a partir do conteúdo fornecido e os parâmetros de personalização aplicados (este exemplo pressupõe que o conteúdo do modelo teria declarado dois parâmetros, '' e 'KeyName')InstanceType. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'.**
```
Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" },`
@{ ParameterKey="InstanceType"; ParameterValue="m1.large" })
```
**Exemplo 3: usa New-Object para criar o conjunto de parâmetros do modelo e retorna uma URL de calculadora mensal AWS simples com uma sequência de caracteres de consulta que descreve os recursos necessários para executar o modelo. O modelo é analisado a partir do conteúdo fornecido, com parâmetros de personalização (este exemplo pressupõe que o conteúdo do modelo teria declarado dois parâmetros, '' e 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 obter detalhes da API, consulte [EstimateTemplateCost](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CFNStack`
O código de exemplo a seguir mostra como usar `New-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria uma nova pilha com o nome especificado. O modelo é analisado a partir do conteúdo fornecido com parâmetros de personalização ('PK1' e 'PK2' representam os nomes dos parâmetros declarados no conteúdo do modelo, 'PV1' e 'PV2' representam os valores desses parâmetros. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'. Se houver falha na criação da pilha, ela não será revertida.**
```
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
-DisableRollback $true
```
**Exemplo 2: cria uma nova pilha com o nome especificado. O modelo é analisado a partir do conteúdo fornecido com parâmetros de personalização ('PK1' e 'PK2' representam os nomes dos parâmetros declarados no conteúdo do modelo, 'PV1' e 'PV2' representam os valores desses parâmetros. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'. Se houver falha na criação da pilha, ela será revertida.**
```
$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"
```
**Exemplo 3: cria uma nova pilha com o nome especificado. O modelo é obtido da URL do Amazon S3 com parâmetros de personalização ('PK1' representa o nome de um parâmetro declarado no conteúdo do modelo, 'PV1' representa o valor do parâmetro. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'. Se a criação da pilha falhar, ela será revertida (o mesmo que especificar - DisableRollback \$1false**).
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Exemplo 4: cria uma nova pilha com o nome especificado. O modelo é obtido da URL do Amazon S3 com parâmetros de personalização ('PK1' representa o nome de um parâmetro declarado no conteúdo do modelo, 'PV1' representa o valor do parâmetro. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'. Se a criação da pilha falhar, ela será revertida (o mesmo que especificar - DisableRollback \$1false). A notificação especificada AENs receberá eventos publicados relacionados à pilha.**
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
-NotificationARN @( "arn1", "arn2" )
```
+ Para obter detalhes da API, consulte [CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CFNStack`
O código de exemplo a seguir mostra como usar `Remove-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a pilha especificada.**
```
Remove-CFNStack -StackName "myStack"
```
+ Para obter detalhes da API, consulte [DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Resume-CFNUpdateRollback`
O código de exemplo a seguir mostra como usar `Resume-CFNUpdateRollback`.
**Ferramentas para PowerShell V5**
**Exemplo 1: continua a reversão da pilha nomeada, que deve estar no estado "UPDATE\$1ROLLBACK\$1FAILED". Se a reversão contínua for bem-sucedida, a pilha entrará no estado "UPDATE\$1ROLLBACK\$1COMPLETE".**
```
Resume-CFNUpdateRollback -StackName "myStack"
```
+ Para obter detalhes da API, consulte [ContinueUpdateRollback](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-CFNUpdateStack`
O código de exemplo a seguir mostra como usar `Stop-CFNUpdateStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cancela uma atualização na pilha especificada.**
```
Stop-CFNUpdateStack -StackName "myStack"
```
+ Para obter detalhes da API, consulte [CancelUpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Test-CFNStack`
O código de exemplo a seguir mostra como usar `Test-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: testa se a pilha atingiu um dos estados UPDATE\$1ROLLBACK\$1COMPLETE, CREATE\$1COMPLETE, ROLLBACK\$1COMPLETE ou UPDATE\$1COMPLETE.**
```
Test-CFNStack -StackName MyStack
```
**Saída**:
```
False
```
**Exemplo 2: testa se a pilha atingiu o status UPDATE\$1COMPLETE ou UPDATE\$1ROLLBACK\$1COMPLETE.**
```
Test-CFNStack -StackName MyStack -Status UPDATE_COMPLETE,UPDATE_ROLLBACK_COMPLETE
```
**Saída**:
```
True
```
+ Para obter detalhes da API, consulte [Test- CFNStack](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Test-CFNTemplate`
O código de exemplo a seguir mostra como usar `Test-CFNTemplate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: valida o conteúdo do modelo especificado. A saída detalha os recursos, a descrição e os parâmetros do modelo.**
```
Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"
```
**Exemplo 2: valida o modelo especificado acessado por meio de uma URL do Amazon S3. A saída detalha os recursos, a descrição e os parâmetros do modelo.**
```
Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template
```
+ Para obter detalhes da API, consulte [ValidateTemplate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CFNStack`
O código de exemplo a seguir mostra como usar `Update-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza a pilha 'myStack' com o modelo e os parâmetros de personalização especificados. 'PK1' representa o nome de um parâmetro declarado no modelo e 'PV1' representa seu valor. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'.**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Exemplo 2: atualiza a pilha 'myStack' com o modelo e os parâmetros de personalização especificados. 'PK1' e 'PK2' representam os nomes dos parâmetros declarados no modelo, 'PV1' e 'PV2' representam os valores solicitados. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'.**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )
```
**Exemplo 3: atualiza a pilha 'myStack' com o modelo e os parâmetros de personalização especificados. 'PK1' representa o nome de um parâmetro declarado no modelo e 'PV2' representa seu valor. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'.**
```
Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**Exemplo 4: atualiza a pilha 'myStack' com o modelo especificado, obtido do Amazon S3, e parâmetros de personalização. 'PK1' e 'PK2' representam os nomes dos parâmetros declarados no modelo, 'PV1' e 'PV2' representam os valores solicitados. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e '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" } )
```
**Exemplo 5: atualiza a pilha 'myStack', que neste exemplo é considerada como contendo recursos do IAM, com o modelo especificado, obtido do Amazon S3, e parâmetros de personalização. 'PK1' e 'PK2' representam os nomes dos parâmetros declarados no modelo, 'PV1' e 'PV2' representam os valores solicitados. Os parâmetros de personalização também podem ser especificados usando 'Chave' e 'Valor' em vez de 'ParameterKey' e 'ParameterValue'. As pilhas contendo recursos do IAM exigem que você especifique o parâmetro -Capabilities “CAPABILITY\$1IAM”, caso contrário, a atualização falhará com um erro ''. 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 obter detalhes da API, consulte [UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Wait-CFNStack`
O código de exemplo a seguir mostra como usar `Wait-CFNStack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: testa se a pilha atingiu um dos estados UPDATE\$1ROLLBACK\$1COMPLETE, CREATE\$1COMPLETE, ROLLBACK\$1COMPLETE ou UPDATE\$1COMPLETE. Se a pilha não estiver em um dos estados, o comando aguarda dois segundos antes de testar o status novamente. Isso é repetido até que a pilha alcance um dos estados solicitados ou até que o tempo limite padrão de 60 segundos termine. Se o tempo limite for excedido, será lançada uma exceção. Se a pilha atingir um dos estados solicitados dentro do tempo limite, ela será retornada ao pipeline.**
```
$stack = Wait-CFNStack -StackName MyStack
```
**Exemplo 2: esse exemplo aguarda por um total de 5 minutos (300 segundos) para que a pilha alcance qualquer um dos estados especificados. Nesse exemplo, o estado é atingido antes do tempo limite e, portanto, o objeto da pilha é retornado ao pipeline.**
```
Wait-CFNStack -StackName MyStack -Timeout 300 -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**Saída**:
```
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
```
**Exemplo 3: esse exemplo mostra a saída de erro quando uma pilha não atinge um dos estados solicitados dentro do tempo limite (nesse caso, o tempo padrão de 60 segundos).**
```
Wait-CFNStack -StackName MyStack -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**Saída**:
```
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 obter detalhes da API, consulte [Wait- CFNStack](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
# CloudFront exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CloudFront.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-CFCloudFrontOriginAccessIdentity`
O código de exemplo a seguir mostra como usar `Get-CFCloudFrontOriginAccessIdentity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna uma identidade de acesso de CloudFront origem específica da Amazon, especificada pelo parâmetro -Id. Embora o parâmetro -Id não seja obrigatório, se você não o especificar, nenhum resultado será retornado.**
```
Get-CFCloudFrontOriginAccessIdentity -Id E3XXXXXXXXXXRT
```
**Saída**:
```
CloudFrontOriginAccessIdentityConfig Id S3CanonicalUserId
------------------------------------ -- -----------------
Amazon.CloudFront.Model.CloudFrontOr... E3XXXXXXXXXXRT 4b6e...
```
+ Para obter detalhes da API, consulte [GetCloudFrontOriginAccessIdentity](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFCloudFrontOriginAccessIdentityConfig`
O código de exemplo a seguir mostra como usar `Get-CFCloudFrontOriginAccessIdentityConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna informações de configuração sobre uma única identidade de acesso de CloudFront origem da Amazon, especificada pelo parâmetro -Id. Ocorrem erros se nenhum parâmetro -Id for especificado.**
```
Get-CFCloudFrontOriginAccessIdentityConfig -Id E3XXXXXXXXXXRT
```
**Saída**:
```
CallerReference Comment
--------------- -------
mycallerreference: 2/1/2011 1:16:32 PM Caller reference: 2/1/2011 1:16:32 PM
```
+ Para obter detalhes da API, consulte [GetCloudFrontOriginAccessIdentityConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFCloudFrontOriginAccessIdentityList`
O código de exemplo a seguir mostra como usar `Get-CFCloudFrontOriginAccessIdentityList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna uma lista de identidades de acesso de CloudFront origem da Amazon. Como o MaxItem parâmetro - especifica um valor de 2, os resultados incluem duas identidades.**
```
Get-CFCloudFrontOriginAccessIdentityList -MaxItem 2
```
**Saída**:
```
IsTruncated : True
Items : {E326XXXXXXXXXT, E1YWXXXXXXX9B}
Marker :
MaxItems : 2
NextMarker : E1YXXXXXXXXX9B
Quantity : 2
```
+ Para obter detalhes da API, consulte [ListCloudFrontOriginAccessIdentities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFDistribution`
O código de exemplo a seguir mostra como usar `Get-CFDistribution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera as informações de uma distribuição específica.**
```
Get-CFDistribution -Id EXAMPLE0000ID
```
+ Para obter detalhes da API, consulte [GetDistribution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFDistributionConfig`
O código de exemplo a seguir mostra como usar `Get-CFDistributionConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera a configuração de uma distribuição específica.**
```
Get-CFDistributionConfig -Id EXAMPLE0000ID
```
+ Para obter detalhes da API, consulte [GetDistributionConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFDistributionList`
O código de exemplo a seguir mostra como usar `Get-CFDistributionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorno de distribuições.**
```
Get-CFDistributionList
```
+ Para obter detalhes da API, consulte [ListDistributions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CFDistribution`
O código de exemplo a seguir mostra como usar `New-CFDistribution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Cria uma CloudFront distribuição básica, configurada com registro e armazenamento em cache.**
```
$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 obter detalhes da API, consulte [CreateDistribution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CFInvalidation`
O código de exemplo a seguir mostra como usar `New-CFInvalidation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma nova invalidação em uma distribuição com um ID de EXAMPLENSTXAXE. CallerReference É um ID exclusivo escolhido pelo usuário; nesse caso, é usado um carimbo de data/hora representando 15 de maio de 2019 às 9h. A variável \$1Paths armazena três caminhos para arquivos de imagem e mídia que o usuário não deseja como parte do cache distribuído. O valor do parâmetro -Paths\$1Quantity é o número total de caminhos especificados no 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
```
**Saída**:
```
Invalidation Location
------------ --------
Amazon.CloudFront.Model.Invalidation https://cloudfront.amazonaws.com/2018-11-05/distribution/EXAMPLENSTXAXE/invalidation/EXAMPLE8NOK9H
```
+ Para obter detalhes da API, consulte [CreateInvalidation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CFSignedCookie`
O código de exemplo a seguir mostra como usar `New-CFSignedCookie`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um cookie assinado para o recurso especificado usando uma política predefinida. O cookie tem validade de um ano.**
```
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/image1.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddYears(1)
}
New-CFSignedCookie @params
```
**Saída**:
```
Expires
-------
[CloudFront-Expires, 1472227284]
```
**Exemplo 2: cria um cookie assinado para os recursos especificados usando uma política personalizada. O cookie tem validade de 24 horas e expira uma semana depois.**
```
$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
```
**Saída**:
```
Policy
------
[CloudFront-Policy, eyJTd...wIjo...
```
**Exemplo 3: cria um cookie assinado para os recursos especificados usando uma política personalizada. O cookie tem validade de 24 horas e expira uma semana depois. O acesso aos recursos é restrito ao 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
```
**Saída**:
```
Policy ------ [CloudFront-Policy, eyJTd...wIjo...
```
+ Para obter detalhes da API, consulte [New- CFSigned Cookie](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `New-CFSignedUrl`
O código de exemplo a seguir mostra como usar `New-CFSignedUrl`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um URL assinado para o recurso especificado usando uma política predefinida. O URL tem validade de uma hora. Um objeto System.Uri contendo o URL assinado é emitido para o pipeline.**
```
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddHours(1)
}
New-CFSignedUrl @params
```
**Exemplo 2: cria um URL assinado para o recurso especificado usando uma política personalizada. O URL tem validade a partir de 24 horas e expira uma semana depois.**
```
$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
```
**Exemplo 3: cria um URL assinado para o recurso especificado usando uma política personalizada. O URL tem validade a partir de 24 horas e expira uma semana depois. O acesso ao recurso é restrito ao 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 obter detalhes da API, consulte [New- CFSigned Url](https://docs.aws.amazon.com/powershell/v5/reference) em *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
# CloudTrail exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CloudTrail.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Find-CTEvent`
O código de exemplo a seguir mostra como usar `Find-CTEvent`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todos os eventos que ocorreram nos últimos sete dias. Por padrão, o cmdlet faz automaticamente várias chamadas para entregar todos os eventos, saindo quando o serviço indica que não há mais dados disponíveis.**
```
Find-CTEvent
```
**Exemplo 2: retorna todos os eventos que ocorreram nos últimos sete dias, especificando uma região que não é o padrão atual do shell.**
```
Find-CTEvent -Region eu-central-1
```
**Exemplo 3: retorna todos os eventos associados à chamada da RunInstances API.**
```
Find-CTEvent -LookupAttribute @{ AttributeKey="EventName"; AttributeValue="RunInstances" }
```
**Exemplo 4: retorna os primeiros cinco eventos disponíveis.**
```
Find-CTEvent -MaxResult 5
```
+ Para obter detalhes da API, consulte [LookupEvents](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CTTrail`
O código de exemplo a seguir mostra como usar `Get-CTTrail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera as configurações de todas as trilhas associadas à região atual de sua conta.**
```
Get-CTTrail
```
**Exemplo 2: retorna as configurações das trilhas especificadas.**
```
Get-CTTrail -TrailNameList trail1,trail2
```
**Exemplo 3: retorna as configurações das trilhas especificadas que foram criadas em uma região diferente do padrão atual do shell (nesse caso, a região de Frankfurt, eu-central-1).**
```
Get-CTTrail -TrailNameList trailABC,trailDEF -Region eu-central-1
```
+ Para obter detalhes da API, consulte [DescribeTrails](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CTTrailStatus`
O código de exemplo a seguir mostra como usar `Get-CTTrailStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna informações de status da trilha com o nome 'myExampleTrail'. Os dados retornados incluem informações sobre erros de envio, erros do Amazon SNS e do Amazon S3, além dos horários de início e término do registro em log da trilha. Este exemplo pressupõe que a trilha foi criada na mesma região do shell padrão atual.**
```
Get-CTTrailStatus -Name myExampleTrail
```
**Exemplo 2: retorna as informações de status de uma trilha que foi criada em uma região diferente do padrão atual do shell (nesse caso, a região de Frankfurt, eu-central-1).**
```
Get-CTTrailStatus -Name myExampleTrail -Region eu-central-1
```
+ Para obter detalhes da API, consulte [GetTrailStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CTTrail`
O código de exemplo a seguir mostra como usar `New-CTTrail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria uma trilha que usará o bucket “amzn-s3-demo-bucket” para armazenamento de arquivos de log.**
```
New-CTTrail -Name "awscloudtrail-example" -S3BucketName "amzn-s3-demo-bucket"
```
**Exemplo 2: cria uma trilha que usará o bucket “amzn-s3-demo-bucket” para armazenamento de arquivos de log. Os objetos do S3 que representam os logs terão um prefixo de chave comum de “mylogs”. Quando novos registros forem entregues ao bucket, uma notificação será enviada para o tópico do SNS “mlog-deliverytopic”. Este exemplo usa o nivelamento para fornecer os valores dos parâmetros ao cmdlet.**
```
$params = @{
Name="awscloudtrail-example"
S3BucketName="amzn-s3-demo-bucket"
S3KeyPrefix="mylogs"
SnsTopicName="mlog-deliverytopic"
}
New-CTTrail @params
```
+ Para obter detalhes da API, consulte [CreateTrail](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CTTrail`
O código de exemplo a seguir mostra como usar `Remove-CTTrail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a trilha especificada. Será solicitada uma confirmação antes que o comando seja executado. Para ignorar a confirmação, adicione o parâmetro -Force.**
```
Remove-CTTrail -Name "awscloudtrail-example"
```
+ Para obter detalhes da API, consulte [DeleteTrail](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-CTLogging`
O código de exemplo a seguir mostra como usar `Start-CTLogging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: inicia a gravação das chamadas de AWS API e a entrega do arquivo de log para a trilha chamada 'myExampleTrail'. Este exemplo pressupõe que a trilha foi criada na mesma região do shell padrão atual.**
```
Start-CTLogging -Name myExampleTrail
```
**Exemplo 2: inicia a gravação das chamadas de AWS API e a entrega do arquivo de log para uma trilha que foi criada em uma região diferente do padrão atual do shell (nesse caso, a região de Frankfurt (eu-central-1)).**
```
Start-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ Para obter detalhes da API, consulte [StartLogging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-CTLogging`
O código de exemplo a seguir mostra como usar `Stop-CTLogging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: suspende a gravação de chamadas de AWS API e a entrega do arquivo de log para a trilha chamada 'myExampleTrail'. Este exemplo pressupõe que a trilha foi criada na mesma região do shell padrão atual.**
```
Stop-CTLogging -Name myExampleTrail
```
**Exemplo 2: suspende a gravação de chamadas de AWS API e a entrega de arquivos de log para uma trilha que foi criada em uma região diferente do padrão atual do shell (nesse caso, a região de Frankfurt (eu-central-1)).**
```
Stop-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ Para obter detalhes da API, consulte [StopLogging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CTTrail`
O código de exemplo a seguir mostra como usar `Update-CTTrail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza a trilha especificada para que os eventos globais do serviço (como os do IAM) sejam registrados e altera o prefixo de chave comum dos arquivos de log futuros para “globallogs”.**
```
Update-CTTrail -Name "awscloudtrail-example" -IncludeGlobalServiceEvents $true -S3KeyPrefix "globallogs"
```
**Exemplo 2: atualiza a trilha especificada para que as notificações sobre novas entregas de logs sejam enviadas ao tópico do SNS especificado.**
```
Update-CTTrail -Name "awscloudtrail-example" -SnsTopicName "mlog-deliverytopic2"
```
**Exemplo 3: atualiza a trilha especificada para que os logs sejam entregues em um bucket diferente.**
```
Update-CTTrail -Name "awscloudtrail-example" -S3BucketName "otherlogs"
```
+ Para obter detalhes da API, consulte [UpdateTrail](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# CloudWatch exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CloudWatch.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-CWDashboard`
O código de exemplo a seguir mostra como usar `Get-CWDashboard`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o ARN do corpo do painel especificado.**
```
Get-CWDashboard -DashboardName Dashboard1
```
**Saída**:
```
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
```
+ Para obter detalhes da API, consulte [GetDashboard](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CWDashboardList`
O código de exemplo a seguir mostra como usar `Get-CWDashboardList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna a coleção de painéis para sua conta.**
```
Get-CWDashboardList
```
**Saída**:
```
DashboardArn DashboardName LastModified Size
------------ ------------- ------------ ----
arn:... Dashboard1 7/6/2017 8:14:15 PM 252
```
**Exemplo 2: retorna a coleção de painéis para sua conta cujos nomes começam com o prefixo “dev”.**
```
Get-CWDashboardList -DashboardNamePrefix dev
```
+ Para obter detalhes da API, consulte [ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CWDashboard`
O código de exemplo a seguir mostra como usar `Remove-CWDashboard`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o painel especificado, solicitando uma confirmação antes de continuar. Para ignorar a confirmação, adicione a opção -Force para o comando.**
```
Remove-CWDashboard -DashboardName Dashboard1
```
+ Para obter detalhes da API, consulte [DeleteDashboards](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-CWDashboard`
O código de exemplo a seguir mostra como usar `Write-CWDashboard`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria ou atualiza o painel denominado “Dashboard1” para incluir dois widgets de métricas lado a lado.**
```
$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
```
**Exemplo 2: cria ou atualiza o painel, redirecionando o conteúdo que descreve o painel para o cmdlet.**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ Para obter detalhes da API, consulte [PutDashboard](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-CWMetricData`
O código de exemplo a seguir mostra como usar `Write-CWMetricData`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um novo MetricDatum objeto e o grava no 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 obter detalhes da API, consulte [PutMetricData](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# CodeCommit exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CodeCommit.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-CCBranch`
O código de exemplo a seguir mostra como usar `Get-CCBranch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre a ramificação especificada para o repositório especificado.**
```
Get-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch
```
**Saída**:
```
BranchName CommitId
---------- --------
MyNewBranch 7763222d...561fc9c9
```
+ Para obter detalhes da API, consulte [GetBranch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CCBranchList`
O código de exemplo a seguir mostra como usar `Get-CCBranchList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista de nomes de ramificações para o repositório especificado.**
```
Get-CCBranchList -RepositoryName MyDemoRepo
```
**Saída**:
```
master
MyNewBranch
```
+ Para obter detalhes da API, consulte [ListBranches](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CCRepository`
O código de exemplo a seguir mostra como usar `Get-CCRepository`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações para o repositório especificado.**
```
Get-CCRepository -RepositoryName MyDemoRepo
```
**Saída**:
```
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 obter detalhes da API, consulte [GetRepository](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CCRepositoryBatch`
O código de exemplo a seguir mostra como usar `Get-CCRepositoryBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo confirma quais dos repositórios especificados foram e não foram encontrados.**
```
Get-CCRepositoryBatch -RepositoryName MyDemoRepo, MyNewRepo, AMissingRepo
```
**Saída**:
```
Repositories RepositoriesNotFound
------------ --------------------
{MyDemoRepo, MyNewRepo} {AMissingRepo}
```
+ Para obter detalhes da API, consulte [BatchGetRepositories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CCRepositoryList`
O código de exemplo a seguir mostra como usar `Get-CCRepositoryList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os repositórios em ordem crescente por nome do repositório.**
```
Get-CCRepositoryList -Order Ascending -SortBy RepositoryName
```
**Saída**:
```
RepositoryId RepositoryName
------------ --------------
c7d0d2b0-ce40-4303-b4c3-38529EXAMPLE MyDemoRepo
05f30c66-e3e3-4f91-a0cd-1c84aEXAMPLE MyNewRepo
```
+ Para obter detalhes da API, consulte [ListRepositories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CCBranch`
O código de exemplo a seguir mostra como usar `New-CCBranch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma ramificação com o nome especificado para o repositório especificado e o ID do commit especificado.**
```
New-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch -CommitId 7763222d...561fc9c9
```
+ Para obter detalhes da API, consulte [CreateBranch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CCRepository`
O código de exemplo a seguir mostra como usar `New-CCRepository`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um repositório com o nome especificado e a descrição especificada.**
```
New-CCRepository -RepositoryName MyDemoRepo -RepositoryDescription "This is a repository for demonstration purposes."
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateRepository](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CCRepository`
O código de exemplo a seguir mostra como usar `Remove-CCRepository`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui forçosamente o repositório especificado. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir o repositório sem um aviso.**
```
Remove-CCRepository -RepositoryName MyDemoRepo
```
**Saída**:
```
43ef2443-3372-4b12-9e78-65c27EXAMPLE
```
+ Para obter detalhes da API, consulte [DeleteRepository](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CCDefaultBranch`
O código de exemplo a seguir mostra como usar `Update-CCDefaultBranch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera a ramificação padrão do repositório especificado para a ramificação especificada.**
```
Update-CCDefaultBranch -RepositoryName MyDemoRepo -DefaultBranchName MyNewBranch
```
+ Para obter detalhes da API, consulte [UpdateDefaultBranch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CCRepositoryDescription`
O código de exemplo a seguir mostra como usar `Update-CCRepositoryDescription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera a descrição do repositório especificado.**
```
Update-CCRepositoryDescription -RepositoryName MyDemoRepo -RepositoryDescription "This is an updated description."
```
+ Para obter detalhes da API, consulte [UpdateRepositoryDescription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CCRepositoryName`
O código de exemplo a seguir mostra como usar `Update-CCRepositoryName`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o nome do repositório especificado.**
```
Update-CCRepositoryName -NewName MyDemoRepo2 -OldName MyDemoRepo
```
+ Para obter detalhes da API, consulte [UpdateRepositoryName](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# CodeDeploy exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CodeDeploy.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-CDOnPremiseInstanceTag`
O código de exemplo a seguir mostra como usar `Add-CDOnPremiseInstanceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona uma tag de instância on-premises com a chave e o valor especificados para a instância local especificada.**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ Para obter detalhes da API, consulte [AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDApplication`
O código de exemplo a seguir mostra como usar `Get-CDApplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre a aplicação especificada.**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**Saída**:
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ Para obter detalhes da API, consulte [GetApplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDApplicationBatch`
O código de exemplo a seguir mostra como usar `Get-CDApplicationBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre as aplicações especificadas.**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**Saída**:
```
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 obter detalhes da API, consulte [BatchGetApplications](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDApplicationList`
O código de exemplo a seguir mostra como usar `Get-CDApplicationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista das aplicações disponíveis.**
```
Get-CDApplicationList
```
**Saída**:
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ Para obter detalhes da API, consulte [ListApplications](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDApplicationRevision`
O código de exemplo a seguir mostra como usar `Get-CDApplicationRevision`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre a revisão da aplicação 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)
```
**Saída**:
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ Para obter detalhes da API, consulte [GetApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDApplicationRevisionList`
O código de exemplo a seguir mostra como usar `Get-CDApplicationRevisionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre as revisões disponíveis para a aplicação 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)
>> }
>> }
>>
```
**Saída**:
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ Para obter detalhes da API, consulte [ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeployment`
O código de exemplo a seguir mostra como usar `Get-CDDeployment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações de resumo sobre a implantação especificada.**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo obtém informações sobre o status das instâncias que estão participando da implantação especificada.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**Saída**:
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**Exemplo 3: esse exemplo obtém informações sobre a revisão da aplicação para a implantação especificada.**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**Saída**:
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ Para obter detalhes da API, consulte [GetDeployment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentBatch`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre as implantações especificadas.**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**Saída**:
```
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 obter detalhes da API, consulte [BatchGetDeployments](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentConfig`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações de resumo sobre a configuração da implantação especificada.**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**Saída**:
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**Exemplo 2: esse exemplo obtém informações sobre a configuração da implantação especificada.**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**Saída**:
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ Para obter detalhes da API, consulte [GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentConfigList`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentConfigList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista das configurações de implantação disponíveis.**
```
Get-CDDeploymentConfigList
```
**Saída**:
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ Para obter detalhes da API, consulte [ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentGroup`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre o grupo de implantação especificado.**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Saída**:
```
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 obter detalhes da API, consulte [GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentGroupList`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentGroupList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista de grupos de implantação para a aplicação especificada.**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**Saída**:
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ Para obter detalhes da API, consulte [ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentInstance`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre a instância especificada para a implantação especificada.**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**Saída**:
```
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 obter detalhes da API, consulte [GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentInstanceList`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentInstanceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém uma lista de instâncias IDs para a implantação especificada.**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**Saída**:
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ Para obter detalhes da API, consulte [ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDDeploymentList`
O código de exemplo a seguir mostra como usar `Get-CDDeploymentList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém uma lista de implantações IDs para o aplicativo e o grupo de implantação especificados.**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**Saída**:
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ Para obter detalhes da API, consulte [ListDeployments](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDOnPremiseInstance`
O código de exemplo a seguir mostra como usar `Get-CDOnPremiseInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre a instância on-premises especificada.**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**Saída**:
```
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 obter detalhes da API, consulte [GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDOnPremiseInstanceBatch`
O código de exemplo a seguir mostra como usar `Get-CDOnPremiseInstanceBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre as instâncias on-premises especificadas.**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**Saída**:
```
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 obter detalhes da API, consulte [BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CDOnPremiseInstanceList`
O código de exemplo a seguir mostra como usar `Get-CDOnPremiseInstanceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista de nomes de instâncias on-premises disponíveis.**
```
Get-CDOnPremiseInstanceList
```
**Saída**:
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ Para obter detalhes da API, consulte [ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CDApplication`
O código de exemplo a seguir mostra como usar `New-CDApplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma aplicação com o nome especificado.**
```
New-CDApplication -ApplicationName MyNewApplication
```
**Saída**:
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ Para obter detalhes da API, consulte [CreateApplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CDDeployment`
O código de exemplo a seguir mostra como usar `New-CDDeployment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma implantação para a aplicação e o grupo de implantação especificados com a configuração de implantação e a revisão da aplicação 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
```
**Saída**:
```
d-ZHROG7UEX
```
**Exemplo 2: Este exemplo mostra como especificar grupos de tags de EC2 instância pelos quais uma instância deve ser identificada para que seja incluída no ambiente substituto de uma blue/green implantação.**
```
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"})
```
**Saída**:
```
d-ZHROG7UEX
```
+ Para obter detalhes da API, consulte [CreateDeployment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CDDeploymentConfig`
O código de exemplo a seguir mostra como usar `New-CDDeploymentConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma configuração de implantação com o nome e o comportamento especificados.**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**Saída**:
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ Para obter detalhes da API, consulte [CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CDDeploymentGroup`
O código de exemplo a seguir mostra como usar `New-CDDeploymentGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um grupo de implantação com o nome, o grupo do Auto Scaling, a configuração de implantação, a tag e o perfil de serviço especificados para a aplicação 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
```
**Saída**:
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**Exemplo 2: Este exemplo mostra como especificar grupos de tags de EC2 instância pelos quais uma instância deve ser identificada para que seja incluída no ambiente substituto de uma blue/green implantação.**
```
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"})
```
**Saída**:
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ Para obter detalhes da API, consulte [CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-CDApplicationRevision`
O código de exemplo a seguir mostra como usar `Register-CDApplicationRevision`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma revisão da aplicação com o local do Amazon S3 especificado para a aplicação 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 obter detalhes da API, consulte [RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-CDOnPremiseInstance`
O código de exemplo a seguir mostra como usar `Register-CDOnPremiseInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma instância on-premises com o nome e o usuário do IAM especificados.**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ Para obter detalhes da API, consulte [RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CDApplication`
O código de exemplo a seguir mostra como usar `Remove-CDApplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a aplicação com o nome especificado. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir a aplicação sem um aviso.**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ Para obter detalhes da API, consulte [DeleteApplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CDDeploymentConfig`
O código de exemplo a seguir mostra como usar `Remove-CDDeploymentConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a configuração de implantação com o nome especificado. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir a configuração de implantação sem um aviso.**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ Para obter detalhes da API, consulte [DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CDDeploymentGroup`
O código de exemplo a seguir mostra como usar `Remove-CDDeploymentGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o grupo de implantação com o nome especificado para a aplicação especificada. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir o grupo de implantação sem um aviso.**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ Para obter detalhes da API, consulte [DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CDOnPremiseInstanceTag`
O código de exemplo a seguir mostra como usar `Remove-CDOnPremiseInstanceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a tag especificada para a instância on-premises com o nome especificado. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir a tag sem um aviso.**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ Para obter detalhes da API, consulte [RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-CDDeployment`
O código de exemplo a seguir mostra como usar `Stop-CDDeployment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo tenta interromper a implantação com o ID de implantação especificado.**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**Saída**:
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ Para obter detalhes da API, consulte [StopDeployment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-CDOnPremiseInstance`
O código de exemplo a seguir mostra como usar `Unregister-CDOnPremiseInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela o registro de uma instância on-premises com o nome especificado.**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ Para obter detalhes da API, consulte [DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CDApplication`
O código de exemplo a seguir mostra como usar `Update-CDApplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o nome da aplicação especificada.**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ Para obter detalhes da API, consulte [UpdateApplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CDDeploymentGroup`
O código de exemplo a seguir mostra como usar `Update-CDDeploymentGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o nome do grupo de implantação especificado para a aplicação especificada.**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**Exemplo 2: Este exemplo mostra como especificar grupos de tags de EC2 instância pelos quais uma instância deve ser identificada para que seja incluída no ambiente substituto de uma blue/green implantação.**
```
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 obter detalhes da API, consulte [UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# CodePipeline exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com CodePipeline.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Confirm-CPJob`
O código de exemplo a seguir mostra como usar `Confirm-CPJob`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém o status do trabalho especificado.**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**Saída**:
```
Value
-----
InProgress
```
+ Para obter detalhes da API, consulte [AcknowledgeJob](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-CPStageTransition`
O código de exemplo a seguir mostra como usar `Disable-CPStageTransition`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desativa a transição de entrada para o estágio especificado no pipeline especificado.**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ Para obter detalhes da API, consulte [DisableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-CPStageTransition`
O código de exemplo a seguir mostra como usar `Enable-CPStageTransition`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo ativa a transição de entrada para o estágio especificado no pipeline especificado.**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ Para obter detalhes da API, consulte [EnableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPActionType`
O código de exemplo a seguir mostra como usar `Get-CPActionType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre as ações disponíveis para o proprietário 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)
}
```
**Saída**:
```
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 obter detalhes da API, consulte [ListActionTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPActionableJobList`
O código de exemplo a seguir mostra como usar `Get-CPActionableJobList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações sobre todos os trabalhos acionáveis para a categoria de ação, o proprietário, o provedor, a versão, os parâmetros de consulta especificados.**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**Saída**:
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ Para obter detalhes da API, consulte [PollForJobs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPJobDetail`
O código de exemplo a seguir mostra como usar `Get-CPJobDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações gerais sobre o trabalho especificado.**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Saída**:
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**Exemplo 2: esse exemplo obtém informações detalhadas sobre o trabalho 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)
```
**Saída**:
```
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 obter detalhes da API, consulte [GetJobDetails](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPPipeline`
O código de exemplo a seguir mostra como usar `Get-CPPipeline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações gerais sobre o pipeline especificado.**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**Saída**:
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**Exemplo 2: esse exemplo obtém informações detalhadas sobre o pipeline especificado.**
```
$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)
}
}
```
**Saída**:
```
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 obter detalhes da API, consulte [GetPipeline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPPipelineList`
O código de exemplo a seguir mostra como usar `Get-CPPipelineList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma lista dos pipelines disponíveis.**
```
Get-CPPipelineList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListPipelines](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CPPipelineState`
O código de exemplo a seguir mostra como usar `Get-CPPipelineState`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém informações gerais sobre os estágios do pipeline especificado.**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo obtém informações detalhadas sobre o estado do pipeline especificado.**
```
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)
}
}
```
**Saída**:
```
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 obter detalhes da API, consulte [GetPipelineState](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CPCustomActionType`
O código de exemplo a seguir mostra como usar `New-CPCustomActionType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma ação personalizada com as propriedades 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
```
**Saída**:
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ Para obter detalhes da API, consulte [CreateCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CPPipeline`
O código de exemplo a seguir mostra como usar `New-CPPipeline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um pipeline com as configurações especificadas.**
```
$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
```
**Saída**:
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ Para obter detalhes da API, consulte [CreatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CPCustomActionType`
O código de exemplo a seguir mostra como usar `Remove-CPCustomActionType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a ação personalizada especificada. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir a ação personalizada sem um aviso.**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ Para obter detalhes da API, consulte [DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CPPipeline`
O código de exemplo a seguir mostra como usar `Remove-CPPipeline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o pipeline especificado. O comando solicitará a confirmação antes de continuar. Adicione o parâmetro -Force para excluir o pipeline sem um aviso.**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ Para obter detalhes da API, consulte [DeletePipeline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-CPPipelineExecution`
O código de exemplo a seguir mostra como usar `Start-CPPipelineExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo começa a executar o pipeline especificado.**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ Para obter detalhes da API, consulte [StartPipelineExecution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CPPipeline`
O código de exemplo a seguir mostra como usar `Update-CPPipeline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza o pipeline existente especificado com as configurações especificadas.**
```
$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
```
**Saída**:
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ Para obter detalhes da API, consulte [UpdatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de identidade do Amazon Cognito usando ferramentas para V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon Cognito Identity.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-CGIIdentityPool`
O código de exemplo a seguir mostra como usar `Get-CGIIdentityPool`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Recupera informações sobre um banco de identidades específico por meio de seu ID.**
```
Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CGIIdentityPoolList`
O código de exemplo a seguir mostra como usar `Get-CGIIdentityPoolList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Recupera uma lista de bancos de identidades existentes.**
```
Get-CGIIdentityPoolList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListIdentityPools](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CGIIdentityPoolRole`
O código de exemplo a seguir mostra como usar `Get-CGIIdentityPoolRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Obtém as informações sobre as funções de um banco de identidades específico.**
```
Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**Saída**:
```
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 obter detalhes da API, consulte [GetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-CGIIdentityPool`
O código de exemplo a seguir mostra como usar `New-CGIIdentityPool`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Cria um novo banco de identidades que permite identidades não autenticadas.**
```
New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CGIIdentityPool`
O código de exemplo a seguir mostra como usar `Remove-CGIIdentityPool`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Exclui um banco de identidades específico.**
```
Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
+ Para obter detalhes da API, consulte [DeleteIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-CGIIdentityPoolRole`
O código de exemplo a seguir mostra como usar `Set-CGIIdentityPoolRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Configura o banco de identidades específico para ter um perfil do IAM não autenticado.**
```
Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }
```
+ Para obter detalhes da API, consulte [SetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-CGIIdentityPool`
O código de exemplo a seguir mostra como usar `Update-CGIIdentityPool`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Atualiza algumas das propriedades do banco de identidades, neste caso, o nome do banco de identidades.**
```
Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Config exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Config.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-CFGResourceTag`
O código de exemplo a seguir mostra como usar `Add-CFGResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa a tag especificada ao ARN do recurso, que, nesse caso, é config-rule/config-rule-16iyn0.**
```
Add-CFGResourceTag -ResourceArn arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-16iyn0 -Tag @{Key="Release";Value="Beta"}
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateComplianceByConfigRuleList`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateComplianceByConfigRuleList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo busca os detalhes da filtragem ConfigurationAggregator 'kaju' para a regra de configuração fornecida e a 'Conformidade' expands/returns da regra.**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK | Select-Object -ExpandProperty Compliance
```
**Saída**:
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
Amazon.ConfigService.Model.ComplianceContributorCount NON_COMPLIANT
```
**Exemplo 2: Este exemplo busca detalhes do dado ConfigurationAggregator, filtra para a conta específica para todas as regiões cobertas pelo agregador e retorna ainda mais a conformidade de todas as regras.**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_AccountId 123456789012 | Select-Object ConfigRuleName, @{N="Compliance";E={$_.Compliance.ComplianceType}}
```
**Saída**:
```
ConfigRuleName Compliance
-------------- ----------
ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK NON_COMPLIANT
ec2-instance-no-public-ip NON_COMPLIANT
desired-instance-type NON_COMPLIANT
```
+ Para obter detalhes da API, consulte [DescribeAggregateComplianceByConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateComplianceDetailsByConfigRule`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateComplianceDetailsByConfigRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna os resultados da avaliação selecionando a saída com resource-id e resource-type para a regra de AWS configuração '', que estão no estado desired-instance-type 'COMPATÍVEL' para a conta, agregador, região e regra de configuração fornecidos**
```
Get-CFGAggregateComplianceDetailsByConfigRule -AccountId 123456789012 -AwsRegion eu-west-1 -ComplianceType COMPLIANT -ConfigRuleName desired-instance-type -ConfigurationAggregatorName raju | Select-Object -ExpandProperty EvaluationResultIdentifier | Select-Object -ExpandProperty EvaluationResultQualifier
```
**Saída**:
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
desired-instance-type i-0f1bf2f34c5678d12 AWS::EC2::Instance
desired-instance-type i-0fd12dd3456789123 AWS::EC2::Instance
```
+ Para obter detalhes da API, consulte [GetAggregateComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateConfigRuleComplianceSummary`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateConfigRuleComplianceSummary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o número de regras não compatíveis para o agregador em questão.**
```
(Get-CFGAggregateConfigRuleComplianceSummary -ConfigurationAggregatorName raju).AggregateComplianceCounts.ComplianceSummary.NonCompliantResourceCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 5
```
+ Para obter detalhes da API, consulte [GetAggregateConfigRuleComplianceSummary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateDiscoveredResourceCount`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateDiscoveredResourceCount`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna a contagem de recursos do agregador especificado filtrado para a região us-east-1.**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1
```
**Saída**:
```
GroupByKey GroupedResourceCounts NextToken TotalDiscoveredResources
---------- --------------------- --------- ------------------------
{} 455
```
**Exemplo 2: esse exemplo retorna a contagem de recursos agrupada por RESOURCE\$1TYPE para a região filtrada de determinado agregador.**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1 -GroupByKey RESOURCE_TYPE |
Select-Object -ExpandProperty GroupedResourceCounts
```
**Saída**:
```
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 obter detalhes da API, consulte [GetAggregateDiscoveredResourceCounts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateDiscoveredResourceList`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateDiscoveredResourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna os identificadores de recursos para determinado tipo de recurso agregado no agregador “Irlanda”. Para ver a lista de tipos de recursos, consulte https://docs.aws.amazon.com/sdkfornet/ v4/ apidocs/index.html?page=ConfigService/TConfigServiceResourceType ConfigService .html&tocid=AMAZON\$1 \$1. ResourceType**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName Ireland -ResourceType ([Amazon.ConfigService.ResourceType]::AWSAutoScalingAutoScalingGroup)
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo retorna o tipo de recurso `AwsEC2SecurityGroup` chamado “padrão” para o agregador especificado filtrado com a região us-east-1.**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName raju -ResourceType ([Amazon.ConfigService.ResourceType]::AWSEC2SecurityGroup) -Filters_Region us-east-1 -Filters_ResourceName default
```
**Saída**:
```
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 obter detalhes da API, consulte [ListAggregateDiscoveredResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGAggregateResourceConfig`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateResourceConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o item de configuração para determinado recurso agregado e expande a configuração.**
```
(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
```
**Saída**:
```
{"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 obter detalhes da API, consulte [GetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference) em *Ferramentas da AWS para PowerShell Cmdlet Reference (*V5).
### `Get-CFGAggregateResourceConfigBatch`
O código de exemplo a seguir mostra como usar `Get-CFGAggregateResourceConfigBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca o item de configuração atual do recurso (identificado) presente no agregador fornecido.**
```
$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
```
**Saída**:
```
BaseConfigurationItems UnprocessedResourceIdentifiers
---------------------- ------------------------------
{} {arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa}
```
+ Para obter detalhes da API, consulte [BatchGetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference) em *Ferramentas da AWS para PowerShell Cmdlet Reference (*V5).
### `Get-CFGAggregationAuthorizationList`
O código de exemplo a seguir mostra como usar `Get-CFGAggregationAuthorizationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera as autorizações concedidas aos agregadores.**
```
Get-CFGAggregationAuthorizationList
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAggregationAuthorizations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceByConfigRule`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceByConfigRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo recupera detalhes de conformidade da regra ebs-optimized-instance, para os quais não há resultados de avaliação atuais para a regra, portanto, retorna INSUFFICIENT\$1DATA**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**Saída**:
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**Exemplo 2: este exemplo retorna o número de recursos que não estão em conformidade com a regra ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK.**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ Para obter detalhes da API, consulte [DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceByResource`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceByResource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo verifica o tipo de recurso `AWS::SSM::ManagedInstanceInventory` quanto ao tipo de conformidade “COMPLIANT”.**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**Saída**:
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ Para obter detalhes da API, consulte [DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceDetailsByConfigRule`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceDetailsByConfigRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém os resultados da avaliação da regra access-keys-rotated e retorna a saída agrupada por tipo de conformidade**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**Saída**:
```
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...
```
**Exemplo 2: Este exemplo consulta os detalhes de conformidade da regra access-keys-rotated para recursos COMPATÍVEIS.**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**Saída**:
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ Para obter detalhes da API, consulte [GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceDetailsByResource`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceDetailsByResource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo avalia resultados para um determinado recurso.**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**Saída**:
```
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 obter detalhes da API, consulte [GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceSummaryByConfigRule`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceSummaryByConfigRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o número de regras do Config que não estão em conformidade.**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**Saída**:
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ Para obter detalhes da API, consulte [GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGComplianceSummaryByResourceType`
O código de exemplo a seguir mostra como usar `Get-CFGComplianceSummaryByResourceType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o número de recursos que estão em conformidade ou não e converte a saída em 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 obter detalhes da API, consulte [GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigRule`
O código de exemplo a seguir mostra como usar `Get-CFGConfigRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo lista as regras de configuração da conta, com propriedades selecionadas.**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigRuleEvaluationStatus`
O código de exemplo a seguir mostra como usar `Get-CFGConfigRuleEvaluationStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna as informações de status das regras de configuração fornecidas. **
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigurationAggregatorList`
O código de exemplo a seguir mostra como usar `Get-CFGConfigurationAggregatorList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra retorna todos os agregadores da região/conta.**
```
Get-CFGConfigurationAggregatorList
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConfigurationAggregators](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigurationAggregatorSourcesStatus`
O código de exemplo a seguir mostra como usar `Get-CFGConfigurationAggregatorSourcesStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra exibe os campos solicitados para as origens em determinado agregador.**
```
Get-CFGConfigurationAggregatorSourcesStatus -ConfigurationAggregatorName raju | select SourceType, LastUpdateStatus, LastUpdateTime, SourceId
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConfigurationAggregatorSourcesStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigurationRecorder`
O código de exemplo a seguir mostra como usar `Get-CFGConfigurationRecorder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna os detalhes dos gravadores de configuração.**
```
Get-CFGConfigurationRecorder | Format-List
```
**Saída**:
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ Para obter detalhes da API, consulte [DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConfigurationRecorderStatus`
O código de exemplo a seguir mostra como usar `Get-CFGConfigurationRecorderStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o status dos gravadores de configuração. **
```
Get-CFGConfigurationRecorderStatus
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGConformancePack`
O código de exemplo a seguir mostra como usar `Get-CFGConformancePack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os pacotes de conformidade.**
```
Get-CFGConformancePack
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeConformancePacks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGDeliveryChannel`
O código de exemplo a seguir mostra como usar `Get-CFGDeliveryChannel`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera o canal de entrega da região e exibe detalhes.**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**Saída**:
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ Para obter detalhes da API, consulte [DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-CFGResourceTag`
O código de exemplo a seguir mostra como usar `Get-CFGResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as tags associadas a determinado recurso**
```
Get-CFGResourceTag -ResourceArn $rules[0].ConfigRuleArn
```
**Saída**:
```
Key Value
--- -----
Version 1.3
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-CFGConformancePack`
O código de exemplo a seguir mostra como usar `Remove-CFGConformancePack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra remove o pacote de conformidade fornecido, junto com todas as regras, as ações de remediação e os resultados de avaliação do pacote.**
```
Remove-CFGConformancePack -ConformancePackName dono
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-CFGConformancePack`
O código de exemplo a seguir mostra como usar `Write-CFGConformancePack`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um pacote de conformidade, buscando o modelo do arquivo yaml fornecido. **
```
Write-CFGConformancePack -ConformancePackName dono -DeliveryS3Bucket amzn-s3-demo-bucket -TemplateBody (Get-Content C:\windows\temp\template.yaml -Raw)
```
+ Para obter detalhes da API, consulte [PutConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-CFGDeliveryChannel`
O código de exemplo a seguir mostra como usar `Write-CFGDeliveryChannel`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo altera a propriedade deliveryFrequency de um canal de entrega existente.**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ Para obter detalhes da API, consulte [PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Device Farm usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Device Farm.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `New-DFUpload`
O código de exemplo a seguir mostra como usar `New-DFUpload`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um upload AWS do Device Farm para um aplicativo Android. Você pode obter o ARN do projeto a partir da saída de New- DFProject ou Get- DFProject List. Use a URL assinada na DFUpload saída New- para carregar um arquivo no 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 obter detalhes da API, consulte [CreateUpload](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Directory Service exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Directory Service.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-DSIpRoute`
O código de exemplo a seguir mostra como usar `Add-DSIpRoute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando remove a tag de recurso atribuída ao ID de diretório especificado**
```
Add-DSIpRoute -DirectoryId d-123456ijkl -IpRoute @{CidrIp ="203.0.113.5/32"} -UpdateSecurityGroupForDirectoryController $true
```
+ Para obter detalhes da API, consulte [AddIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-DSResourceTag`
O código de exemplo a seguir mostra como usar `Add-DSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando adiciona a tag de recurso ao ID de diretório especificado**
```
Add-DSResourceTag -ResourceId d-123456ijkl -Tag @{Key="myTag"; Value="mytgValue"}
```
+ Para obter detalhes da API, consulte [AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Approve-DSTrust`
O código de exemplo a seguir mostra como usar `Approve-DSTrust`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo chama a operação da VerifyTrust API AWS Directory Service para o Trustid especificado.**
```
Approve-DSTrust -TrustId t-9067157123
```
+ Para obter detalhes da API, consulte [VerifyTrust](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Confirm-DSSharedDirectory`
O código de exemplo a seguir mostra como usar `Confirm-DSSharedDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo aceita uma solicitação de compartilhamento de diretório enviada pelo proprietário do diretório Conta da AWS.**
```
Confirm-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**Saída**:
```
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 obter detalhes da API, consulte [AcceptSharedDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Connect-DSDirectory`
O código de exemplo a seguir mostra como usar `Connect-DSDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um AD Connector para conexão com um diretório on-premises.**
```
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 obter detalhes da API, consulte [ConnectDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Deny-DSSharedDirectory`
O código de exemplo a seguir mostra como usar `Deny-DSSharedDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo rejeita uma solicitação de compartilhamento de diretório que foi enviada da conta do proprietário do diretório.**
```
Deny-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**Saída**:
```
d-9067012345
```
+ Para obter detalhes da API, consulte [RejectSharedDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-DSDirectoryShare`
O código de exemplo a seguir mostra como usar `Disable-DSDirectoryShare`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo interrompe o compartilhamento de diretório entre o proprietário do diretório e a conta de consumidor.**
```
Disable-DSDirectoryShare -DirectoryId d-123456ijkl -UnshareTarget_Id 123456784321 -UnshareTarget_Type ACCOUNT
```
**Saída**:
```
d-9067012345
```
+ Para obter detalhes da API, consulte [UnshareDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-DSLDAPS`
O código de exemplo a seguir mostra como usar `Disable-DSLDAPS`.
**Ferramentas para PowerShell V5**
**Exemplo 1:esse exemplo desativa as chamadas de segurança de LDAP para o diretório especificado.**
```
Disable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ Consulte detalhes da API em [DisableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
### `Disable-DSRadius`
O código de exemplo a seguir mostra como usar `Disable-DSRadius`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desativa o servidor RADIUS configurado para um diretório do AD Connector ou do Microsoft AD.**
```
Disable-DSRadius -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [DisableRadius](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-DSSso`
O código de exemplo a seguir mostra como usar `Disable-DSSso`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desativa o login único para um diretório.**
```
Disable-DSSso -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [DisableSso](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-DSDirectoryShare`
O código de exemplo a seguir mostra como usar `Enable-DSDirectoryShare`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo compartilha um diretório específico em sua AWS conta com outra AWS conta usando o método Handshake.**
```
Enable-DSDirectoryShare -DirectoryId d-123456ijkl -ShareTarget_Id 123456784321 -ShareMethod HANDSHAKE -ShareTarget_Type ACCOUNT
```
**Saída**:
```
d-9067012345
```
+ Para obter detalhes da API, consulte [ShareDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-DSLDAPS`
O código de exemplo a seguir mostra como usar `Enable-DSLDAPS`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo ativa a opção para o diretório especificado para sempre usar chamadas seguras LDAP.**
```
Enable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ Consulte detalhes da API em [EnableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
### `Enable-DSRadius`
O código de exemplo a seguir mostra como usar `Enable-DSRadius`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita a autenticação multifator (MFA) com a configuração do servidor RADIUS fornecida para um diretório do AD Connector ou do 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 obter detalhes da API, consulte [EnableRadius](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-DSSso`
O código de exemplo a seguir mostra como usar `Enable-DSSso`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo ativa o login único para um diretório. **
```
Enable-DSSso -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [EnableSso](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSCertificate`
O código de exemplo a seguir mostra como usar `Get-DSCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe informações sobre o certificado registrado para uma conexão LDAP segura.**
```
Get-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSCertificateList`
O código de exemplo a seguir mostra como usar `Get-DSCertificateList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os certificados registrados para uma conexão LDAP segura para o diretório especificado.**
```
Get-DSCertificateList -DirectoryId d-123456ijkl
```
**Saída**:
```
CertificateId CommonName ExpiryDateTime State
------------- ---------- -------------- -----
c-906731e34f contoso-EC2AMAZ-CTGG2NM-CA 4/15/2025 6:34:15 PM Registered
```
+ Para obter detalhes da API, consulte [ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSConditionalForwarder`
O código de exemplo a seguir mostra como usar `Get-DSConditionalForwarder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém todos os encaminhadores condicionais configurados de determinado ID de diretório.**
```
Get-DSConditionalForwarder -DirectoryId d-123456ijkl
```
**Saída**:
```
DnsIpAddrs RemoteDomainName ReplicationScope
---------- ---------------- ----------------
{172.31.77.239} contoso.com Domain
```
+ Para obter detalhes da API, consulte [DescribeConditionalForwarders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSDirectory`
O código de exemplo a seguir mostra como usar `Get-DSDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém informações sobre os diretórios que pertencem a essa conta.**
```
Get-DSDirectory | Select-Object DirectoryId, Name, DnsIpAddrs, Type
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeDirectories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSDirectoryLimit`
O código de exemplo a seguir mostra como usar `Get-DSDirectoryLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra as informações de limite de diretórios da região us-east-1.**
```
Get-DSDirectoryLimit -Region us-east-1
```
**Saída**:
```
CloudOnlyDirectoriesCurrentCount : 1
CloudOnlyDirectoriesLimit : 10
CloudOnlyDirectoriesLimitReached : False
CloudOnlyMicrosoftADCurrentCount : 1
CloudOnlyMicrosoftADLimit : 20
CloudOnlyMicrosoftADLimitReached : False
ConnectedDirectoriesCurrentCount : 1
ConnectedDirectoriesLimit : 10
```
+ Para obter detalhes da API, consulte [GetDirectoryLimits](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSDomainControllerList`
O código de exemplo a seguir mostra como usar `Get-DSDomainControllerList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém a lista detalhada dos controladores de domínio lançados para o ID de diretório mencionado.**
```
Get-DSDomainControllerList -DirectoryId d-123456ijkl
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSEventTopic`
O código de exemplo a seguir mostra como usar `Get-DSEventTopic`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando mostra informações do tópico do SNS configurado para notificação enquanto o status do diretório é alterado.**
```
Get-DSEventTopic -DirectoryId d-123456ijkl
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeEventTopics](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSIpRouteList`
O código de exemplo a seguir mostra como usar `Get-DSIpRouteList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém os blocos de endereços IP públicos configurados no roteamento IP do diretório.**
```
Get-DSIpRouteList -DirectoryId d-123456ijkl
```
**Saída**:
```
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 obter detalhes da API, consulte [ListIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSLDAPSSetting`
O código de exemplo a seguir mostra como usar `Get-DSLDAPSSetting`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o status da segurança LDAP do diretório especificado.**
```
Get-DSLDAPSSetting -DirectoryId d-123456ijkl
```
**Saída**:
```
LastUpdatedDateTime LDAPSStatus LDAPSStatusReason
------------------- ----------- -----------------
4/15/2020 6:51:03 PM Enabled LDAPS is enabled successfully.
```
+ Para obter detalhes da API, consulte [Descrever LDAPSSettings](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `Get-DSLogSubscriptionList`
O código de exemplo a seguir mostra como usar `Get-DSLogSubscriptionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém as informações de assinaturas de log do ID do diretório especificado**
```
Get-DSLogSubscriptionList -DirectoryId d-123456ijkl
```
**Saída**:
```
DirectoryId LogGroupName SubscriptionCreatedDateTime
----------- ------------ ---------------------------
d-123456ijkl /aws/directoryservice/d-123456ijkl-lan2.example.com 12/14/2019 9:05:23 AM
```
+ Para obter detalhes da API, consulte [ListLogSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSResourceTag`
O código de exemplo a seguir mostra como usar `Get-DSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém todas as tags do diretório especificado.**
```
Get-DSResourceTag -ResourceId d-123456ijkl
```
**Saída**:
```
Key Value
--- -----
myTag myTagValue
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSSchemaExtension`
O código de exemplo a seguir mostra como usar `Get-DSSchemaExtension`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as extensões de esquema aplicadas a um Microsoft AD Directory.**
```
Get-DSSchemaExtension -DirectoryId d-123456ijkl
```
**Saída**:
```
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 obter detalhes da API, consulte [ListSchemaExtensions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSSharedDirectory`
O código de exemplo a seguir mostra como usar `Get-DSSharedDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém os diretórios compartilhados da sua conta AWS **
```
Get-DSSharedDirectory -OwnerDirectoryId d-123456ijkl -SharedDirectoryId d-9067012345
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSharedDirectories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSSnapshot`
O código de exemplo a seguir mostra como usar `Get-DSSnapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém informações sobre os snapshots do diretório especificado que pertencem a essa conta.**
```
Get-DSSnapshot -DirectoryId d-123456ijkl
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSSnapshotLimit`
O código de exemplo a seguir mostra como usar `Get-DSSnapshotLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém os limites manuais de snapshot para um diretório especificado.**
```
Get-DSSnapshotLimit -DirectoryId d-123456ijkl
```
**Saída**:
```
ManualSnapshotsCurrentCount ManualSnapshotsLimit ManualSnapshotsLimitReached
--------------------------- -------------------- ---------------------------
0 5 False
```
+ Para obter detalhes da API, consulte [GetSnapshotLimits](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DSTrust`
O código de exemplo a seguir mostra como usar `Get-DSTrust`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando obtém as informações das relações de confiança criadas para o ID de diretório especificado.**
```
Get-DSTrust -DirectoryId d-123456abcd
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeTrusts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSAlias`
O código de exemplo a seguir mostra como usar `New-DSAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando cria um alias para um diretório e atribui esse alias ao directory-id especificado.**
```
New-DSAlias -DirectoryId d-123456ijkl -Alias MyOrgName
```
**Saída**:
```
Alias DirectoryId
----- -----------
myorgname d-123456ijkl
```
+ Para obter detalhes da API, consulte [CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSComputer`
O código de exemplo a seguir mostra como usar `New-DSComputer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um objeto de computador do Active Directory.**
```
New-DSComputer -DirectoryId d-123456ijkl -ComputerName ADMemberServer -Password $Password
```
**Saída**:
```
ComputerAttributes ComputerId ComputerName
------------------ ---------- ------------
{WindowsSamName, DistinguishedName} S-1-5-21-1191241402-978882507-2717148213-1662 ADMemberServer
```
+ Para obter detalhes da API, consulte [CreateComputer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSConditionalForwarder`
O código de exemplo a seguir mostra como usar `New-DSConditionalForwarder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um encaminhador condicional no ID de diretório especificado AWS .**
```
New-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.10.56 -RemoteDomainName contoso.com
```
+ Para obter detalhes da API, consulte [CreateConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSDirectory`
O código de exemplo a seguir mostra como usar `New-DSDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um diretório do Simple AD.**
```
New-DSDirectory -Name corp.example.com -Password $Password -Size Small -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ Para obter detalhes da API, consulte [CreateDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSLogSubscription`
O código de exemplo a seguir mostra como usar `New-DSLogSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma assinatura para encaminhar registros de segurança do controlador de domínio do Directory Service em tempo real para o grupo de CloudWatch registros da Amazon especificado em seu Conta da AWS.**
```
New-DSLogSubscription -DirectoryId d-123456ijkl -LogGroupName /aws/directoryservice/d-123456ijkl-lan2.example.com
```
+ Para obter detalhes da API, consulte [CreateLogSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSMicrosoftAD`
O código de exemplo a seguir mostra como usar `New-DSMicrosoftAD`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um novo Microsoft AD Directory em Nuvem AWS.**
```
New-DSMicrosoftAD -Name corp.example.com -Password $Password -edition Standard -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ Para obter detalhes da API, consulte [CreateMicrosoftAD](https://docs.aws.amazon.com/powershell/v5/reference) em *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `New-DSSnapshot`
O código de exemplo a seguir mostra como usar `New-DSSnapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um snapshot do diretório**
```
New-DSSnapshot -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DSTrust`
O código de exemplo a seguir mostra como usar `New-DSTrust`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria confiança bidirecional em toda a floresta entre seu diretório gerenciado AWS do Microsoft AD e o 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
```
**Saída**:
```
t-9067157123
```
+ Para obter detalhes da API, consulte [CreateTrust](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-DSCertificate`
O código de exemplo a seguir mostra como usar `Register-DSCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra um certificado para conexão LDAP segura.**
```
$Certificate = Get-Content contoso.cer -Raw
Register-DSCertificate -DirectoryId d-123456ijkl -CertificateData $Certificate
```
**Saída**:
```
c-906731e350
```
+ Para obter detalhes da API, consulte [RegisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-DSEventTopic`
O código de exemplo a seguir mostra como usar `Register-DSEventTopic`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa um diretório como publicador a um tópico do SNS.**
```
Register-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ Para obter detalhes da API, consulte [RegisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSConditionalForwarder`
O código de exemplo a seguir mostra como usar `Remove-DSConditionalForwarder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove o encaminhador condicional que foi configurado para seu AWS Diretório.**
```
Remove-DSConditionalForwarder -DirectoryId d-123456ijkl -RemoteDomainName contoso.com
```
+ Para obter detalhes da API, consulte [DeleteConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSDirectory`
O código de exemplo a seguir mostra como usar `Remove-DSDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui um AWS diretório de serviços de diretório (conector AD/Microsoft AD/AD simples)**
```
Remove-DSDirectory -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [DeleteDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSIpRoute`
O código de exemplo a seguir mostra como usar `Remove-DSIpRoute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando remove o IP especificado das rotas de IP configuradas do ID do diretório.**
```
Remove-DSIpRoute -DirectoryId d-123456ijkl -CidrIp 203.0.113.5/32
```
+ Para obter detalhes da API, consulte [RemoveIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSLogSubscription`
O código de exemplo a seguir mostra como usar `Remove-DSLogSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando remove a assinatura de log do ID do diretório especificado**
```
Remove-DSLogSubscription -DirectoryId d-123456ijkl
```
+ Para obter detalhes da API, consulte [DeleteLogSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSResourceTag`
O código de exemplo a seguir mostra como usar `Remove-DSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando remove a tag de recurso atribuída ao ID de diretório especificado**
```
Remove-DSResourceTag -ResourceId d-123456ijkl -TagKey myTag
```
+ Para obter detalhes da API, consulte [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSSnapshot`
O código de exemplo a seguir mostra como usar `Remove-DSSnapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o snapshot criado manualmente.**
```
Remove-DSSnapshot -SnapshotId s-9068b488kc
```
+ Para obter detalhes da API, consulte [DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DSTrust`
O código de exemplo a seguir mostra como usar `Remove-DSTrust`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo remove a relação de confiança existente entre seu diretório AWS gerenciado do AD e um domínio externo.**
```
Get-DSTrust -DirectoryId d-123456ijkl -Select Trusts.TrustId | Remove-DSTrust
```
**Saída**:
```
t-9067157123
```
+ Para obter detalhes da API, consulte [DeleteTrust](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-DSUserPassword`
O código de exemplo a seguir mostra como usar `Reset-DSUserPassword`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo redefine a senha do usuário do Active Directory nomeado ADUser em AWS Managed microsoft AD ou Simple AD Directory**
```
Reset-DSUserPassword -UserName ADuser -DirectoryId d-123456ijkl -NewPassword $Password
```
+ Para obter detalhes da API, consulte [ResetUserPassword](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Restore-DSFromSnapshot`
O código de exemplo a seguir mostra como usar `Restore-DSFromSnapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo restaura um diretório usando um snapshot de diretório existente.**
```
Restore-DSFromSnapshot -SnapshotId s-9068b488kc
```
+ Para obter detalhes da API, consulte [RestoreFromSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-DSDomainControllerCount`
O código de exemplo a seguir mostra como usar `Set-DSDomainControllerCount`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo define o número do controlador de domínio como 3 para o ID de diretório especificado.**
```
Set-DSDomainControllerCount -DirectoryId d-123456ijkl -DesiredNumber 3
```
+ Para obter detalhes da API, consulte [UpdateNumberOfDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-DSSchemaExtension`
O código de exemplo a seguir mostra como usar `Start-DSSchemaExtension`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo aplica uma extensão de esquema a um diretório do Microsoft AD.**
```
$ldif = Get-Content D:\Users\Username\Downloads\ExtendedSchema.ldf -Raw
Start-DSSchemaExtension -DirectoryId d-123456ijkl -CreateSnapshotBeforeSchemaExtension $true -Description ManagedADSchemaExtension -LdifContent $ldif
```
**Saída**:
```
e-9067306643
```
+ Para obter detalhes da API, consulte [StartSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-DSSchemaExtension`
O código de exemplo a seguir mostra como usar `Stop-DSSchemaExtension`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela uma extensão de esquema em andamento para um diretório do Microsoft AD.**
```
Stop-DSSchemaExtension -DirectoryId d-123456ijkl -SchemaExtensionId e-9067306643
```
+ Para obter detalhes da API, consulte [CancelSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-DSCertificate`
O código de exemplo a seguir mostra como usar `Unregister-DSCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui do sistema o certificado que foi registrado para uma conexão LDAP segura.**
```
Unregister-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
+ Para obter detalhes da API, consulte [DeregisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-DSEventTopic`
O código de exemplo a seguir mostra como usar `Unregister-DSEventTopic`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o diretório especificado como um publicador para o tópico do SNS especificado.**
```
Unregister-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ Para obter detalhes da API, consulte [DeregisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-DSConditionalForwarder`
O código de exemplo a seguir mostra como usar `Update-DSConditionalForwarder`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza um encaminhador condicional que foi configurado para seu AWS diretório.**
```
Update-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.16.108 -RemoteDomainName contoso.com
```
+ Para obter detalhes da API, consulte [UpdateConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-DSRadius`
O código de exemplo a seguir mostra como usar `Update-DSRadius`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza as informações do servidor RADIUS para um diretório do AD Connector ou do Microsoft AD.**
```
Update-DSRadius -DirectoryId d-123456ijkl -RadiusSettings_RadiusRetry 3
```
+ Para obter detalhes da API, consulte [UpdateRadius](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-DSTrust`
O código de exemplo a seguir mostra como usar `Update-DSTrust`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza o SelectiveAuth parâmetro do trust-id especificado de Desativado para Ativado.**
```
Update-DSTrust -TrustId t-9067157123 -SelectiveAuth Enabled
```
**Saída**:
```
RequestId TrustId
--------- -------
138864a7-c9a8-4ad1-a828-eae479e85b45 t-9067157123
```
+ Para obter detalhes da API, consulte [UpdateTrust](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS DMS exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS DMS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `New-DMSReplicationTask`
O código de exemplo a seguir mostra como usar `New-DMSReplicationTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova tarefa de replicação do AWS Database Migration Service que usa CdcStartTime em vez de CdcStartPosition. O MigrationType é definido como "full-load-and-cdc“, o que significa que a tabela de destino deve estar vazia. A nova tarefa é marcada com uma tag que tem uma chave de Estágio e um valor de chave de Teste. Para obter mais informações sobre os valores usados por esse cmdlet, consulte Creating a Task (https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Tasks.Creating.html) no Guia do Usuário do 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 obter detalhes da API, consulte [CreateReplicationTask](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do DynamoDB usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o DynamoDB.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-DDBIndexSchema`
O código de exemplo a seguir mostra como usar `Add-DDBIndexSchema`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um TableSchema objeto vazio e adiciona uma nova definição de índice secundário local a ele antes de gravar o TableSchema objeto no pipeline.**
```
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema = New-DDBTableSchema
```
**Saída**:
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
**Exemplo 2: adiciona uma nova definição de índice secundário local ao TableSchema objeto fornecido antes de gravar o TableSchema objeto de volta no pipeline. O TableSchema objeto também pode ser fornecido usando o parâmetro -Schema.**
```
New-DDBTableSchema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
```
**Saída**:
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
+ Para obter detalhes da API, consulte [Adicionar DDBIndex esquema](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (*V5).
### `Add-DDBKeySchema`
O código de exemplo a seguir mostra como usar `Add-DDBKeySchema`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um TableSchema objeto vazio e adiciona entradas de definição de chave e atributo a ele usando os dados-chave especificados antes de gravar o TableSchema objeto no pipeline. O tipo de chave é declarado como 'HASH' por padrão; use o KeyType parâmetro - com um valor de 'RANGE' para declarar uma chave de intervalo.**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Saída**:
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
**Exemplo 2: adiciona novas entradas de definição de chave e atributo ao TableSchema objeto fornecido antes de gravar o TableSchema objeto no pipeline. O tipo de chave é declarado como 'HASH' por padrão; use o KeyType parâmetro - com um valor de 'RANGE' para declarar uma chave de intervalo. O TableSchema objeto também pode ser fornecido usando o parâmetro -Schema.**
```
New-DDBTableSchema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**Saída**:
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
+ Para obter detalhes da API, consulte [Adicionar DDBKey esquema](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (*V5).
### `ConvertFrom-DDBItem`
O código de exemplo a seguir mostra como usar `ConvertFrom-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: ConvertFrom - DDBItem é usado para converter o resultado de uma tabela de hash Get-DDBItem do AttributeValues DynamoDB em uma tabela de hash de tipos comuns, como string e double.**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Saída**:
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para obter detalhes da API, consulte [ConvertFrom- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `ConvertTo-DDBItem`
O código de exemplo a seguir mostra como usar `ConvertTo-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: um exemplo de conversão de uma tabela de hash em um dicionário de valores de atributos do 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
```
**Exemplo 2: um exemplo de conversão de uma tabela de hash em um dicionário de valores de atributos do 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
```
**Saída**:
```
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 obter detalhes da API, consulte [ConvertTo- DDBItem](https://docs.aws.amazon.com/powershell/v5/reference) em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DDBBatchItem`
O código de exemplo a seguir mostra como usar `Get-DDBBatchItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: obtém o item com o SongTitle “Somewhere Down The Road” das tabelas 'Music' e 'Songs' do 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
```
**Saída**:
```
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 obter detalhes da API, consulte [BatchGetItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DDBItem`
O código de exemplo a seguir mostra como usar `Get-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o item do DynamoDB com a chave de partição e a SongTitle chave de classificação Artist.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**Saída**:
```
Name Value
---- -----
Genre Country
SongTitle Somewhere Down The Road
Price 1.94
Artist No One You Know
CriticRating 9
AlbumTitle Somewhat Famous
```
+ Para obter detalhes da API, consulte [GetItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DDBTable`
O código de exemplo a seguir mostra como usar `Get-DDBTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exibe detalhes da tabela especificada.**
```
Get-DDBTable -TableName "myTable"
```
+ Para obter detalhes da API, consulte [DescribeTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-DDBTableList`
O código de exemplo a seguir mostra como usar `Get-DDBTableList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exibe detalhes de todas as tabelas, iterando automaticamente até que o serviço indique que não existem mais tabelas.**
```
Get-DDBTableList
```
+ Para obter detalhes da API, consulte [ListTables](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Invoke-DDBQuery`
O código de exemplo a seguir mostra como usar `Invoke-DDBQuery`.
**Ferramentas para PowerShell V5**
**Exemplo 1: invoca uma consulta que retorna itens do DynamoDB com o especificado e o artista. 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
```
**Saída**:
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para ver detalhes da API, consulte [Query](https://docs.aws.amazon.com/powershell/v5/reference) na *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Invoke-DDBScan`
O código de exemplo a seguir mostra como usar `Invoke-DDBScan`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exibe todos os itens da tabela Music.**
```
Invoke-DDBScan -TableName 'Music' | ConvertFrom-DDBItem
```
**Saída**:
```
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
```
**Exemplo 2: Retorna itens na tabela Música com um valor CriticRating maior ou igual a nove.**
```
$scanFilter = @{
CriticRating = [Amazon.DynamoDBv2.Model.Condition]@{
AttributeValueList = @(@{N = '9'})
ComparisonOperator = 'GE'
}
}
Invoke-DDBScan -TableName 'Music' -ScanFilter $scanFilter | ConvertFrom-DDBItem
```
**Saída**:
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ Para ver detalhes da API, consulte [Scan](https://docs.aws.amazon.com/powershell/v5/reference) na *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `New-DDBTable`
O código de exemplo a seguir mostra como usar `New-DDBTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma tabela chamada Thread que tem uma chave primária que consiste em 'ForumName' (hash do tipo de chave) e 'Subject' (intervalo de tipos de chave). O esquema usado para construir a tabela pode ser canalizado para cada cmdlet conforme mostrado ou especificado usando o 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
```
**Saída**:
```
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 : {}
```
**Exemplo 2: Este exemplo cria uma tabela chamada Thread que tem uma chave primária que consiste em 'ForumName' (hash do tipo de chave) e 'Subject' (intervalo de tipos de chave). Um índice secundário local também é definido. A chave do índice secundário local será definida automaticamente a partir da chave de hash primária na tabela (ForumName). O esquema usado para construir a tabela pode ser canalizado para cada cmdlet conforme mostrado ou especificado usando o 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
```
**Saída**:
```
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}
```
**Exemplo 3: Este exemplo mostra como usar um único pipeline para criar uma tabela chamada Thread que tem uma chave primária que consiste em 'ForumName' (hash do tipo de chave) e 'Subject' (intervalo de tipos de chave) e um índice secundário local. O Add- DDBKey Schema e o Add- DDBIndex Schema criam um novo TableSchema objeto para você se um não for fornecido pelo pipeline ou pelo parâmetro -Schema.**
```
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
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-DDBTableSchema`
O código de exemplo a seguir mostra como usar `New-DDBTableSchema`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um TableSchema objeto vazio pronto para aceitar definições de chave e índice para uso na criação de uma nova tabela do Amazon DynamoDB. O objeto retornado pode ser canalizado para os DDBTable cmdlets Add- DDBKey Schema, DDBIndex Add-Schema e New- ou passado para eles usando o parâmetro -Schema em cada cmdlet.**
```
New-DDBTableSchema
```
**Saída**:
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{} {} {}
```
+ Para obter detalhes da API, consulte [New- DDBTable Schema](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (*V5).
### `Remove-DDBItem`
O código de exemplo a seguir mostra como usar `Remove-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: remove o item do DynamoDB que corresponde à chave fornecida.**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false
```
+ Para obter detalhes da API, consulte [DeleteItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-DDBTable`
O código de exemplo a seguir mostra como usar `Remove-DDBTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a tabela especificada. A confirmação será solicitada antes que a operação continue.**
```
Remove-DDBTable -TableName "myTable"
```
**Exemplo 2: exclui a tabela especificada. A confirmação não será solicitada antes que a operação continue.**
```
Remove-DDBTable -TableName "myTable" -Force
```
+ Para obter detalhes da API, consulte [DeleteTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-DDBBatchItem`
O código de exemplo a seguir mostra como usar `Set-DDBBatchItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um item ou substitui um item por um novo item nas tabelas Music e Songs do 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 obter detalhes da API, consulte [BatchWriteItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-DDBItem`
O código de exemplo a seguir mostra como usar `Set-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um item ou substitui um item por um novo item.**
```
$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 obter detalhes da API, consulte [PutItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-DDBItem`
O código de exemplo a seguir mostra como usar `Update-DDBItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: define o atributo de gênero como 'Rap' no item do DynamoDB com a chave de partição e a SongTitle chave de classificação 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
```
**Saída**:
```
Name Value
---- -----
Genre Rap
```
+ Para obter detalhes da API, consulte [UpdateItem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-DDBTable`
O código de exemplo a seguir mostra como usar `Update-DDBTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza os valores de throughput provisionado da tabela especificada.**
```
Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5
```
+ Para obter detalhes da API, consulte [UpdateTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# EC2 Exemplos da Amazon usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com a Amazon EC2.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-EC2CapacityReservation`
O código de exemplo a seguir mostra como usar `Add-EC2CapacityReservation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma reserva de capacidade com os atributos especificados.**
```
Add-EC2CapacityReservation -InstanceType m4.xlarge -InstanceCount 2 -AvailabilityZone eu-west-1b -EbsOptimized True -InstancePlatform Windows
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-EC2InternetGateway`
O código de exemplo a seguir mostra como usar `Add-EC2InternetGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo anexa o gateway da internet especificado à VPC especificada**.
```
Add-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
**Exemplo 2: esse exemplo cria uma VPC e um gateway da internet e, depois, conecta o gateway da internet à VPC.**
```
$vpc = New-EC2Vpc -CidrBlock 10.0.0.0/16
New-EC2InternetGateway | Add-EC2InternetGateway -VpcId $vpc.VpcId
```
+ Para obter detalhes da API, consulte [AttachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-EC2NetworkInterface`
O código de exemplo a seguir mostra como usar `Add-EC2NetworkInterface`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo anexa a interface de rede especificada à instância especificada.**
```
Add-EC2NetworkInterface -NetworkInterfaceId eni-12345678 -InstanceId i-1a2b3c4d -DeviceIndex 1
```
**Saída**:
```
eni-attach-1a2b3c4d
```
+ Para obter detalhes da API, consulte [AttachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-EC2Volume`
O código de exemplo a seguir mostra como usar `Add-EC2Volume`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo anexa o volume especificado à instância especificada e o expõe com o nome do dispositivo especificado.**
```
Add-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
**Saída**:
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : attaching
VolumeId : vol-12345678
```
+ Para obter detalhes da API, consulte [AttachVolume](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-EC2VpnGateway`
O código de exemplo a seguir mostra como usar `Add-EC2VpnGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo anexa o gateway privado virtual especificado à VPC especificada.**
```
Add-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
**Saída**:
```
State VpcId
----- -----
attaching vpc-12345678
```
+ Para obter detalhes da API, consulte [AttachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Approve-EC2VpcPeeringConnection`
O código de exemplo a seguir mostra como usar `Approve-EC2VpcPeeringConnection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo aprova o pcx-1dfad234b56ff78be solicitado VpcPeeringConnectionId **
```
Approve-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-1dfad234b56ff78be
```
**Saída**:
```
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 obter detalhes da API, consulte [AcceptVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Confirm-EC2ProductInstance`
O código de exemplo a seguir mostra como usar `Confirm-EC2ProductInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo determina se o código do produto especificado está associado à instância especificada.**
```
Confirm-EC2ProductInstance -ProductCode 774F4FF8 -InstanceId i-12345678
```
+ Para obter detalhes da API, consulte [ConfirmProductInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Copy-EC2Image`
O código de exemplo a seguir mostra como usar `Copy-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo copia a AMI especificada na região “UE (Irlanda)” para a região “Oeste dos EUA (Oregon)”. Se -Region não for especificada, a região padrão atual será usada como a região de destino.**
```
Copy-EC2Image -SourceRegion eu-west-1 -SourceImageId ami-12345678 -Region us-west-2 -Name "Copy of ami-12345678"
```
**Saída**:
```
ami-87654321
```
+ Para obter detalhes da API, consulte [CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Copy-EC2Snapshot`
O código de exemplo a seguir mostra como usar `Copy-EC2Snapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo copia a AMI especificada na região “UE (Irlanda)” para a região “Oeste dos EUA (Oregon)”.**
```
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678 -Region us-west-2
```
**Exemplo 2: se você definir uma região padrão e omitir o parâmetro Região, a região de destino padrão será a região padrão.**
```
Set-DefaultAWSRegion us-west-2
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678
```
+ Para obter detalhes da API, consulte [CopySnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Deny-EC2VpcPeeringConnection`
O código de exemplo a seguir mostra como usar `Deny-EC2VpcPeeringConnection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: O exemplo acima nega a solicitação de ID de solicitação VpcPeering pcx-01a2b3ce45fe67eb8**
```
Deny-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-01a2b3ce45fe67eb8
```
+ Para obter detalhes da API, consulte [RejectVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-EC2VgwRoutePropagation`
O código de exemplo a seguir mostra como usar `Disable-EC2VgwRoutePropagation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo impede que o VGW propague automaticamente as rotas para a tabela de rotas especificada.**
```
Disable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DisableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-EC2VpcClassicLink`
O código de exemplo a seguir mostra como usar `Disable-EC2VpcClassicLink`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo é desativado EC2 VpcClassicLink para o vpc-01e23c4a5d6db78e9. Ele retorna Verdadeiro ou Falso**
```
Disable-EC2VpcClassicLink -VpcId vpc-01e23c4a5d6db78e9
```
+ Para obter detalhes da API, consulte [DisableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-EC2VpcClassicLinkDnsSupport`
O código de exemplo a seguir mostra como usar `Disable-EC2VpcClassicLinkDnsSupport`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo desativa o suporte de ClassicLink DNS para o vpc-0b12d3456a7e8910d**
```
Disable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d
```
+ Para obter detalhes da API, consulte [DisableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-EC2InternetGateway`
O código de exemplo a seguir mostra como usar `Dismount-EC2InternetGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desanexa o gateway da internet especificado da VPC especificada**.
```
Dismount-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
+ Para obter detalhes da API, consulte [DetachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-EC2NetworkInterface`
O código de exemplo a seguir mostra como usar `Dismount-EC2NetworkInterface`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o anexo especificado entre uma interface de rede e uma instância.**
```
Dismount-EC2NetworkInterface -AttachmentId eni-attach-1a2b3c4d -Force
```
+ Para obter detalhes da API, consulte [DetachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-EC2Volume`
O código de exemplo a seguir mostra como usar `Dismount-EC2Volume`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desvincula o volume especificado.**
```
Dismount-EC2Volume -VolumeId vol-12345678
```
**Saída**:
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : detaching
VolumeId : vol-12345678
```
**Exemplo 2: você também pode especificar o ID da instância e o nome do dispositivo para garantir que esteja desanexando o volume correto.**
```
Dismount-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
+ Para obter detalhes da API, consulte [DetachVolume](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-EC2VpnGateway`
O código de exemplo a seguir mostra como usar `Dismount-EC2VpnGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desvincula o gateway privado virtual especificado da VPC especificada.**
```
Dismount-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
+ Para obter detalhes da API, consulte [DetachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2CapacityReservation`
O código de exemplo a seguir mostra como usar `Edit-EC2CapacityReservation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo modifica o CapacityReservationId cr-0c1f2345db6f7cdba alterando a contagem de instâncias para 1**
```
Edit-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba -InstanceCount 1
```
**Saída**:
```
True
```
+ Para obter detalhes da API, consulte [ModifyCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2Host`
O código de exemplo a seguir mostra como usar `Edit-EC2Host`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo modifica as AutoPlacement configurações para desativadas para o host dedicado h-01e23f4cd567890f3**
```
Edit-EC2Host -HostId h-03e09f8cd681609f3 -AutoPlacement off
```
**Saída**:
```
Successful Unsuccessful
---------- ------------
{h-01e23f4cd567890f3} {}
```
+ Para obter detalhes da API, consulte [ModifyHosts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2IdFormat`
O código de exemplo a seguir mostra como usar `Edit-EC2IdFormat`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita o formato de ID mais longo para o tipo de recurso especificado.**
```
Edit-EC2IdFormat -Resource instance -UseLongId $true
```
**Exemplo 2: esse exemplo desativa o formato de ID mais longo para o tipo de recurso especificado.**
```
Edit-EC2IdFormat -Resource instance -UseLongId $false
```
+ Para obter detalhes da API, consulte [ModifyIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2ImageAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2ImageAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza a descrição da AMI especificada.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Description "New description"
```
**Exemplo 2: Esse exemplo torna a AMI pública (por exemplo, para que qualquer Conta da AWS pessoa possa usá-la).**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserGroup all
```
**Exemplo 3: esse exemplo torna a AMI privada (por exemplo, para que somente você, como proprietário, possa usá-la).**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserGroup all
```
**Exemplo 4: Este exemplo concede permissão de lançamento ao especificado Conta da AWS.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserId 111122223333
```
**Exemplo 5: Este exemplo remove a permissão de lançamento do especificado Conta da AWS.**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserId 111122223333
```
+ Para obter detalhes da API, consulte [ModifyImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2InstanceAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2InstanceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica o tipo de instância da instância especificada.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceType m3.medium
```
**Exemplo 2: Este exemplo habilita redes aprimoradas para a instância especificada, especificando “simple” como o valor do parâmetro de suporte de rede de I/O virtualização de raiz única (SR-IOV), -.. SriovNetSupport**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SriovNetSupport "simple"
```
**Exemplo 3: esse exemplo modifica os grupos de segurança da instância especificada. A instância deve estar em uma VPC. Você deve especificar o ID de cada grupo de segurança, não o nome.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -Group @( "sg-12345678", "sg-45678901" )
```
**Exemplo 4: Esse exemplo permite a I/O otimização do EBS para a instância especificada. Esse recurso não está disponível com todos os tipos de instâncias. As cobranças de uso adicionais serão aplicadas quando uma instância otimizada para EBS for usada.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -EbsOptimized $true
```
**Exemplo 5: Este exemplo permite source/destination verificar a instância especificada. Para que a instância execute a NAT, o valor deve ser “false”.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SourceDestCheck $true
```
**Exemplo 6: esse exemplo desabilita o encerramento da instância especificada.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -DisableApiTermination $true
```
**Exemplo 7: esse exemplo altera a instância especificada para que ela seja encerrada quando o desligamento for iniciado por meio da instância.**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceInitiatedShutdownBehavior terminate
```
+ Para obter detalhes da API, consulte [ModifyInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2InstanceCreditSpecification`
O código de exemplo a seguir mostra como usar `Edit-EC2InstanceCreditSpecification`.
**Ferramentas para PowerShell V5**
**Exemplo 1: isso habilita créditos ilimitados de T2, por exemplo, i-01234567890abcdef.**
```
$Credit = New-Object -TypeName Amazon.EC2.Model.InstanceCreditSpecificationRequest
$Credit.InstanceId = "i-01234567890abcdef"
$Credit.CpuCredits = "unlimited"
Edit-EC2InstanceCreditSpecification -InstanceCreditSpecification $Credit
```
+ Para obter detalhes da API, consulte [ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2NetworkInterfaceAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2NetworkInterfaceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica a interface de rede especificada para que o anexo especificado seja excluído no encerramento.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Attachment_AttachmentId eni-attach-1a2b3c4d -Attachment_DeleteOnTermination $true
```
**Exemplo 2: esse exemplo modifica a descrição da interface de rede especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Description "my description"
```
**Exemplo 3: esse exemplo modifica o grupo de segurança da interface de rede especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Groups sg-1a2b3c4d
```
**Exemplo 4: Este exemplo desativa a source/destination verificação da interface de rede especificada.**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck $false
```
+ Para obter detalhes da API, consulte [ModifyNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2ReservedInstance`
O código de exemplo a seguir mostra como usar `Edit-EC2ReservedInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica a zona de disponibilidade, a contagem de instâncias e a plataforma das instâncias 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 obter detalhes da API, consulte [ModifyReservedInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2SnapshotAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2SnapshotAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo torna público o snapshot especificado definindo seu CreateVolumePermission atributo.**
```
Edit-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission -OperationType Add -GroupName all
```
+ Para obter detalhes da API, consulte [ModifySnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2SpotFleetRequest`
O código de exemplo a seguir mostra como usar `Edit-EC2SpotFleetRequest`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza a capacidade de destino da solicitação de frota spot especificada.**
```
Edit-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TargetCapacity 10
```
**Saída**:
```
True
```
+ Para obter detalhes da API, consulte [ModifySpotFleetRequest](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2SubnetAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2SubnetAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita o endereçamento IP público para a sub-rede especificada.**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $true
```
**Exemplo 2: esse exemplo desabilita o endereçamento IP público para a sub-rede especificada.**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $false
```
+ Para obter detalhes da API, consulte [ModifySubnetAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2VolumeAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2VolumeAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo modifica o atributo especificado do volume especificado. I/O as operações do volume são retomadas automaticamente após serem suspensas devido a dados potencialmente inconsistentes**.
```
Edit-EC2VolumeAttribute -VolumeId vol-12345678 -AutoEnableIO $true
```
+ Para obter detalhes da API, consulte [ModifyVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-EC2VpcAttribute`
O código de exemplo a seguir mostra como usar `Edit-EC2VpcAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita o suporte a nomes de host DNS para a VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $true
```
**Exemplo 2: esse exemplo desabilita o suporte a nomes de host DNS para a VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $false
```
**Exemplo 3: esse exemplo habilita o suporte à resolução DNS para a VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $true
```
**Exemplo 4: esse exemplo desabilita o suporte à resolução DNS para a VPC especificada.**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $false
```
+ Para obter detalhes da API, consulte [ModifyVpcAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-EC2VgwRoutePropagation`
O código de exemplo a seguir mostra como usar `Enable-EC2VgwRoutePropagation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita o VGW especificado a propagar automaticamente as rotas para a tabela de rotas especificada.**
```
Enable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ Para obter detalhes da API, consulte [EnableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-EC2VolumeIO`
O código de exemplo a seguir mostra como usar `Enable-EC2VolumeIO`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo habilita I/O operações para o volume especificado, se I/O as operações estiverem desativadas.**
```
Enable-EC2VolumeIO -VolumeId vol-12345678
```
+ Para obter detalhes da API, consulte [EnableVolumeIo](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-EC2VpcClassicLink`
O código de exemplo a seguir mostra como usar `Enable-EC2VpcClassicLink`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo habilita a VPC vpc-0123456b789b0d12f para ClassicLink**
```
Enable-EC2VpcClassicLink -VpcId vpc-0123456b789b0d12f
```
**Saída**:
```
True
```
+ Para obter detalhes da API, consulte [EnableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-EC2VpcClassicLinkDnsSupport`
O código de exemplo a seguir mostra como usar `Enable-EC2VpcClassicLinkDnsSupport`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo permite que o vpc-0b12d3456a7e8910d ofereça suporte à resolução de nome de host DNS para ClassicLink**
```
Enable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
+ Para obter detalhes da API, consulte [EnableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2AccountAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2AccountAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve se você pode executar instâncias em EC2 -Classic e EC2 -VPC na região ou somente em -VPC. EC2**
```
(Get-EC2AccountAttribute -AttributeName supported-platforms).AttributeValues
```
**Saída**:
```
AttributeValue
--------------
EC2
VPC
```
**Exemplo 2: esse exemplo descreve a VPC padrão ou indica “nenhuma” caso você não tenha uma VPC padrão na região.**
```
(Get-EC2AccountAttribute -AttributeName default-vpc).AttributeValues
```
**Saída**:
```
AttributeValue
--------------
vpc-12345678
```
**Exemplo 3: esse exemplo descreve o número máximo de instâncias sob demanda que você pode executar.**
```
(Get-EC2AccountAttribute -AttributeName max-instances).AttributeValues
```
**Saída**:
```
AttributeValue
--------------
20
```
+ Para obter detalhes da API, consulte [DescribeAccountAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Address`
O código de exemplo a seguir mostra como usar `Get-EC2Address`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o endereço IP elástico especificado para instâncias em EC2 -Classic.**
```
Get-EC2Address -AllocationId eipalloc-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve os endereços IP elásticos para instâncias em uma VPC. Essa sintaxe requer a PowerShell versão 3 ou posterior.**
```
Get-EC2Address -Filter @{ Name="domain";Values="vpc" }
```
**Exemplo 3: Este exemplo descreve o endereço IP elástico especificado para instâncias em EC2 -Classic.**
```
Get-EC2Address -PublicIp 203.0.113.17
```
**Saída**:
```
AllocationId :
AssociationId :
Domain : standard
InstanceId : i-12345678
NetworkInterfaceId :
NetworkInterfaceOwnerId :
PrivateIpAddress :
PublicIp : 203.0.113.17
```
**Exemplo 4: Este exemplo descreve seus endereços IP elásticos para instâncias em EC2 -Classic. Essa sintaxe requer a PowerShell versão 3 ou posterior.**
```
Get-EC2Address -Filter @{ Name="domain";Values="standard" }
```
**Exemplo 5: esse exemplo descreve todos os endereços IP elásticos.**
```
Get-EC2Address
```
**Exemplo 6: esse exemplo retorna o IP público e privado para o ID da instância fornecido no filtro**
```
Get-EC2Address -Region eu-west-1 -Filter @{Name="instance-id";Values="i-0c12d3f4f567ffb89"} | Select-Object PrivateIpAddress, PublicIp
```
**Saída**:
```
PrivateIpAddress PublicIp
---------------- --------
10.0.0.99 63.36.5.227
```
**Exemplo 7: Este exemplo recupera todo o Elastic IPs com seu ID de alocação, ID de associação e IDs de instância**
```
Get-EC2Address -Region eu-west-1 | Select-Object InstanceId, AssociationId, AllocationId, PublicIp
```
**Saída**:
```
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
```
**Exemplo 8: Este exemplo busca uma lista de endereços EC2 IP que correspondem à chave de tag 'Category' com o valor 'Prod'**
```
Get-EC2Address -Filter @{Name="tag:Category";Values="Prod"}
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAddresses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2AvailabilityZone`
O código de exemplo a seguir mostra como usar `Get-EC2AvailabilityZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as zonas de disponibilidade da região atual que estão disponíveis para você.**
```
Get-EC2AvailabilityZone
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todas as zonas de disponibilidade que estão em estado de comprometimento. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
Get-EC2AvailabilityZone -Filter @{ Name="state";Values="impaired" }
```
**Exemplo 3: Com a PowerShell versão 2, você deve usar New-Object para criar o filtro.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = "impaired"
Get-EC2AvailabilityZone -Filter $filter
```
+ Para obter detalhes da API, consulte [DescribeAvailabilityZones](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2BundleTask`
O código de exemplo a seguir mostra como usar `Get-EC2BundleTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a tarefa de empacotamento especificada.**
```
Get-EC2BundleTask -BundleId bun-12345678
```
**Exemplo 2: esse exemplo descreve as tarefas do pacote cujo estado é “concluído” ou “com falha”.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "complete", "failed" )
Get-EC2BundleTask -Filter $filter
```
+ Para obter detalhes da API, consulte [DescribeBundleTasks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2CapacityReservation`
O código de exemplo a seguir mostra como usar `Get-EC2CapacityReservation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descrever uma ou mais de suas reservas de capacidade para a região**
```
Get-EC2CapacityReservation -Region eu-west-1
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeCapacityReservations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ConsoleOutput`
O código de exemplo a seguir mostra como usar `Get-EC2ConsoleOutput`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém a saída do console para a instância Linux especificada. A saída do console é codificada.**
```
Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456
```
**Saída**:
```
InstanceId Output
---------- ------
i-0e194d3c47c123637 WyAgICAwLjAwMDAwMF0gQ29tbW...bGU9dHR5UzAgc2Vs
```
**Exemplo 2: esse exemplo armazena a saída codificada do console em uma variável e, depois, a decodifica.**
```
$Output_encoded = (Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456).Output
[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Output_encoded))
```
+ Para obter detalhes da API, consulte [GetConsoleOutput](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2CustomerGateway`
O código de exemplo a seguir mostra como usar `Get-EC2CustomerGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o gateway do cliente especificado.**
```
Get-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**Saída**:
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
**Exemplo 2: esse exemplo descreve qualquer gateway do cliente cujo estado seja pendente ou disponível.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2CustomerGateway -Filter $filter
```
**Exemplo 3: esse exemplo descreve todos os gateways do cliente.**
```
Get-EC2CustomerGateway
```
+ Para obter detalhes da API, consulte [DescribeCustomerGateways](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2DhcpOption`
O código de exemplo a seguir mostra como usar `Get-EC2DhcpOption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista seus conjuntos de opções DHCP.**
```
Get-EC2DhcpOption
```
**Saída**:
```
DhcpConfigurations DhcpOptionsId Tag
------------------ ------------- ---
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
{domain-name-servers} dopt-3a4b5c6d {}
```
**Exemplo 2: esse exemplo obtém detalhes de configuração para o conjunto de opções DHCP especificado.**
```
(Get-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d).DhcpConfigurations
```
**Saída**:
```
Key Values
--- ------
domain-name {abc.local}
domain-name-servers {10.0.0.101, 10.0.0.102}
```
+ Para obter detalhes da API, consulte [DescribeDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2FlowLog`
O código de exemplo a seguir mostra como usar `Get-EC2FlowLog`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve um ou mais logs de fluxo com o tipo de destino de log “s3”**
```
Get-EC2FlowLog -Filter @{Name="log-destination-type";Values="s3"}
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Host`
O código de exemplo a seguir mostra como usar `Get-EC2Host`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna os detalhes do EC2 host**
```
Get-EC2Host
```
**Saída**:
```
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 : {}
```
**Exemplo 2: Este exemplo consulta o host AvailableInstanceCapacity h-01e23f4cd567899f1**
```
Get-EC2Host -HostId h-01e23f4cd567899f1 | Select-Object -ExpandProperty AvailableCapacity | Select-Object -expand AvailableInstanceCapacity
```
**Saída**:
```
AvailableCapacity InstanceType TotalCapacity
----------------- ------------ -------------
11 m4.xlarge 11
```
+ Para obter detalhes da API, consulte [DescribeHosts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2HostReservationOffering`
O código de exemplo a seguir mostra como usar `Get-EC2HostReservationOffering`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve as reservas de host dedicado que estão disponíveis para compra para o determinado filtro 'instance-family', onde está PaymentOption '' NoUpfront**
```
Get-EC2HostReservationOffering -Filter @{Name="instance-family";Values="m4"} | Where-Object PaymentOption -eq NoUpfront
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeHostReservationOfferings](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2HostReservationPurchasePreview`
O código de exemplo a seguir mostra como usar `Get-EC2HostReservationPurchasePreview`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo permite visualizar uma compra de reserva com configurações que correspondem às do seu host dedicado h-01e23f4cd567890f1**
```
Get-EC2HostReservationPurchasePreview -OfferingId hro-0c1f23456789d0ab -HostIdSet h-01e23f4cd567890f1
```
**Saída**:
```
CurrencyCode Purchase TotalHourlyPrice TotalUpfrontPrice
------------ -------- ---------------- -----------------
{} 1.307 0.000
```
+ Para obter detalhes da API, consulte [GetHostReservationPurchasePreview](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2IdFormat`
O código de exemplo a seguir mostra como usar `Get-EC2IdFormat`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o formato de ID para o tipo de recurso especificado.**
```
Get-EC2IdFormat -Resource instance
```
**Saída**:
```
Resource UseLongIds
-------- ----------
instance False
```
**Exemplo 2: Este exemplo descreve os formatos de ID para todos os tipos de recursos que oferecem suporte por mais tempo IDs.**
```
Get-EC2IdFormat
```
**Saída**:
```
Resource UseLongIds
-------- ----------
reservation False
instance False
```
+ Para obter detalhes da API, consulte [DescribeIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2IdentityIdFormat`
O código de exemplo a seguir mostra como usar `Get-EC2IdentityIdFormat`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o formato de ID do recurso “image” para a função especificada**
```
Get-EC2IdentityIdFormat -PrincipalArn arn:aws:iam::123456789511:role/JDBC -Resource image
```
**Saída**:
```
Deadline Resource UseLongIds
-------- -------- ----------
8/2/2018 11:30:00 PM image True
```
+ Para obter detalhes da API, consulte [DescribeIdentityIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Image`
O código de exemplo a seguir mostra como usar `Get-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a AMI especificada.**
```
Get-EC2Image -ImageId ami-12345678
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo descreve o AMIs que você possui.**
```
Get-EC2Image -owner self
```
**Exemplo 3: Este exemplo descreve o público AMIs que executa o Microsoft Windows Server.**
```
Get-EC2Image -Filter @{ Name="platform"; Values="windows" }
```
**Exemplo 4: Este exemplo descreve todos os públicos AMIs na região 'us-west-2'.**
```
Get-EC2Image -Region us-west-2
```
+ Para obter detalhes da API, consulte [DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ImageAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2ImageAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém a descrição da AMI especificada.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute description
```
**Saída**:
```
BlockDeviceMappings : {}
Description : My image description
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**Exemplo 2: esse exemplo obtém as permissões de lançamento da AMI especificada.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
**Saída**:
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {all}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**Exemplo 3: esse exemplo testa se as redes aprimoradas estão habilitadas.**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute sriovNetSupport
```
**Saída**:
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport : simple
```
+ Para obter detalhes da API, consulte [DescribeImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ImportImageTask`
O código de exemplo a seguir mostra como usar `Get-EC2ImportImageTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a tarefa de importação de imagem especificada.**
```
Get-EC2ImportImageTask -ImportTaskId import-ami-hgfedcba
```
**Saída**:
```
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 :
```
**Exemplo 2: esse exemplo descreve todas as tarefas de importação de imagens.**
```
Get-EC2ImportImageTask
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeImportImageTasks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ImportSnapshotTask`
O código de exemplo a seguir mostra como usar `Get-EC2ImportSnapshotTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a tarefa de importação de snapshot especificada.**
```
Get-EC2ImportSnapshotTask -ImportTaskId import-snap-abcdefgh
```
**Saída**:
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import 1 import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
**Exemplo 2: esse exemplo descreve todas as tarefas de importação de snapshots.**
```
Get-EC2ImportSnapshotTask
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeImportSnapshotTasks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Instance`
O código de exemplo a seguir mostra como usar `Get-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a instância especificada.**
```
(Get-EC2Instance -InstanceId i-12345678).Instances
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todas as instâncias na região atual, agrupadas por reserva. Para ver os detalhes da instância, expanda a coleção de instâncias em cada objeto de reserva.**
```
Get-EC2Instance
```
**Saída**:
```
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 226008221399
ReservationId : r-c5df370c
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 854251627541
ReservationId : r-63e65bab
...
```
**Exemplo 3: Este exemplo ilustra o uso de um filtro para consultar EC2 instâncias em uma sub-rede específica de uma VPC.**
```
(Get-EC2Instance -Filter @{Name="vpc-id";Values="vpc-1a2bc34d"},@{Name="subnet-id";Values="subnet-1a2b3c4d"}).Instances
```
**Saída**:
```
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
```
**Exemplo 4: Este exemplo ilustra o uso de um filtro com vários valores para consultar EC2 instâncias que estão em execução e paradas**
```
$InstanceParams = @{
Filter = @(
@{'Name' = 'instance-state-name';'Values' = @("running","stopped")}
)
}
(Get-EC2Instance @InstanceParams).Instances
```
**Saída**:
```
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
```
**Exemplo 5: Este exemplo ilustra o uso de um filtro com vários valores para consultar EC2 instâncias que estão em execução e paradas e o uso do cmdlet Select-Object para escolher valores específicos para saída.**
```
$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
```
**Saída**:
```
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
```
**Exemplo 6: Este exemplo valida as permissões para obter EC2 instâncias usando o DryRun parâmetro sem realmente buscá-las. Nota: se isso for feito com sucesso, será gerada uma exceção, que é o comportamento esperado.**
```
Get-EC2Tag -DryRun $true
```
**Saída**:
```
Get-EC2Instance: Request would have succeeded, but DryRun flag is set.
```
+ Para obter detalhes da API, consulte [DescribeInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2InstanceAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2InstanceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o tipo de instância da instância especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceType
```
**Saída**:
```
InstanceType : t2.micro
```
**Exemplo 2: esse exemplo descreve se a rede avançada está habilitada para a instância especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**Saída**:
```
SriovNetSupport : simple
```
**Exemplo 3: esse exemplo descreve os grupos de segurança para a instância especificada.**
```
(Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute groupSet).Groups
```
**Saída**:
```
GroupId
-------
sg-12345678
sg-45678901
```
**Exemplo 4: esse exemplo descreve se a otimização do EBS está habilitada para a instância especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**Saída**:
```
EbsOptimized : False
```
**Exemplo 5: Esse exemplo descreve o atributo disableApiTermination '' da instância especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**Saída**:
```
DisableApiTermination : False
```
**Exemplo 6: Esse exemplo descreve o atributo “instanceInitiatedShutdownComportamento” da instância especificada.**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
**Saída**:
```
InstanceInitiatedShutdownBehavior : stop
```
+ Para obter detalhes da API, consulte [DescribeInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2InstanceMetadata`
O código de exemplo a seguir mostra como usar `Get-EC2InstanceMetadata`.
**Ferramentas para PowerShell V5**
**Exemplo 1: lista as categorias disponíveis de metadados de instância que podem ser consultados.**
```
Get-EC2InstanceMetadata -ListCategory
```
**Saída**:
```
AmiId
LaunchIndex
ManifestPath
AncestorAmiId
BlockDeviceMapping
InstanceId
InstanceType
LocalHostname
LocalIpv4
KernelId
AvailabilityZone
ProductCode
PublicHostname
PublicIpv4
PublicKey
RamdiskId
Region
ReservationId
SecurityGroup
UserData
InstanceMonitoring
IdentityDocument
IdentitySignature
IdentityPkcs7
```
**Exemplo 2: retorna o ID da imagem de máquina da Amazon (AMI) usada para executar a instância.**
```
Get-EC2InstanceMetadata -Category AmiId
```
**Saída**:
```
ami-b2e756ca
```
**Exemplo 3: esse exemplo consulta o documento de identidade formatado em JSON para a instância.**
```
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"
}
```
**Exemplo 4: esse exemplo usa uma consulta de caminho para obter os macs da interface de rede para a instância.**
```
Get-EC2InstanceMetadata -Path "/network/interfaces/macs"
```
**Saída**:
```
02:80:7f:ef:4c:e0/
```
**Exemplo 5: Se houver uma função do IAM associada à instância, retornará informações sobre a última vez em que o perfil da instância foi atualizado, incluindo a LastUpdated data da instância InstanceProfileArn, InstanceProfileId e.**
```
Get-EC2InstanceMetadata -Path "/iam/info"
```
**Saída**:
```
{
"Code" : "Success",
"LastUpdated" : "2018-03-08T03:38:40Z",
"InstanceProfileArn" : "arn:aws:iam::111122223333:instance-profile/MyLaunchRole_Profile",
"InstanceProfileId" : "AIPAI4...WVK2RW"
}
```
+ Para obter detalhes da API, consulte [Get-EC2InstanceMetadata](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2InstanceStatus`
O código de exemplo a seguir mostra como usar `Get-EC2InstanceStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o status da instância especificada.**
```
Get-EC2InstanceStatus -InstanceId i-12345678
```
**Saída**:
```
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
```
**Saída**:
```
Code Name
---- ----
16 running
```
```
$status.Status
```
**Saída**:
```
Details Status
------- ------
{reachability} ok
```
```
$status.SystemStatus
```
**Saída**:
```
Details Status
------- ------
{reachability} ok
```
+ Para obter detalhes da API, consulte [DescribeInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2InternetGateway`
O código de exemplo a seguir mostra como usar `Get-EC2InternetGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o gateway da internet especificado.**
```
Get-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**Saída**:
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
```
**Exemplo 2: esse exemplo descreve todos os gateways da internet.**
```
Get-EC2InternetGateway
```
**Saída**:
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
{} igw-2a3b4c5d {}
```
+ Para obter detalhes da API, consulte [DescribeInternetGateways](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2KeyPair`
O código de exemplo a seguir mostra como usar `Get-EC2KeyPair`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o par de chaves especificado.**
```
Get-EC2KeyPair -KeyName my-key-pair
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todos os pares de chaves.**
```
Get-EC2KeyPair
```
+ Para obter detalhes da API, consulte [DescribeKeyPairs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2NetworkAcl`
O código de exemplo a seguir mostra como usar `Get-EC2NetworkAcl`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a ACL de rede especificada.**
```
Get-EC2NetworkAcl -NetworkAclId acl-12345678
```
**Saída**:
```
Associations : {aclassoc-1a2b3c4d}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {Name}
VpcId : vpc-12345678
```
**Exemplo 2: esse exemplo descreve duas regras para a ACL de rede especificada.**
```
(Get-EC2NetworkAcl -NetworkAclId acl-12345678).Entries
```
**Saída**:
```
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
```
**Exemplo 3: Este exemplo descreve toda a sua rede ACLs.**
```
Get-EC2NetworkAcl
```
+ Para obter detalhes da API, consulte [DescribeNetworkAcls](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2NetworkInterface`
O código de exemplo a seguir mostra como usar `Get-EC2NetworkInterface`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a interface de rede especificada.**
```
Get-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todas as interfaces de rede.**
```
Get-EC2NetworkInterface
```
+ Para obter detalhes da API, consulte [DescribeNetworkInterfaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2NetworkInterfaceAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2NetworkInterfaceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a interface de rede especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Attachment
```
**Saída**:
```
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
```
**Exemplo 2: esse exemplo descreve a interface de rede especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Description
```
**Saída**:
```
Description : My description
```
**Exemplo 3: esse exemplo descreve a interface de rede especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute GroupSet
```
**Saída**:
```
Groups : {my-security-group}
```
**Exemplo 4: esse exemplo descreve a interface de rede especificada.**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute SourceDestCheck
```
**Saída**:
```
SourceDestCheck : True
```
+ Para obter detalhes da API, consulte [DescribeNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2PasswordData`
O código de exemplo a seguir mostra como usar `Get-EC2PasswordData`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descriptografa a senha que a Amazon EC2 atribuiu à conta de administrador para a instância especificada do Windows. Quando um arquivo pem foi especificado, a configuração da opção -Decrypt é automaticamente assumida.**
```
Get-EC2PasswordData -InstanceId i-12345678 -PemFile C:\path\my-key-pair.pem
```
**Saída**:
```
mYZ(PA9?C)Q
```
**Exemplo 2: ( PowerShell somente para Windows) inspeciona a instância para determinar o nome do par de chaves usado para iniciar a instância e, em seguida, tenta encontrar os dados do par de chaves correspondente no repositório de configuração do AWS Toolkit for Visual Studio. Se os dados do par de chaves forem encontrados, a senha será descriptografada.**
```
Get-EC2PasswordData -InstanceId i-12345678 -Decrypt
```
**Saída**:
```
mYZ(PA9?C)Q
```
**Exemplo 3: retorna os dados da senha criptografada para a instância.**
```
Get-EC2PasswordData -InstanceId i-12345678
```
**Saída**:
```
iVz3BAK/WAXV.....dqt8WeMA==
```
+ Para obter detalhes da API, consulte [GetPasswordData](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2PlacementGroup`
O código de exemplo a seguir mostra como usar `Get-EC2PlacementGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o grupo de posicionamento especificado.**
```
Get-EC2PlacementGroup -GroupName my-placement-group
```
**Saída**:
```
GroupName State Strategy
--------- ----- --------
my-placement-group available cluster
```
+ Para obter detalhes da API, consulte [DescribePlacementGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2PrefixList`
O código de exemplo a seguir mostra como usar `Get-EC2PrefixList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo busca o disponível Serviços da AWS em um formato de lista de prefixos para a região**
```
Get-EC2PrefixList
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribePrefixLists](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Region`
O código de exemplo a seguir mostra como usar `Get-EC2Region`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as regiões que estão disponíveis para você.**
```
Get-EC2Region
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeRegions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2RouteTable`
O código de exemplo a seguir mostra como usar `Get-EC2RouteTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve todas as tabelas de rotas.**
```
Get-EC2RouteTable
```
**Saída**:
```
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 :
```
**Exemplo 2: esse exemplo retorna os detalhes da tabela de rotas especificada.**
```
Get-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**Exemplo 3: esse exemplo descreve as tabelas de rotas da VPC especificada.**
```
Get-EC2RouteTable -Filter @{ Name="vpc-id"; Values="vpc-1a2b3c4d" }
```
**Saída**:
```
Associations : {rtbassoc-12345678}
PropagatingVgws : {}
Routes : {, }
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DescribeRouteTables](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ScheduledInstance`
O código de exemplo a seguir mostra como usar `Get-EC2ScheduledInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a Instância Programada especificada.**
```
Get-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012
```
**Saída**:
```
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
```
Exemplo 2: esse exemplo descreve todas as suas Instâncias Programadas.
```
Get-EC2ScheduledInstance
```
+ Para obter detalhes da API, consulte [DescribeScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2ScheduledInstanceAvailability`
O código de exemplo a seguir mostra como usar `Get-EC2ScheduledInstanceAvailability`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve uma programação que ocorre toda semana no domingo, começando na data 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
```
**Saída**:
```
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
...
```
**Exemplo 2: para restringir os resultados, você pode adicionar filtros para critérios como sistema operacional, rede e tipo de instância.**
```
-Filter @{ Name="platform";Values="Linux/UNIX" },@{ Name="network-platform";Values="EC2-VPC" },@{ Name="instance-type";Values="c4.large" }
```
+ Para obter detalhes da API, consulte [DescribeScheduledInstanceAvailability](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SecurityGroup`
O código de exemplo a seguir mostra como usar `Get-EC2SecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o grupo de segurança especificado para uma VPC. Ao trabalhar com grupos de segurança pertencentes a uma VPC, você deve usar o ID do grupo de segurança (- GroupId parâmetro), não o nome (- GroupName parâmetro), para referenciar o grupo.**
```
Get-EC2SecurityGroup -GroupId sg-12345678
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo descreve o grupo de segurança especificado para EC2 -Classic. Ao trabalhar com grupos de segurança para EC2 -Classic, você pode usar o nome do grupo (- GroupName parâmetro) ou o ID do grupo (- GroupId parâmetro) para referenciar o grupo de segurança.**
```
Get-EC2SecurityGroup -GroupName my-security-group
```
**Saída**:
```
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 :
```
**Exemplo 3: esse exemplo recupera todos os grupos de segurança da vpc-0fc1ff23456b789eb**
```
Get-EC2SecurityGroup -Filter @{Name="vpc-id";Values="vpc-0fc1ff23456b789eb"}
```
+ Para obter detalhes da API, consulte [DescribeSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Snapshot`
O código de exemplo a seguir mostra como usar `Get-EC2Snapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o snapshot especificado.**
```
Get-EC2Snapshot -SnapshotId snap-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve os snapshots que têm uma tag “Name”.**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" }
```
**Exemplo 3: Este exemplo descreve os instantâneos que têm uma tag 'Nome' com o valor 'TestValue'.**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" -and $_.Tags.Value -eq "TestValue" }
```
**Exemplo 4: esse exemplo descreve todos os snapshots.**
```
Get-EC2Snapshot -Owner self
```
+ Para obter detalhes da API, consulte [DescribeSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SnapshotAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2SnapshotAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o atributo especificado do snapshot especificado.**
```
Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute ProductCodes
```
**Saída**:
```
CreateVolumePermissions ProductCodes SnapshotId
----------------------- ------------ ----------
{} {} snap-12345678
```
**Exemplo 2: esse exemplo descreve o atributo especificado do snapshot especificado.**
```
(Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission).CreateVolumePermissions
```
**Saída**:
```
Group UserId
----- ------
all
```
+ Para obter detalhes da API, consulte [DescribeSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotDatafeedSubscription`
O código de exemplo a seguir mostra como usar `Get-EC2SpotDatafeedSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o feed de dados da instância Spot.**
```
Get-EC2SpotDatafeedSubscription
```
**Saída**:
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ Para obter detalhes da API, consulte [DescribeSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotFleetInstance`
O código de exemplo a seguir mostra como usar `Get-EC2SpotFleetInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as instâncias associadas à solicitação de frota spot especificada.**
```
Get-EC2SpotFleetInstance -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
```
**Saída**:
```
InstanceId InstanceType SpotInstanceRequestId
---------- ------------ ---------------------
i-f089262a c3.large sir-12345678
i-7e8b24a4 c3.large sir-87654321
```
+ Para obter detalhes da API, consulte [DescribeSpotFleetInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotFleetRequest`
O código de exemplo a seguir mostra como usar `Get-EC2SpotFleetRequest`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a solicitação de frota spot especificada.**
```
Get-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE | format-list
```
**Saída**:
```
ConfigData : Amazon.EC2.Model.SpotFleetRequestConfigData
CreateTime : 12/26/2015 8:23:33 AM
SpotFleetRequestId : sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
SpotFleetRequestState : active
```
**Exemplo 2: esse exemplo descreve todas as suas solicitações de frota spot.**
```
Get-EC2SpotFleetRequest
```
+ Para obter detalhes da API, consulte [DescribeSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotFleetRequestHistory`
O código de exemplo a seguir mostra como usar `Get-EC2SpotFleetRequestHistory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o histórico de solicitação de frota spot especificada.**
```
Get-EC2SpotFleetRequestHistory -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -StartTime 2015-12-26T00:00:00Z
```
**Saída**:
```
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
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSpotFleetRequestHistory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotInstanceRequest`
O código de exemplo a seguir mostra como usar `Get-EC2SpotInstanceRequest`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a solicitação de instância spot especificada.**
```
Get-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todas as solicitações de instância spot.**
```
Get-EC2SpotInstanceRequest
```
+ Para obter detalhes da API, consulte [DescribeSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2SpotPriceHistory`
O código de exemplo a seguir mostra como usar `Get-EC2SpotPriceHistory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém as últimas 10 entradas no histórico de preços spot do tipo de instância especificado e da zona de disponibilidade. Observe que o valor especificado para o AvailabilityZone parâmetro - deve ser válido para o valor da região fornecido ao parâmetro -Region do cmdlet (não mostrado no exemplo) ou definido como padrão no shell. Este exemplo de comando pressupõe que uma região padrão de “us-west-2” tenha sido definida no ambiente.**
```
Get-EC2SpotPriceHistory -InstanceType c3.large -AvailabilityZone us-west-2a -MaxResult 10
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSpotPriceHistory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Subnet`
O código de exemplo a seguir mostra como usar `Get-EC2Subnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a sub-rede especificada.**
```
Get-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve todas as sub-redes.**
```
Get-EC2Subnet
```
+ Para obter detalhes da API, consulte [DescribeSubnets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Tag`
O código de exemplo a seguir mostra como usar `Get-EC2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca as tags do tipo de recurso “image”**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="image"}
```
**Saída**:
```
Key ResourceId ResourceType Value
--- ---------- ------------ -----
Name ami-0a123b4ccb567a8ea image Win7-Imported
auto-delete ami-0a123b4ccb567a8ea image never
```
**Exemplo 2: esse exemplo busca todas as tags de todos os recursos e as agrupa por tipo de recurso**
```
Get-EC2Tag | Group-Object resourcetype
```
**Saída**:
```
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}
```
**Exemplo 3: esse exemplo exibe todos os recursos com a tag “auto-delete” com o valor “no” para a região em questão**
```
Get-EC2Tag -Region eu-west-1 -Filter @{Name="tag:auto-delete";Values="no"}
```
**Saída**:
```
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
```
**Exemplo 4: este exemplo obtém todos os recursos com a tag “exclusão automática” com valor “nenhum” e filtros adicionais no próximo canal para analisar somente os tipos de recursos de “instância” e, eventualmente, cria a tag “ThisInstance” para cada recurso da instância, com o valor sendo o próprio ID da instância**
```
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}}
```
**Exemplo 5: esse exemplo busca tags para todos os recursos da instância, bem como para as chaves “Name”, e as exibe em formato de tabela**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="instance"},@{Name="key";Values="Name"} | Select-Object ResourceId, @{Name="Name-Tag";Expression={$PSItem.Value}} | Format-Table -AutoSize
```
**Saída**:
```
ResourceId Name-Tag
---------- --------
i-012e3cb4df567e1aa jump1
i-01c23a45d6fc7a89f repro-3
```
**Exemplo 6: Este exemplo valida as permissões para obter EC2 tags usando o DryRun parâmetro sem realmente buscá-las. Nota: se isso for feito com sucesso, será gerada uma exceção, que é o comportamento esperado.**
```
Get-EC2Tag -DryRun $true
```
**Saída**:
```
Get-EC2Tag: Request would have succeeded, but DryRun flag is set.
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Volume`
O código de exemplo a seguir mostra como usar `Get-EC2Volume`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve volume do EBS especificado.**
```
Get-EC2Volume -VolumeId vol-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve os volumes do EBS que têm o status “available”.**
```
Get-EC2Volume -Filter @{ Name="status"; Values="available" }
```
**Saída**:
```
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
...
```
**Exemplo 3: esse exemplo descreve todos os volumes do EBS.**
```
Get-EC2Volume
```
+ Para obter detalhes da API, consulte [DescribeVolumes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VolumeAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2VolumeAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o atributo especificado do volume especificado.**
```
Get-EC2VolumeAttribute -VolumeId vol-12345678 -Attribute AutoEnableIO
```
**Saída**:
```
AutoEnableIO ProductCodes VolumeId
------------ ------------ --------
False {} vol-12345678
```
+ Para obter detalhes da API, consulte [DescribeVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VolumeStatus`
O código de exemplo a seguir mostra como usar `Get-EC2VolumeStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o status do volume especificado.**
```
Get-EC2VolumeStatus -VolumeId vol-12345678
```
**Saída**:
```
Actions : {}
AvailabilityZone : us-west-2a
Events : {}
VolumeId : vol-12345678
VolumeStatus : Amazon.EC2.Model.VolumeStatusInfo
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus
```
**Saída**:
```
Details Status
------- ------
{io-enabled, io-performance} ok
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus.Details
```
**Saída**:
```
Name Status
---- ------
io-enabled passed
io-performance not-applicable
```
+ Para obter detalhes da API, consulte [DescribeVolumeStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2Vpc`
O código de exemplo a seguir mostra como usar `Get-EC2Vpc`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a VPC especificada.**
```
Get-EC2Vpc -VpcId vpc-12345678
```
**Saída**:
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : available
Tags : {Name}
VpcId : vpc-12345678
```
**Exemplo 2: esse exemplo descreve a VPC padrão (só pode haver uma por região). Se sua conta for compatível EC2 com -Classic nessa região, não há VPC padrão.**
```
Get-EC2Vpc -Filter @{Name="isDefault"; Values="true"}
```
**Saída**:
```
CidrBlock : 172.31.0.0/16
DhcpOptionsId : dopt-12345678
InstanceTenancy : default
IsDefault : True
State : available
Tags : {}
VpcId : vpc-45678901
```
**Exemplo 3: Este exemplo descreve os VPCs que correspondem ao filtro especificado (ou seja, têm um CIDR que corresponde ao valor '10.0.0.0/16' e estão no estado 'disponível').**
```
Get-EC2Vpc -Filter @{Name="cidr"; Values="10.0.0.0/16"},@{Name="state";Values="available"}
```
**Exemplo 4: Este exemplo descreve todos os seus VPCs.**
```
Get-EC2Vpc
```
+ Para obter detalhes da API, consulte [DescribeVpcs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpcAttribute`
O código de exemplo a seguir mostra como usar `Get-EC2VpcAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o atributo enableDnsSupport ''.**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsSupport
```
**Saída**:
```
EnableDnsSupport
----------------
True
```
**Exemplo 2: Este exemplo descreve o atributo enableDnsHostnames ''.**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsHostnames
```
**Saída**:
```
EnableDnsHostnames
------------------
True
```
+ Para obter detalhes da API, consulte [DescribeVpcAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpcClassicLink`
O código de exemplo a seguir mostra como usar `Get-EC2VpcClassicLink`.
**Ferramentas para PowerShell V5**
**Exemplo 1: O exemplo acima retorna todos os VPCs com seu ClassicLinkEnabled estado para a região**
```
Get-EC2VpcClassicLink -Region eu-west-1
```
**Saída**:
```
ClassicLinkEnabled Tags VpcId
------------------ ---- -----
False {Name} vpc-0fc1ff23f45b678eb
False {} vpc-01e23c4a5d6db78e9
False {Name} vpc-0123456b078b9d01f
False {} vpc-12cf3b4f
False {Name} vpc-0b12d3456a7e8901d
```
+ Para obter detalhes da API, consulte [DescribeVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpcClassicLinkDnsSupport`
O código de exemplo a seguir mostra como usar `Get-EC2VpcClassicLinkDnsSupport`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o status de suporte de ClassicLink DNS da região VPCs eu-west-1**
```
Get-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
**Saída**:
```
ClassicLinkDnsSupported VpcId
----------------------- -----
False vpc-0b12d3456a7e8910d
False vpc-12cf3b4f
```
+ Para obter detalhes da API, consulte [DescribeVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpcEndpoint`
O código de exemplo a seguir mostra como usar `Get-EC2VpcEndpoint`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve um ou mais dos endpoints da VPC para a região eu-west-1. Em seguida, ele canaliza a saída para o próximo comando, que seleciona a VpcEndpointId propriedade e retorna o ID da VPC da matriz como matriz de string.**
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object -ExpandProperty VpcEndpointId
```
**Saída**:
```
vpce-01a2ab3f4f5cc6f7d
vpce-01d2b345a6787890b
vpce-0012e34d567890e12
vpce-0c123db4567890123
```
**Exemplo 2: Este exemplo descreve todos os endpoints vpc da região eu-west-1 e seleciona VpcEndpointId,, e as propriedades para apresentá-los em formato VpcId tabular ServiceName PrivateDnsEnabled **
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object VpcEndpointId, VpcId, ServiceName, PrivateDnsEnabled | Format-Table -AutoSize
```
**Saída**:
```
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
```
**Exemplo 3: esse exemplo exporta o documento de política do endpoint da VPC vpce-01a2ab3f4f5cc6f7d em um arquivo json**
```
Get-EC2VpcEndpoint -Region eu-west-1 -VpcEndpointId vpce-01a2ab3f4f5cc6f7d | Select-Object -expand PolicyDocument | Out-File vpce_policyDocument.json
```
+ Para obter detalhes da API, consulte [DescribeVpcEndpoints](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpcEndpointService`
O código de exemplo a seguir mostra como usar `Get-EC2VpcEndpointService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo descreve o serviço de endpoint EC2 VPC com o filtro fornecido, neste caso com.amazonaws.eu-west-1.ecs. Além disso, ele também expande a ServiceDetails propriedade e exibe os detalhes**
```
Get-EC2VpcEndpointService -Region eu-west-1 -MaxResult 5 -Filter @{Name="service-name";Values="com.amazonaws.eu-west-1.ecs"} | Select-Object -ExpandProperty ServiceDetails
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo recupera todos os serviços do EC2 VPC Endpoint e retorna ServiceNames o “ssm” correspondente**
```
Get-EC2VpcEndpointService -Region eu-west-1 | Select-Object -ExpandProperty Servicenames | Where-Object { -match "ssm"}
```
**Saída**:
```
com.amazonaws.eu-west-1.ssm
com.amazonaws.eu-west-1.ssmmessages
```
+ Para obter detalhes da API, consulte [DescribeVpcEndpointServices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpnConnection`
O código de exemplo a seguir mostra como usar `Get-EC2VpnConnection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve conexão VPN especificada.**
```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve qualquer conexão VPN cujo estado esteja pendente ou disponível.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnConnection -Filter $filter
```
**Exemplo 3: esse exemplo descreve todas as conexões VPN.**
```
Get-EC2VpnConnection
```
+ Para obter detalhes da API, consulte [DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EC2VpnGateway`
O código de exemplo a seguir mostra como usar `Get-EC2VpnGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o gateway privado virtual especificado.**
```
Get-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**Saída**:
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {vpc-12345678}
VpnGatewayId : vgw-1a2b3c4d
```
**Exemplo 2: esse exemplo descreve qualquer gateway privado virtual cujo estado seja pendente ou disponível.**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnGateway -Filter $filter
```
**Exemplo 3: esse exemplo descreve todos os seus gateways privados virtuais.**
```
Get-EC2VpnGateway
```
+ Para obter detalhes da API, consulte [DescribeVpnGateways](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Grant-EC2SecurityGroupEgress`
O código de exemplo a seguir mostra como usar `Grant-EC2SecurityGroupEgress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo define uma regra de saída para o grupo de segurança especificado para EC2 -VPC. A regra concede acesso ao intervalo de endereços IP especificados na porta TCP 80. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar o 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
```
**Exemplo 3: esse exemplo concede acesso ao grupo de segurança de origem especificado na porta 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 obter detalhes da API, consulte [AuthorizeSecurityGroupEgress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Grant-EC2SecurityGroupIngress`
O código de exemplo a seguir mostra como usar `Grant-EC2SecurityGroupIngress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo define regras de entrada para um grupo de segurança para EC2 -VPC. Essas regras concedem acesso a um endereço IP específico para SSH (porta 22) e RDC (porta 3389). Observe que você deve identificar grupos de segurança para EC2 -VPC usando o ID do grupo de segurança, não o nome do grupo de segurança. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou 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 )
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar os 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 )
```
**Exemplo 3: Este exemplo define regras de entrada para um grupo de segurança para EC2 -Classic. Essas regras concedem acesso a um endereço IP específico para SSH (porta 22) e RDC (porta 3389). A sintaxe usada neste exemplo requer a PowerShell versão 3 ou 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 )
```
**Exemplo 4: Com a PowerShell versão 2, você deve usar New-Object para criar os 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 )
```
**Exemplo 5: esse exemplo concede acesso à porta TCP 8081 do grupo de segurança de origem especificado (sg-1a2b3c4d) ao grupo de segurança 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 } )
```
**Exemplo 6: esse exemplo adiciona o CIDR 5.5.5.5/32 às regras de entrada do grupo de segurança sg-1234abcd para tráfego da porta TCP 22 com uma descrição.**
```
$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 obter detalhes da API, consulte [AuthorizeSecurityGroupIngress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Import-EC2Image`
O código de exemplo a seguir mostra como usar `Import-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo importa uma imagem de máquina virtual de disco único do bucket do Amazon S3 especificado para a EC2 Amazon com um token de idempotência. O exemplo exige que exista uma função de serviço de importação de VM com o nome padrão 'vmimport', com uma política que permita que a EC2 Amazon acesse o bucket especificado, conforme explicado no tópico Pré-requisitos de importação de VM. Para usar um perfil personalizado, especifique o nome do perfil usando o 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
```
**Saída**:
```
Architecture :
Description : Windows 2008 Standard Image
Hypervisor :
ImageId :
ImportTaskId : import-ami-abcdefgh
LicenseType : AWS
Platform : Windows
Progress : 2
SnapshotDetails : {}
Status : active
StatusMessage : pending
```
+ Para obter detalhes da API, consulte [ImportImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Import-EC2KeyPair`
O código de exemplo a seguir mostra como usar `Import-EC2KeyPair`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo importa uma chave pública para EC2. A primeira linha armazena o conteúdo do arquivo de chave pública (\$1.pub) na variável `$publickey`. Em seguida, o exemplo converte o UTF8 formato do arquivo de chave pública em uma string codificada em Base64 e armazena a string convertida na variável. `$pkbase64` Na última linha, a chave pública convertida é importada para EC2. O cmdlet retorna a impressão digital e o nome da chave como resultados.**
```
$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
```
**Saída**:
```
KeyFingerprint KeyName
-------------- -------
do:d0:15:8f:79:97:12:be:00:fd:df:31:z3:b1:42:z1 Example-user-key
```
+ Para obter detalhes da API, consulte [ImportKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Import-EC2Snapshot`
O código de exemplo a seguir mostra como usar `Import-EC2Snapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo importa uma imagem de disco de VM no formato “VMDK” para um snapshot do Amazon EBS. O exemplo requer uma função de serviço de importação de VM com o nome padrão 'vmimport', com uma política que permita que a EC2 Amazon acesse o bucket especificado, conforme explicado `VM Import Prequisites` no tópico em http://docs.aws.amazon. com/AWSEC2/latest/WindowsGuide/VMImportPrerequisites.html. Para usar um perfil personalizado, especifique o nome do perfil usando o 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
```
**Saída**:
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
+ Para obter detalhes da API, consulte [ImportSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Move-EC2AddressToVpc`
O código de exemplo a seguir mostra como usar `Move-EC2AddressToVpc`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo move uma EC2 instância com um endereço IP público de 12.345.67.89 para a plataforma EC2 -VPC na região Leste dos EUA (Norte da Virgínia).**
```
Move-EC2AddressToVpc -PublicIp 12.345.67.89 -Region us-east-1
```
**Exemplo 2: Este exemplo canaliza os resultados de um Get-EC2Instance comando para o Move-EC2AddressToVpc cmdlet. O Get-EC2Instance comando obtém uma instância especificada pelo ID da instância e retorna a propriedade de endereço IP público da instância.**
```
(Get-EC2Instance -Instance i-12345678).Instances.PublicIpAddress | Move-EC2AddressToVpc
```
+ Para obter detalhes da API, consulte [MoveAddressToVpc](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Address`
O código de exemplo a seguir mostra como usar `New-EC2Address`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo aloca um endereço IP elástico para usar com uma instância em uma VPC.**
```
New-EC2Address -Domain Vpc
```
**Saída**:
```
AllocationId Domain PublicIp
------------ ------ --------
eipalloc-12345678 vpc 198.51.100.2
```
**Exemplo 2: Este exemplo aloca um endereço IP elástico para usar com uma instância em EC2 -Classic.**
```
New-EC2Address
```
**Saída**:
```
AllocationId Domain PublicIp
------------ ------ --------
standard 203.0.113.17
```
+ Para obter detalhes da API, consulte [AllocateAddress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2CustomerGateway`
O código de exemplo a seguir mostra como usar `New-EC2CustomerGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria o gateway do cliente especificado.**
```
New-EC2CustomerGateway -Type ipsec.1 -PublicIp 203.0.113.12 -BgpAsn 65534
```
**Saída**:
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
+ Para obter detalhes da API, consulte [CreateCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2DhcpOption`
O código de exemplo a seguir mostra como usar `New-EC2DhcpOption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria o conjunto especificado de opções DHCP. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou 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
```
**Saída**:
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar cada opção 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)
```
**Saída**:
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
```
+ Para obter detalhes da API, consulte [CreateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2FlowLog`
O código de exemplo a seguir mostra como usar `New-EC2FlowLog`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um EC2 registro de fluxo da sub-rede subnet-1d234567 até o cloud-watch-log nome 'subnet1-log' para todo o tráfego 'REJECT' usando as permissões da função 'Admin'**
```
New-EC2FlowLog -ResourceId "subnet-1d234567" -LogDestinationType cloud-watch-logs -LogGroupName subnet1-log -TrafficType "REJECT" -ResourceType Subnet -DeliverLogsPermissionArn "arn:aws:iam::98765432109:role/Admin"
```
**Saída**:
```
ClientToken FlowLogIds Unsuccessful
----------- ---------- ------------
m1VN2cxP3iB4qo//VUKl5EU6cF7gQLOxcqNefvjeTGw= {fl-012fc34eed5678c9d} {}
```
+ Para obter detalhes da API, consulte [CreateFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Host`
O código de exemplo a seguir mostra como usar `New-EC2Host`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo aloca um host dedicado à sua conta para o tipo de instância e zona de disponibilidade específicos**
```
New-EC2Host -AutoPlacement on -AvailabilityZone eu-west-1b -InstanceType m4.xlarge -Quantity 1
```
**Saída**:
```
h-01e23f4cd567890f3
```
+ Para obter detalhes da API, consulte [AllocateHosts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2HostReservation`
O código de exemplo a seguir mostra como usar `New-EC2HostReservation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo compra a oferta de reserva hro-0c1f23456789d0ab com configurações que correspondem às do seu host dedicado h-01e23f4cd567890f1**
```
New-EC2HostReservation -OfferingId hro-0c1f23456789d0ab HostIdSet h-01e23f4cd567890f1
```
**Saída**:
```
ClientToken :
CurrencyCode :
Purchase : {hr-0123f4b5d67bedc89}
TotalHourlyPrice : 1.307
TotalUpfrontPrice : 0.000
```
+ Para obter detalhes da API, consulte [PurchaseHostReservation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Image`
O código de exemplo a seguir mostra como usar `New-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma AMI com o nome e a descrição especificados com base na instância especificada. A Amazon EC2 tenta desligar completamente a instância antes de criar a imagem e reinicia a instância após a conclusão.**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI"
```
**Exemplo 2: esse exemplo cria uma AMI com o nome e a descrição especificados com base na instância especificada. EC2 A Amazon cria a imagem sem desligar e reiniciar a instância; portanto, a integridade do sistema de arquivos na imagem criada não pode ser garantida.**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI" -NoReboot $true
```
**Exemplo 3: esse exemplo cria uma AMI com três volumes. O primeiro volume é baseado em um snapshot do Amazon EBS. O segundo volume é um volume vazio de 100 GiB do Amazon EBS. O terceiro volume é um volume de armazenamento de instância. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou 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 obter detalhes da API, consulte [CreateImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Instance`
O código de exemplo a seguir mostra como usar `New-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo executa uma única instância da AMI especificada em EC2 -Classic ou em uma VPC padrão.**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -InstanceType m3.medium -KeyName my-key-pair -SecurityGroup my-security-group
```
**Exemplo 2: esse exemplo executa uma única instância da AMI especificada em uma VPC.**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -SubnetId subnet-12345678 -InstanceType t2.micro -KeyName my-key-pair -SecurityGroupId sg-12345678
```
**Exemplo 3: para adicionar um volume do EBS ou um volume de armazenamento de instância, defina um mapeamento de dispositivos de blocos e adicione-o ao comando. Esse exemplo adiciona um volume de armazenamento de instância.**
```
$bdm = New-Object Amazon.EC2.Model.BlockDeviceMapping
$bdm.VirtualName = "ephemeral0"
$bdm.DeviceName = "/dev/sdf"
New-EC2Instance -ImageId ami-12345678 -BlockDeviceMapping $bdm ...
```
**Exemplo 4: Para especificar um dos Windows atuais AMIs, obtenha sua AMI ID usando Get- SSMLatest EC2 Image. Esse exemplo executa uma instância da AMI base atual para Windows Server 2016.**
```
$ami = (Get-SSMLatestEC2Image -Path 'ami-windows-latest' -ImageName 'WINDOWS*2016*English*Core*BASE').Value
New-EC2Instance -ImageId $ami ...
```
**Exemplo 5: executa uma instância no ambiente 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
```
**Exemplo 6: essa solicitação executa duas instâncias e aplica uma tag com uma chave de servidor da web e um valor de produção às instâncias. A solicitação também aplica uma tag com uma chave de centro de custos e um valor de cc123 aos volumes criados (nesse caso, o volume do dispositivo raiz de cada instância).**
```
$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
```
**Exemplo 7: Esse exemplo valida as permissões para iniciar uma EC2 instância usando o DryRun parâmetro sem realmente criar a instância. Nota: se isso for feito com sucesso, será gerada uma exceção, que é o comportamento esperado.**
```
New-EC2Instance -ImageId 'ami-12345678' -InstanceType 't2.micro' -KeyName 'my-key-pair' -Region 'us-west-2' -DryRun $true
```
+ Para obter detalhes da API, consulte [RunInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2InstanceExportTask`
O código de exemplo a seguir mostra como usar `New-EC2InstanceExportTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exporta uma instância interrompida, `i-0800b00a00EXAMPLE`, como um disco rígido virtual (VHD) para o bucket do S3 `testbucket-export-instances-2019`. O ambiente de destino é`Microsoft`, e o parâmetro region é adicionado porque a instância está na `us-east-1` região, enquanto a AWS região padrão do usuário não é us-east-1. Para obter o status da tarefa de exportação, copie o valor `ExportTaskId` dos resultados desse comando e execute `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
```
**Saída**:
```
Description :
ExportTaskId : export-i-077c73108aEXAMPLE
ExportToS3Task : Amazon.EC2.Model.ExportToS3Task
InstanceExportDetails : Amazon.EC2.Model.InstanceExportDetails
State : active
StatusMessage :
```
+ Para obter detalhes da API, consulte [CreateInstanceExportTask](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2InternetGateway`
O código de exemplo a seguir mostra como usar `New-EC2InternetGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um gateway da internet.**
```
New-EC2InternetGateway
```
**Saída**:
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{} igw-1a2b3c4d {}
```
+ Para obter detalhes da API, consulte [CreateInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2KeyPair`
O código de exemplo a seguir mostra como usar `New-EC2KeyPair`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um par de chaves e captura a chave privada RSA codificada por PEM em um arquivo com o nome especificado. Quando você estiver usando PowerShell, a codificação deve ser definida como ascii para gerar uma chave válida. Para obter mais informações, consulte Criar, exibir e excluir pares de EC2 chaves da Amazon (https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-keypairs.html) no Guia do usuário da interface de linha de AWS comando.**
```
(New-EC2KeyPair -KeyName "my-key-pair").KeyMaterial | Out-File -Encoding ascii -FilePath C:\path\my-key-pair.pem
```
+ Para obter detalhes da API, consulte [CreateKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2NetworkAcl`
O código de exemplo a seguir mostra como usar `New-EC2NetworkAcl`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma ACL de rede para a VPC especificada.**
```
New-EC2NetworkAcl -VpcId vpc-12345678
```
**Saída**:
```
Associations : {}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {}
VpcId : vpc-12345678
```
+ Para obter detalhes da API, consulte [CreateNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2NetworkAclEntry`
O código de exemplo a seguir mostra como usar `New-EC2NetworkAclEntry`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma entrada para a ACL de rede especificada. A regra permite o tráfego de entrada de qualquer lugar (0.0.0.0/0) na porta UDP 53 (DNS) para qualquer sub-rede associada.**
```
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 obter detalhes da API, consulte [CreateNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2NetworkInterface`
O código de exemplo a seguir mostra como usar `New-EC2NetworkInterface`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria a interface de rede especificada.**
```
New-EC2NetworkInterface -SubnetId subnet-1a2b3c4d -Description "my network interface" -Group sg-12345678 -PrivateIpAddress 10.0.0.17
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2PlacementGroup`
O código de exemplo a seguir mostra como usar `New-EC2PlacementGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um grupo de posicionamento com o nome especificado.**
```
New-EC2PlacementGroup -GroupName my-placement-group -Strategy cluster
```
+ Para obter detalhes da API, consulte [CreatePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Route`
O código de exemplo a seguir mostra como usar `New-EC2Route`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria a rota especificada para a tabela de rotas especificada. A rota faz a correspondência de todo o tráfego e o encaminha para o gateway da internet especificado.**
```
New-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0 -GatewayId igw-1a2b3c4d
```
**Saída**:
```
True
```
+ Para obter detalhes da API, consulte [CreateRoute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2RouteTable`
O código de exemplo a seguir mostra como usar `New-EC2RouteTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma tabela de rotas para a VPC especificada.**
```
New-EC2RouteTable -VpcId vpc-12345678
```
**Saída**:
```
Associations : {}
PropagatingVgws : {}
Routes : {}
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-12345678
```
+ Para obter detalhes da API, consulte [CreateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2ScheduledInstance`
O código de exemplo a seguir mostra como usar `New-EC2ScheduledInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo inicia a instância 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 obter detalhes da API, consulte [RunScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2ScheduledInstancePurchase`
O código de exemplo a seguir mostra como usar `New-EC2ScheduledInstancePurchase`.
**Ferramentas para PowerShell V5**
**Exemplo: esse exemplo compra uma Instância Programada.**
```
$request = New-Object Amazon.EC2.Model.PurchaseRequest
$request.InstanceCount = 1
$request.PurchaseToken = "eyJ2IjoiMSIsInMiOjEsImMiOi..."
New-EC2ScheduledInstancePurchase -PurchaseRequest $request
```
**Saída**:
```
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 obter detalhes da API, consulte [PurchaseScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2SecurityGroup`
O código de exemplo a seguir mostra como usar `New-EC2SecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um grupo de segurança para a VPC especificada.**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group" -VpcId vpc-12345678
```
**Saída**:
```
sg-12345678
```
**Exemplo 2: Este exemplo cria um grupo de segurança para EC2 -Classic.**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group"
```
**Saída**:
```
sg-45678901
```
+ Para obter detalhes da API, consulte [CreateSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Snapshot`
O código de exemplo a seguir mostra como usar `New-EC2Snapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um snapshot do volume especificado.**
```
New-EC2Snapshot -VolumeId vol-12345678 -Description "This is a test"
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2SpotDatafeedSubscription`
O código de exemplo a seguir mostra como usar `New-EC2SpotDatafeedSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um feed de dados da instância Spot.**
```
New-EC2SpotDatafeedSubscription -Bucket amzn-s3-demo-bucket -Prefix spotdata
```
**Saída**:
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ Para obter detalhes da API, consulte [CreateSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Subnet`
O código de exemplo a seguir mostra como usar `New-EC2Subnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma sub-rede com o CIDR especificado.**
```
New-EC2Subnet -VpcId vpc-12345678 -CidrBlock 10.0.0.0/24
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateSubnet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Tag`
O código de exemplo a seguir mostra como usar `New-EC2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona uma única tag ao recurso especificado. A chave da tag é 'myTag' e o valor da tag é 'myTagValue'. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
New-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag"; Value="myTagValue" }
```
**Exemplo 2: esse exemplo atualiza ou adiciona as tags especificadas ao recurso especificado. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
New-EC2Tag -Resource i-12345678 -Tag @( @{ Key="myTag"; Value="newTagValue" }, @{ Key="test"; Value="anotherTagValue" } )
```
**Exemplo 3: Com a PowerShell versão 2, você deve usar New-Object para criar a tag para o parâmetro Tag.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
New-EC2Tag -Resource i-12345678 -Tag $tag
```
+ Para obter detalhes da API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Volume`
O código de exemplo a seguir mostra como usar `New-EC2Volume`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria o volume especificado.**
```
New-EC2Volume -Size 50 -AvailabilityZone us-west-2a -VolumeType gp2
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo de solicitação cria um volume e aplica uma tag com uma chave de pilha e um valor de produção.**
```
$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 obter detalhes da API, consulte [CreateVolume](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2Vpc`
O código de exemplo a seguir mostra como usar `New-EC2Vpc`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma VPC com o CIDR especificado. A Amazon VPC também cria o seguinte para a VPC: um conjunto de opções DHCP padrão, uma tabela de rotas principal e uma ACL de rede padrão.**
```
New-EC2VPC -CidrBlock 10.0.0.0/16
```
**Saída**:
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : pending
Tags : {}
VpcId : vpc-12345678
```
+ Para obter detalhes da API, consulte [CreateVpc](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2VpcEndpoint`
O código de exemplo a seguir mostra como usar `New-EC2VpcEndpoint`.
**Ferramentas para PowerShell V5**
**Exemplo 1: nesse exemplo, crie um endpoint da VPC para o serviço com.amazonaws.eu-west-1.s3 na VPC vpc-0fc1ff23f45b678eb**
```
New-EC2VpcEndpoint -ServiceName com.amazonaws.eu-west-1.s3 -VpcId vpc-0fc1ff23f45b678eb
```
**Saída**:
```
ClientToken VpcEndpoint
----------- -----------
Amazon.EC2.Model.VpcEndpoint
```
+ Para obter detalhes da API, consulte [CreateVpcEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2VpnConnection`
O código de exemplo a seguir mostra como usar `New-EC2VpnConnection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma conexão VPN entre o gateway privado virtual especificado e o gateway do cliente especificado. A saída inclui as informações de configuração de que o administrador de rede precisa no formato XML.**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d
```
**Saída**:
```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId : cgw-1a2b3c4d
Options :
Routes : {}
State : pending
Tags : {}
Type :
VgwTelemetry : {}
VpnConnectionId : vpn-12345678
VpnGatewayId : vgw-1a2b3c4d
```
**Exemplo 2: esse exemplo cria a conexão VPN e captura a configuração em um arquivo com o nome especificado.**
```
(New-EC2VpnConnection -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d).CustomerGatewayConfiguration | Out-File C:\path\vpn-configuration.xml
```
**Exemplo 3: esse exemplo cria uma conexão VPN, com roteamento estático, entre o gateway privado virtual especificado e o gateway do cliente especificado.**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d -Options_StaticRoutesOnly $true
```
+ Para obter detalhes da API, consulte [CreateVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2VpnConnectionRoute`
O código de exemplo a seguir mostra como usar `New-EC2VpnConnectionRoute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria a rota estática especificada para a conexão VPN especificada.**
```
New-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
+ Para obter detalhes da API, consulte [CreateVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EC2VpnGateway`
O código de exemplo a seguir mostra como usar `New-EC2VpnGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria o gateway privado virtual especificado.**
```
New-EC2VpnGateway -Type ipsec.1
```
**Saída**:
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {}
VpnGatewayId : vgw-1a2b3c4d
```
+ Para obter detalhes da API, consulte [CreateVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-EC2Address`
O código de exemplo a seguir mostra como usar `Register-EC2Address`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa o endereço IP elástico especificado à instância especificada em uma VPC.**
```
C:\> Register-EC2Address -InstanceId i-12345678 -AllocationId eipalloc-12345678
```
**Saída**:
```
eipassoc-12345678
```
**Exemplo 2: Este exemplo associa o endereço IP elástico especificado à instância especificada em EC2 -Classic.**
```
C:\> Register-EC2Address -InstanceId i-12345678 -PublicIp 203.0.113.17
```
+ Para obter detalhes da API, consulte [AssociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-EC2DhcpOption`
O código de exemplo a seguir mostra como usar `Register-EC2DhcpOption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa o conjunto de opções de DHCP especificado à VPC especificada.**
```
Register-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d -VpcId vpc-12345678
```
**Exemplo 2: esse exemplo associa o conjunto padrão de opções de DHCP à VPC especificada.**
```
Register-EC2DhcpOption -DhcpOptionsId default -VpcId vpc-12345678
```
+ Para obter detalhes da API, consulte [AssociateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-EC2Image`
O código de exemplo a seguir mostra como usar `Register-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma AMI usando o arquivo de manifesto especificado no Amazon S3.**
```
Register-EC2Image -ImageLocation amzn-s3-demo-bucket/my-web-server-ami/image.manifest.xml -Name my-web-server-ami
```
+ Para obter detalhes da API, consulte [RegisterImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-EC2PrivateIpAddress`
O código de exemplo a seguir mostra como usar `Register-EC2PrivateIpAddress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atribui os endereços IP privados secundários especificados à interface de rede especificada.**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
**Exemplo 2: esse exemplo cria dois endereços IP privados secundários e os atribui à interface de rede especificada.**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -SecondaryPrivateIpAddressCount 2
```
+ Para obter detalhes da API, consulte [AssignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-EC2RouteTable`
O código de exemplo a seguir mostra como usar `Register-EC2RouteTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa a tabela de rotas especificada à sub-rede especificada**.
```
Register-EC2RouteTable -RouteTableId rtb-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**Saída**:
```
rtbassoc-12345678
```
+ Para obter detalhes da API, consulte [AssociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Address`
O código de exemplo a seguir mostra como usar `Remove-EC2Address`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo libera o endereço IP elástico especificado para instâncias em uma VPC.**
```
Remove-EC2Address -AllocationId eipalloc-12345678 -Force
```
**Exemplo 2: Este exemplo libera o endereço IP elástico especificado para instâncias em EC2 -Classic.**
```
Remove-EC2Address -PublicIp 198.51.100.2 -Force
```
+ Para obter detalhes da API, consulte [ReleaseAddress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2CapacityReservation`
O código de exemplo a seguir mostra como usar `Remove-EC2CapacityReservation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela a reserva de capacidade cr-0c1f2345db6f7cdba**
```
Remove-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba
```
**Saída**:
```
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 obter detalhes da API, consulte [CancelCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2CustomerGateway`
O código de exemplo a seguir mostra como usar `Remove-EC2CustomerGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o gateway do cliente especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2DhcpOption`
O código de exemplo a seguir mostra como usar `Remove-EC2DhcpOption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o conjunto de opções DHCP especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2FlowLog`
O código de exemplo a seguir mostra como usar `Remove-EC2FlowLog`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove o FlowLogId fl-01a2b3456a789c01 fornecido**
```
Remove-EC2FlowLog -FlowLogId fl-01a2b3456a789c01
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Host`
O código de exemplo a seguir mostra como usar `Remove-EC2Host`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo libera o ID de host h-0badafd1dcb2f3456 fornecido**
```
Remove-EC2Host -HostId h-0badafd1dcb2f3456
```
**Saída**:
```
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 obter detalhes da API, consulte [ReleaseHosts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Instance`
O código de exemplo a seguir mostra como usar `Remove-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo encerra a instância especificada (a instância pode estar em execução ou no estado “interrompido”). O cmdlet solicitará uma confirmação antes de continuar. Use a opção -Force para suprimir a solicitação.**
```
Remove-EC2Instance -InstanceId i-12345678
```
**Saída**:
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ Para obter detalhes da API, consulte [TerminateInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2InternetGateway`
O código de exemplo a seguir mostra como usar `Remove-EC2InternetGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o gateway da internet especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2KeyPair`
O código de exemplo a seguir mostra como usar `Remove-EC2KeyPair`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o par de chaves especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2KeyPair -KeyName my-key-pair
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2NetworkAcl`
O código de exemplo a seguir mostra como usar `Remove-EC2NetworkAcl`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a ACL de rede especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2NetworkAcl -NetworkAclId acl-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2NetworkAclEntry`
O código de exemplo a seguir mostra como usar `Remove-EC2NetworkAclEntry`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a regra especificada da ACL de rede especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2NetworkInterface`
O código de exemplo a seguir mostra como usar `Remove-EC2NetworkInterface`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a interface de rede especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2PlacementGroup`
O código de exemplo a seguir mostra como usar `Remove-EC2PlacementGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o grupo de posicionamento especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2PlacementGroup -GroupName my-placement-group
```
**Saída**:
```
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 obter detalhes da API, consulte [DeletePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Route`
O código de exemplo a seguir mostra como usar `Remove-EC2Route`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a rota especificada da tabela de rotas especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteRoute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2RouteTable`
O código de exemplo a seguir mostra como usar `Remove-EC2RouteTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a tabela de rotas especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2SecurityGroup`
O código de exemplo a seguir mostra como usar `Remove-EC2SecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui o grupo de segurança especificado para EC2 -VPC. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2SecurityGroup -GroupId sg-12345678
```
**Saída**:
```
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"):
```
**Exemplo 2: Este exemplo exclui o grupo de segurança especificado para EC2 -Classic.**
```
Remove-EC2SecurityGroup -GroupName my-security-group -Force
```
+ Para obter detalhes da API, consulte [DeleteSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Snapshot`
O código de exemplo a seguir mostra como usar `Remove-EC2Snapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o snapshot especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2Snapshot -SnapshotId snap-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2SpotDatafeedSubscription`
O código de exemplo a seguir mostra como usar `Remove-EC2SpotDatafeedSubscription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o feed de dados da instância spot. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2SpotDatafeedSubscription
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Subnet`
O código de exemplo a seguir mostra como usar `Remove-EC2Subnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a sub-rede especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteSubnet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Tag`
O código de exemplo a seguir mostra como usar `Remove-EC2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a tag especificada do recurso especificado, independentemente do valor da tag. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag" } -Force
```
**Exemplo 2: esse exemplo exclui a tag especificada do recurso especificado, mas somente se o valor da tag corresponder. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag";Value="myTagValue" } -Force
```
**Exemplo 3: esse exemplo exclui a tag especificada do recurso especificado, independentemente do valor da tag.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
**Exemplo 4: esse exemplo exclui a tag especificada do recurso especificado, mas somente se o valor da tag corresponder.**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
+ Para obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Volume`
O código de exemplo a seguir mostra como usar `Remove-EC2Volume`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desvincula o volume especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2Volume -VolumeId vol-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteVolume](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2Vpc`
O código de exemplo a seguir mostra como usar `Remove-EC2Vpc`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a VPC especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2Vpc -VpcId vpc-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteVpc](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2VpnConnection`
O código de exemplo a seguir mostra como usar `Remove-EC2VpnConnection`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui conexão VPN especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2VpnConnectionRoute`
O código de exemplo a seguir mostra como usar `Remove-EC2VpnConnectionRoute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a rota estática especificada da conexão VPN especificada. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EC2VpnGateway`
O código de exemplo a seguir mostra como usar `Remove-EC2VpnGateway`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o gateway privado virtual especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Request-EC2SpotFleet`
O código de exemplo a seguir mostra como usar `Request-EC2SpotFleet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma solicitação de frota spot na zona de disponibilidade com o menor preço para o tipo de instância especificado. Se sua conta suportar somente EC2 -VPC, a frota spot executa as instâncias na zona de disponibilidade de menor preço que tem uma sub-rede padrão. Se sua conta suportar EC2 -Classic, a frota spot executa as instâncias em EC2 -Classic na zona de disponibilidade de menor preço. Observe que o preço pago não excederá o preço spot especificado para a solicitação.**
```
$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 obter detalhes da API, consulte [RequestSpotFleet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Request-EC2SpotInstance`
O código de exemplo a seguir mostra como usar `Request-EC2SpotInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo solicita uma instância spot única na sub-rede especificada. Observe que o grupo de segurança deve ser criado para a VPC que contém a sub-rede especificada e deve ser especificado por ID usando a interface de rede. Ao especificar uma interface de rede, você deve incluir o ID da sub-rede usando a interface de rede.**
```
$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
```
**Saída**:
```
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 obter detalhes da API, consulte [RequestSpotInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-EC2ImageAttribute`
O código de exemplo a seguir mostra como usar `Reset-EC2ImageAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo redefine o atributo “launchPermission” para seu valor padrão. Por padrão, AMIs são privados.**
```
Reset-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
+ Para obter detalhes da API, consulte [ResetImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-EC2InstanceAttribute`
O código de exemplo a seguir mostra como usar `Reset-EC2InstanceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo redefine o atributo sriovNetSupport '' para a instância especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**Exemplo 2: esse exemplo redefine o atributo “ebsOptimized” para a instância especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**Exemplo 3: Esse exemplo redefine o atributo sourceDestCheck '' para a instância especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sourceDestCheck
```
**Exemplo 4: Esse exemplo redefine o atributo disableApiTermination '' para a instância especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**Exemplo 5: Esse exemplo redefine o atributo “instanceInitiatedShutdownComportamento” para a instância especificada.**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
+ Para obter detalhes da API, consulte [ResetInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-EC2NetworkInterfaceAttribute`
O código de exemplo a seguir mostra como usar `Reset-EC2NetworkInterfaceAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo redefine a source/destination verificação da interface de rede especificada.**
```
Reset-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck
```
+ Para obter detalhes da API, consulte [ResetNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-EC2SnapshotAttribute`
O código de exemplo a seguir mostra como usar `Reset-EC2SnapshotAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo redefine o atributo especificado do snapshot especificado.**
```
Reset-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission
```
+ Para obter detalhes da API, consulte [ResetSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Restart-EC2Instance`
O código de exemplo a seguir mostra como usar `Restart-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo reinicia a instância especificada.**
```
Restart-EC2Instance -InstanceId i-12345678
```
+ Para obter detalhes da API, consulte [RebootInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Revoke-EC2SecurityGroupEgress`
O código de exemplo a seguir mostra como usar `Revoke-EC2SecurityGroupEgress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo remove a regra do grupo de segurança especificado para EC2 -VPC. Isso revoga o acesso ao intervalo de endereços IP especificado na porta TCP 80. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar o 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
```
**Exemplo 3: esse exemplo revoga o acesso ao grupo de segurança de origem especificado na porta 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 obter detalhes da API, consulte [RevokeSecurityGroupEgress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Revoke-EC2SecurityGroupIngress`
O código de exemplo a seguir mostra como usar `Revoke-EC2SecurityGroupIngress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo revoga o acesso à porta TCP 22 do intervalo de endereços especificado para o grupo de segurança especificado para -VPC. EC2 Observe que você deve identificar grupos de segurança para EC2 -VPC usando o ID do grupo de segurança, não o nome do grupo de segurança. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission $ip
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar o 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
```
**Exemplo 3: Este exemplo revoga o acesso à porta TCP 22 do intervalo de endereços especificado para o grupo de segurança especificado para -Classic. EC2 A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission $ip
```
**Exemplo 4: Com a PowerShell versão 2, você deve usar New-Object para criar o 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 obter detalhes da API, consulte [RevokeSecurityGroupIngress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Send-EC2InstanceStatus`
O código de exemplo a seguir mostra como usar `Send-EC2InstanceStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo informa o feedback de status para a instância especificada.**
```
Send-EC2InstanceStatus -Instance i-12345678 -Status impaired -ReasonCode unresponsive
```
+ Para obter detalhes da API, consulte [ReportInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-EC2NetworkAclAssociation`
O código de exemplo a seguir mostra como usar `Set-EC2NetworkAclAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa a ACL de rede especificada à sub-rede da associação de ACL de rede especificada.**
```
Set-EC2NetworkAclAssociation -NetworkAclId acl-12345678 -AssociationId aclassoc-1a2b3c4d
```
**Saída**:
```
aclassoc-87654321
```
+ Para obter detalhes da API, consulte [ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-EC2NetworkAclEntry`
O código de exemplo a seguir mostra como usar `Set-EC2NetworkAclEntry`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui a entrada especificada da ACL de rede especificada. A nova regra permite tráfego de entrada do endereço especificado para qualquer sub-rede associada.**
```
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 obter detalhes da API, consulte [ReplaceNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-EC2Route`
O código de exemplo a seguir mostra como usar `Set-EC2Route`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui a rota especificada para a tabela de rotas especificada. A nova rota envia o tráfego especificado ao gateway privado virtual especificado.**
```
Set-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 10.0.0.0/24 -GatewayId vgw-1a2b3c4d
```
+ Para obter detalhes da API, consulte [ReplaceRoute](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-EC2RouteTableAssociation`
O código de exemplo a seguir mostra como usar `Set-EC2RouteTableAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa a tabela de rotas especificada à sub-rede para a associação da tabela de rotas especificada.**
```
Set-EC2RouteTableAssociation -RouteTableId rtb-1a2b3c4d -AssociationId rtbassoc-12345678
```
**Saída**:
```
rtbassoc-87654321
```
+ Para obter detalhes da API, consulte [ReplaceRouteTableAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-EC2Instance`
O código de exemplo a seguir mostra como usar `Start-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo inicia a instância especificada.**
```
Start-EC2Instance -InstanceId i-12345678
```
**Saída**:
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
**Exemplo 2: esse exemplo inicia as instâncias especificadas.**
```
@("i-12345678", "i-76543210") | Start-EC2Instance
```
**Exemplo 3: esse exemplo inicia o conjunto de instâncias que estão atualmente paradas. Os objetos Instance retornados por Get-EC2Instance são canalizados paraStart-EC2Instance. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou superior.**
```
(Get-EC2Instance -Filter @{ Name="instance-state-name"; Values="stopped"}).Instances | Start-EC2Instance
```
**Exemplo 4: Com a PowerShell versão 2, você deve usar New-Object para criar o filtro para o 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
```
**Exemplo 5: Este exemplo valida as permissões para iniciar uma EC2 instância usando o DryRun parâmetro sem realmente iniciar a instância. Nota: se isso for feito com sucesso, será gerada uma exceção, que é o comportamento esperado.**
```
Start-EC2Instance -InstanceId 'i-0abcdef123456' -Region 'us-west-1' -DryRun $true
```
+ Para obter detalhes da API, consulte [StartInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-EC2InstanceMonitoring`
O código de exemplo a seguir mostra como usar `Start-EC2InstanceMonitoring`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo de comando habilita o monitoramento detalhado da instância especificada.**
```
Start-EC2InstanceMonitoring -InstanceId i-12345678
```
**Saída**:
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ Para obter detalhes da API, consulte [MonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-EC2ImportTask`
O código de exemplo a seguir mostra como usar `Stop-EC2ImportTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela a tarefa de importação especificada (importação de snapshot ou de imagem). Se necessário, um motivo pode ser fornecido usando o parâmetro `-CancelReason`.**
```
Stop-EC2ImportTask -ImportTaskId import-ami-abcdefgh
```
+ Para obter detalhes da API, consulte [CancelImportTask](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-EC2Instance`
O código de exemplo a seguir mostra como usar `Stop-EC2Instance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo interrompe a instância especificada.**
```
Stop-EC2Instance -InstanceId i-12345678
```
**Saída**:
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ Para obter detalhes da API, consulte [StopInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-EC2InstanceMonitoring`
O código de exemplo a seguir mostra como usar `Stop-EC2InstanceMonitoring`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo de comando desabilita o monitoramento detalhado da instância especificada.**
```
Stop-EC2InstanceMonitoring -InstanceId i-12345678
```
**Saída**:
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ Para obter detalhes da API, consulte [UnmonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-EC2SpotFleetRequest`
O código de exemplo a seguir mostra como usar `Stop-EC2SpotFleetRequest`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela a solicitação de frota spot especificada e encerra as instâncias spot associadas.**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $true
```
**Exemplo 2: esse exemplo cancela a solicitação de frota spot especificada sem encerrar as instâncias spot associadas.**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $false
```
+ Para obter detalhes da API, consulte [CancelSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-EC2SpotInstanceRequest`
O código de exemplo a seguir mostra como usar `Stop-EC2SpotInstanceRequest`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela a solicitação de instância spot especificada.**
```
Stop-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**Saída**:
```
SpotInstanceRequestId State
--------------------- -----
sir-12345678 cancelled
```
+ Para obter detalhes da API, consulte [CancelSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-EC2Address`
O código de exemplo a seguir mostra como usar `Unregister-EC2Address`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo desassocia o endereço IP elástico especificado da instância especificada em uma VPC.**
```
Unregister-EC2Address -AssociationId eipassoc-12345678
```
**Exemplo 2: Este exemplo dissocia o endereço IP elástico especificado da instância especificada em EC2 -Classic.**
```
Unregister-EC2Address -PublicIp 203.0.113.17
```
+ Para obter detalhes da API, consulte [DisassociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-EC2Image`
O código de exemplo a seguir mostra como usar `Unregister-EC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela o registro da AMI especificada.**
```
Unregister-EC2Image -ImageId ami-12345678
```
+ Para obter detalhes da API, consulte [DeregisterImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-EC2PrivateIpAddress`
O código de exemplo a seguir mostra como usar `Unregister-EC2PrivateIpAddress`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela a atribuição do endereço IP privado especificado da interface de rede especificada.**
```
Unregister-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
+ Para obter detalhes da API, consulte [UnassignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-EC2RouteTable`
O código de exemplo a seguir mostra como usar `Unregister-EC2RouteTable`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a associação especificada entre uma tabela de rotas e uma sub-rede.**
```
Unregister-EC2RouteTable -AssociationId rtbassoc-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DisassociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-EC2SecurityGroupRuleIngressDescription`
O código de exemplo a seguir mostra como usar `Update-EC2SecurityGroupRuleIngressDescription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza a descrição de uma regra de grupo de segurança de entrada.**
```
$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
```
**Exemplo 2: remove a descrição de uma regra de grupo de segurança de entrada (entrada) existente (omitindo o parâmetro na solicitação).**
```
$existingInboundRule = Get-EC2SecurityGroupRule -SecurityGroupRuleId "sgr-1234567890"
$ruleWithoutDescription = [Amazon.EC2.Model.SecurityGroupRuleDescription]@{
"SecurityGroupRuleId" = $existingInboundRule.SecurityGroupRuleId
}
Update-EC2SecurityGroupRuleIngressDescription -GroupId $existingInboundRule.GroupId -SecurityGroupRuleDescription $ruleWithoutDescription
```
+ Para obter detalhes da API, consulte [UpdateSecurityGroupRuleDescriptionsIngress](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon ECR usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon ECR.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-ECRLoginCommand`
O código de exemplo a seguir mostra como usar `Get-ECRLoginCommand`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna um PSObject arquivo contendo informações de login que podem ser usadas para autenticar qualquer registro do Amazon ECR ao qual seu diretor do IAM tenha acesso. As credenciais e o endpoint da região necessários para que a chamada obtenha o token de autorização são obtidos dos padrões do shell (configurados pelos cmdlets `Set-AWSCredential/Set-DefaultAWSRegion` ou `Initialize-AWSDefaultConfiguration`). Você pode usar a propriedade Command com Invoke-Expression para fazer login no registro especificado ou usar as credenciais retornadas em outras ferramentas que exigem login.**
```
Get-ECRLoginCommand
```
**Saída**:
```
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
```
**Exemplo 2: recupera uma informação de login PSObject contendo que você usa como entrada para um comando docker login. Você pode especificar qualquer URI de registro do Amazon ECR para se autenticar, desde que a entidade principal do IAM tenha acesso a esse registro.**
```
(Get-ECRLoginCommand).Password | docker login --username AWS --password-stdin 012345678910.dkr.ecr.us-east-1.amazonaws.com
```
+ Para obter detalhes da API, consulte [Get- ECRLogin Command](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de Ferramentas da AWS para PowerShell Cmdlet (V5)*.
# Exemplos do Amazon ECS usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon ECS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-ECSClusterDetail`
O código de exemplo a seguir mostra como usar `Get-ECSClusterDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet descreve um ou mais de seus clusters do ECS.**
```
Get-ECSClusterDetail -Cluster "LAB-ECS-CL" -Include SETTINGS | Select-Object *
```
**Saída**:
```
LoggedAt : 12/27/2019 9:27:41 PM
Clusters : {LAB-ECS-CL}
Failures : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 396
HttpStatusCode : OK
```
+ Para obter detalhes da API, consulte [DescribeClusters](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ECSClusterList`
O código de exemplo a seguir mostra como usar `Get-ECSClusterList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet retorna uma lista de clusters do ECS existentes.**
```
Get-ECSClusterList
```
**Saída**:
```
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS
```
+ Para obter detalhes da API, consulte [ListClusters](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ECSClusterService`
O código de exemplo a seguir mostra como usar `Get-ECSClusterService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os serviços em execução no cluster padrão.**
```
Get-ECSClusterService
```
**Exemplo 2: esse exemplo lista todos os serviços em execução no cluster especificado.**
```
Get-ECSClusterService -Cluster myCluster
```
+ Para obter detalhes da API, consulte [ListServices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ECSService`
O código de exemplo a seguir mostra como usar `Get-ECSService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra como recuperar detalhes de um serviço específico do cluster padrão.**
```
Get-ECSService -Service my-hhtp-service
```
**Exemplo 2: esse exemplo mostra como recuperar detalhes de um serviço específico em execução no cluster nomeado.**
```
Get-ECSService -Cluster myCluster -Service my-hhtp-service
```
+ Para obter detalhes da API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ECSCluster`
O código de exemplo a seguir mostra como usar `New-ECSCluster`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet cria um cluster do Amazon ECS.**
```
New-ECSCluster -ClusterName "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="enabled"}
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ECSService`
O código de exemplo a seguir mostra como usar `New-ECSService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo de comando cria um serviço em seu cluster padrão chamado `ecs-simple-service`. O serviço usa a definição de tarefa “ecs-demo” e mantém 10 instanciações dessa tarefa.**
```
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10
```
**Exemplo 2: Esse exemplo de comando cria um serviço por trás de um balanceador de carga em seu cluster padrão chamado `ecs-simple-service`. O serviço usa a definição de tarefa “ecs-demo” e mantém 10 instanciações dessa tarefa.**
```
$lb = @{
LoadBalancerName = "EC2Contai-EcsElast-S06278JGSJCM"
ContainerName = "simple-demo"
ContainerPort = 80
}
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10 -LoadBalancer $lb
```
+ Para obter detalhes da API, consulte [CreateService](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ECSCluster`
O código de exemplo a seguir mostra como usar `Remove-ECSCluster`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui o cluster do ECS especificado. Cancele o registro de todas as instâncias de contêiner desse cluster antes de excluí-las.**
```
Remove-ECSCluster -Cluster "LAB-ECS"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ECSService`
O código de exemplo a seguir mostra como usar `Remove-ECSService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o serviço chamado 'my-http-service' no cluster padrão. O serviço deve ter uma contagem desejada e uma contagem contínua de 0 antes que você possa excluí-lo. A confirmação será solicitada antes que o comando continue. Para ignorar a solicitação confirmação, adicione a opção -Force.**
```
Remove-ECSService -Service my-http-service
```
**Exemplo 2: exclui o serviço chamado 'my-http-service' no cluster nomeado.**
```
Remove-ECSService -Cluster myCluster -Service my-http-service
```
+ Para obter detalhes da API, consulte [DeleteService](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-ECSClusterSetting`
O código de exemplo a seguir mostra como usar `Update-ECSClusterSetting`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet modifica as configurações a serem usadas em um cluster do ECS.**
```
Update-ECSClusterSetting -Cluster "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="disabled"}
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateClusterSettings](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-ECSService`
O código de exemplo a seguir mostra como usar `Update-ECSService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo de comando atualiza o serviço my-http-service `` para usar a definição de tarefa amazon-ecs-sample ``.**
```
Update-ECSService -Service my-http-service -TaskDefinition amazon-ecs-sample
```
**Exemplo 2: Este exemplo de comando atualiza a contagem desejada do serviço my-http-service `` para 10.**
```
Update-ECSService -Service my-http-service -DesiredCount 10
```
+ Para obter detalhes da API, consulte [UpdateService](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon EFS usando ferramentas para PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon EFS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Edit-EFSMountTargetSecurityGroup`
O código de exemplo a seguir mostra como usar `Edit-EFSMountTargetSecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza os grupos de segurança em vigor para o destino de montagem especificado. Até cinco podem ser especificados, no formato “sg-xxxxxxxx”.**
```
Edit-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d -SecurityGroup sg-group1,sg-group3
```
+ Para obter detalhes da API, consulte [ModifyMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EFSFileSystem`
O código de exemplo a seguir mostra como usar `Get-EFSFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna a coleção de todos os sistemas de arquivos de propriedade da conta do chamador na região.**
```
Get-EFSFileSystem
```
**Saída**:
```
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
...
```
**Exemplo 2: retorna os detalhes do sistema de arquivos especificado.**
```
Get-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
**Exemplo 3: retorna os detalhes de um sistema de arquivos usando o token de criação de idempotência que foi especificado no momento em que o sistema de arquivos foi criado.**
```
Get-EFSFileSystem -CreationToken 1a2bff54-85e0-4747-bd95-7bc172c4f555
```
+ Para obter detalhes da API, consulte [DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EFSMountTarget`
O código de exemplo a seguir mostra como usar `Get-EFSMountTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna a coleção de destinos de montagem associados ao sistema de arquivos especificado.**
```
Get-EFSMountTarget -FileSystemId fs-1a2b3c4d
```
**Saída**:
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : available
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DescribeMountTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EFSMountTargetSecurityGroup`
O código de exemplo a seguir mostra como usar `Get-EFSMountTargetSecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os IDs dos grupos de segurança atualmente atribuídos à interface de rede associada ao destino de montagem.**
```
Get-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d
```
**Saída**:
```
sg-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DescribeMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EFSTag`
O código de exemplo a seguir mostra como usar `Get-EFSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna a coleção de tags atualmente associadas ao sistema de arquivos especificado.**
```
Get-EFSTag -FileSystemId fs-1a2b3c4d
```
**Saída**:
```
Key Value
--- -----
Name My File System
tagkey1 tagvalue1
tagkey2 tagvalue2
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EFSFileSystem`
O código de exemplo a seguir mostra como usar `New-EFSFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um sistema de arquivos vazio. O token usado para garantir a criação idempotente será gerado automaticamente e poderá ser acessado pelo membro `CreationToken` do objeto retornado.**
```
New-EFSFileSystem
```
**Saída**:
```
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
```
**Exemplo 2: cria um sistema de arquivos vazio usando um token personalizado para garantir uma criação idempotente.**
```
New-EFSFileSystem -CreationToken "MyUniqueToken"
```
+ Para obter detalhes da API, consulte [CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EFSMountTarget`
O código de exemplo a seguir mostra como usar `New-EFSMountTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um destino de montagem para um sistema de arquivos. A sub-rede especificada será usada para determinar a nuvem privada virtual (VPC) na qual o destino de montagem será criado e o endereço IP que será atribuído automaticamente (do intervalo de endereços da sub-rede). O endereço IP atribuído pode ser usado para montar esse sistema de arquivos em uma EC2 instância da Amazon. Como nenhum grupo de segurança foi especificado, a interface de rede criada para o destino está associada ao grupo de segurança padrão para a VPC da sub-rede.**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**Saída**:
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : creating
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
**Exemplo 2: cria um destino de montagem para o sistema de arquivos especificado com endereço IP atribuído automaticamente. A interface de rede criada para o destino de montagem está associada aos grupos de segurança especificados (até cinco, no formato “sg-xxxxxxxx”, podem ser especificados).**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -SecurityGroup sg-group1,sg-group2,sg-group3
```
**Exemplo 3: cria um destino de montagem para o sistema de arquivos especificado com o endereço IP especificado.**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -IpAddress 10.0.0.131
```
+ Para obter detalhes da API, consulte [CreateMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EFSTag`
O código de exemplo a seguir mostra como usar `New-EFSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: aplica a coleção de tags ao sistema de arquivos especificado. Se uma tag com a chave especificada já existir no sistema de arquivos, o valor da tag será atualizado.**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="tagkey1";Value="tagvalue1"},@{Key="tagkey2";Value="tagvalue2"}
```
**Exemplo 2: define a tag de nome para o sistema de arquivos especificado. Esse valor é retornado junto com outros detalhes do sistema de arquivos quando o Get-EFSFileSystem cmdlet é usado.**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="Name";Value="My File System"}
```
+ Para obter detalhes da API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EFSFileSystem`
O código de exemplo a seguir mostra como usar `Remove-EFSFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o sistema de arquivos especificado que não está mais em uso (se o sistema de arquivos tiver destinos de montagem, eles deverão ser removidos primeiro). É solicitada uma confirmação antes que o cmdlet continue. Para ignorar a confirmação, use a opção `-Force`.**
```
Remove-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EFSMountTarget`
O código de exemplo a seguir mostra como usar `Remove-EFSMountTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o destino de montagem especificado. A confirmação será solicitada antes que a operação continue. Para suprimir o prompt, use a opção `-Force`. Observe que essa operação interrompe à força qualquer montagem do sistema de arquivos por meio do destino. Convém considerar a desmontagem do sistema de arquivos antes de executar esse comando, se possível.**
```
Remove-EFSMountTarget -MountTargetId fsmt-1a2b3c4d
```
+ Para obter detalhes da API, consulte [DeleteMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EFSTag`
O código de exemplo a seguir mostra como usar `Remove-EFSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a coleção de uma ou mais tags de um sistema de arquivos. É solicitada uma confirmação antes que o cmdlet continue. Para ignorar a confirmação, use a opção `-Force`.**
```
Remove-EFSTag -FileSystemId fs-1a2b3c4d -TagKey "tagkey1","tagkey2"
```
+ Para obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon EKS usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon EKS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-EKSResourceTag`
O código de exemplo a seguir mostra como usar `Add-EKSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet associa as tags especificadas a um recurso com o resourceArn especificado.**
```
Add-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -Tag @{Name = "EKSPRODCLUSTER"}
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSCluster`
O código de exemplo a seguir mostra como usar `Get-EKSCluster`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet retorna informações descritivas sobre um cluster do Amazon EKS.**
```
Get-EKSCluster -Name "PROD"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeCluster](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSClusterList`
O código de exemplo a seguir mostra como usar `Get-EKSClusterList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet lista os clusters do Amazon EKS Conta da AWS em sua região especificada.**
```
Get-EKSClusterList
```
**Saída**:
```
PROD
```
+ Para obter detalhes da API, consulte [ListClusters](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSFargateProfile`
O código de exemplo a seguir mostra como usar `Get-EKSFargateProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet retorna informações descritivas sobre um perfil do AWS Fargate.**
```
Get-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSFargateProfileList`
O código de exemplo a seguir mostra como usar `Get-EKSFargateProfileList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet lista os perfis do AWS Fargate associados ao cluster especificado no seu Conta da AWS na região especificada.**
```
Get-EKSFargateProfileList -ClusterName "TEST"
```
**Saída**:
```
EKSFargate
EKSFargateProfile
```
+ Para obter detalhes da API, consulte [ListFargateProfiles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSNodegroup`
O código de exemplo a seguir mostra como usar `Get-EKSNodegroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet retorna informações descritivas sobre um grupo de nós do Amazon EKS.**
```
Get-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSNodegroupList`
O código de exemplo a seguir mostra como usar `Get-EKSNodegroupList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet lista os grupos de nós do Amazon EKS associados ao cluster especificado em você Conta da AWS na região especificada.**
```
Get-EKSNodegroupList -ClusterName PROD
```
**Saída**:
```
ProdEKSNodeGroup
```
+ Para obter detalhes da API, consulte [ListNodegroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSResourceTag`
O código de exemplo a seguir mostra como usar `Get-EKSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet lista as tags para um recurso do Amazon EKS.**
```
Get-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD"
```
**Saída**:
```
Key Value
--- -----
Name EKSPRODCLUSTER
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSUpdate`
O código de exemplo a seguir mostra como usar `Get-EKSUpdate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet retorna informações descritivas sobre uma atualização no cluster do Amazon EKS ou grupo de nós gerenciados associado.**
```
Get-EKSUpdate -Name "PROD" -UpdateId "ee708232-7d2e-4ed7-9270-d0b5176f0726"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeUpdate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-EKSUpdateList`
O código de exemplo a seguir mostra como usar `Get-EKSUpdateList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet lista as atualizações associadas a um cluster ou grupo de nós gerenciados do Amazon EKS em seu Conta da AWS, na região especificada.**
```
Get-EKSUpdateList -Name "PROD"
```
**Saída**:
```
ee708232-7d2e-4ed7-9270-d0b5176f0726
```
+ Para obter detalhes da API, consulte [ListUpdates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EKSCluster`
O código de exemplo a seguir mostra como usar `New-EKSCluster`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um cluster chamado “prod”.**
```
New-EKSCluster -Name prod -ResourcesVpcConfig @{SubnetIds=@("subnet-0a1b2c3d","subnet-3a2b1c0d");SecurityGroupIds="sg-6979fe18"} -RoleArn "arn:aws:iam::012345678901:role/eks-service-role"
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EKSFargateProfile`
O código de exemplo a seguir mostra como usar `New-EKSFargateProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet cria um perfil AWS Fargate para seu cluster Amazon EKS. Você deve ter pelo menos um perfil do Fargate em um cluster para poder programar pods na infraestrutura do Fargate.**
```
New-EKSFargateProfile -FargateProfileName EKSFargateProfile -ClusterName TEST -Subnet "subnet-02f6ff500ff2067a0", "subnet-0cd976f08d5fbfaae" -PodExecutionRoleArn arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole -Selector @{Namespace="default"}
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-EKSNodeGroup`
O código de exemplo a seguir mostra como usar `New-EKSNodeGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet cria um grupo gerenciado de nós de processamento para um cluster do Amazon EKS. Você pode criar um grupo de nós para o cluster somente se for igual à versão atual de Kubernetes para o cluster. Todos os grupos de nós são criados com a versão de lançamento mais recente da AMI para a respectiva versão secundária de Kubernetes do cluster.**
```
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"
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EKSCluster`
O código de exemplo a seguir mostra como usar `Remove-EKSCluster`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui um ambiente de gerenciamento de cluster do Amazon EKS.**
```
Remove-EKSCluster -Name "DEV-KUBE-CL"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EKSFargateProfile`
O código de exemplo a seguir mostra como usar `Remove-EKSFargateProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse cmdlet exclui um perfil do AWS Fargate. Quando você exclui um perfil do Fargate, qualquer pod em execução no Fargate que foi criado com o perfil é excluído.**
```
Remove-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EKSNodegroup`
O código de exemplo a seguir mostra como usar `Remove-EKSNodegroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui um grupo de nós do Amazon EKS para um cluster.**
```
Remove-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-EKSResourceTag`
O código de exemplo a seguir mostra como usar `Remove-EKSResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet exclui tags especificadas de um recurso do EKS.**
```
Remove-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -TagKey "Name"
```
**Saída**:
```
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 obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-EKSClusterConfig`
O código de exemplo a seguir mostra como usar `Update-EKSClusterConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza uma configuração de cluster do Amazon EKS. O cluster continua funcionando durante a atualização.**
```
Update-EKSClusterConfig -Name "PROD" -Logging_ClusterLogging @{Types="api","audit","authenticator","controllerManager","scheduler",Enabled="True"}
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateClusterConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-EKSClusterVersion`
O código de exemplo a seguir mostra como usar `Update-EKSClusterVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse cmdlet atualiza um cluster do Amazon EKS para a versão especificada do Kubernetes. O cluster continua funcionando durante a atualização.**
```
Update-EKSClusterVersion -Name "PROD-KUBE-CL" -Version 1.14
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateClusterVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Elastic Load Balancing — Exemplos da versão 1 usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Elastic Load Balancing - Versão 1.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-ELBLoadBalancerToSubnet`
O código de exemplo a seguir mostra como usar `Add-ELBLoadBalancerToSubnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona a sub-rede especificada ao conjunto de sub-redes configuradas para o balanceador de carga especificado. A saída inclui a lista completa de sub-redes.**
```
Add-ELBLoadBalancerToSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**Saída**:
```
subnet-12345678
subnet-87654321
```
+ Para obter detalhes da API, consulte [AttachLoadBalancerToSubnets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-ELBResourceTag`
O código de exemplo a seguir mostra como usar `Add-ELBResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona as tags especificadas ao balanceador de carga especificado. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Add-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project";Value="lima" },@{ Key="department";Value="digital-media" }
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar uma tag para o 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 obter detalhes da API, consulte [AddTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-ELBAvailabilityZoneForLoadBalancer`
O código de exemplo a seguir mostra como usar `Disable-ELBAvailabilityZoneForLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona a Zona de Disponibilidade especificada ao balanceador de carga especificado. A saída inclui as zonas de disponibilidade restantes.**
```
Disable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**Saída**:
```
us-west-2b
```
+ Para obter detalhes da API, consulte [DisableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Dismount-ELBLoadBalancerFromSubnet`
O código de exemplo a seguir mostra como usar `Dismount-ELBLoadBalancerFromSubnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona a sub-rede especificada ao conjunto de sub-redes configuradas para o balanceador de carga especificado. A saída inclui as sub-redes restantes.**
```
Dismount-ELBLoadBalancerFromSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**Saída**:
```
subnet-87654321
```
+ Para obter detalhes da API, consulte [DetachLoadBalancerFromSubnets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELBLoadBalancerAttribute`
O código de exemplo a seguir mostra como usar `Edit-ELBLoadBalancerAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo habilita o balanceamento de carga entre zonas para o balanceador de carga especificado.**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -CrossZoneLoadBalancing_Enabled $true
```
**Exemplo 2: esse exemplo desativa a drenagem da conexão para o balanceador de carga especificado.**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -ConnectionDraining_Enabled $false
```
**Exemplo 3: esse exemplo habilita os logs de acesso para o balanceador 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 obter detalhes da API, consulte [ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-ELBAvailabilityZoneForLoadBalancer`
O código de exemplo a seguir mostra como usar `Enable-ELBAvailabilityZoneForLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona a Zona de Disponibilidade especificada ao balanceador de carga especificado. O resultado inclui a lista completa de zonas de disponibilidade.**
```
Enable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**Saída**:
```
us-west-2a
us-west-2b
```
+ Para obter detalhes da API, consulte [EnableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBInstanceHealth`
O código de exemplo a seguir mostra como usar `Get-ELBInstanceHealth`.
**Ferramentas para PowerShell V5**
**Exemplo 1: descreve o estado das instâncias registradas com o balanceador de carga especificado.**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer
```
**Saída**:
```
Description InstanceId ReasonCode State
----------- ---------- ---------- -----
N/A i-87654321 N/A InService
Instance has failed at lea... i-12345678 Instance OutOfService
```
**Exemplo 2: descreve o estado da instância especificada registrada com o balanceador de carga especificado.**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Exemplo 3: esse exemplo exibe a descrição completa do estado da instância especificada.**
```
(Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678).Description
```
**Saída**:
```
Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
```
+ Para obter detalhes da API, consulte [DescribeInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBLoadBalancer`
O código de exemplo a seguir mostra como usar `Get-ELBLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista os nomes de seus balanceadores de carga.**
```
Get-ELBLoadBalancer | format-table -property LoadBalancerName
```
**Saída**:
```
LoadBalancerName
----------------
my-load-balancer
my-other-load-balancer
my-internal-load-balancer
```
**Exemplo 2: esse exemplo descreve o balanceador de carga especificado.**
```
Get-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**Saída**:
```
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
```
**Exemplo 3: Este exemplo descreve todos os seus balanceadores de carga na AWS região atual.**
```
Get-ELBLoadBalancer
```
**Exemplo 4: esse exemplo descreve todos os balanceadores de carga em todas as Regiões da AWS disponíveis.**
```
Get-AWSRegion | % { Get-ELBLoadBalancer -Region $_ }
```
+ Para obter detalhes da API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBLoadBalancerAttribute`
O código de exemplo a seguir mostra como usar `Get-ELBLoadBalancerAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve os atributos para o balanceador de carga especificado.**
```
Get-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer
```
**Saída**:
```
AccessLog : Amazon.ElasticLoadBalancing.Model.AccessLog
AdditionalAttributes : {}
ConnectionDraining : Amazon.ElasticLoadBalancing.Model.ConnectionDraining
ConnectionSettings : Amazon.ElasticLoadBalancing.Model.ConnectionSettings
CrossZoneLoadBalancing : Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing
```
+ Para obter detalhes da API, consulte [DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBLoadBalancerPolicy`
O código de exemplo a seguir mostra como usar `Get-ELBLoadBalancerPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as políticas associadas ao balanceador de carga especificado.**
```
Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer
```
**Saída**:
```
PolicyAttributeDescriptions PolicyName PolicyTypeName
--------------------------- ---------- --------------
{ProxyProtocol} my-ProxyProtocol-policy ProxyProtocolPolicyType
{CookieName} my-app-cookie-policy AppCookieStickinessPolicyType
```
**Exemplo 2: esse exemplo descreve os atributos da política especificada.**
```
(Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-ProxyProtocol-policy).PolicyAttributeDescriptions
```
**Saída**:
```
AttributeName AttributeValue
------------- --------------
ProxyProtocol true
```
**Exemplo 3: esse exemplo descreve as políticas predefinidas, incluindo os exemplos de políticas. Os nomes das políticas de amostra têm o prefixo ELBSample -.**
```
Get-ELBLoadBalancerPolicy
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeLoadBalancerPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBLoadBalancerPolicyType`
O código de exemplo a seguir mostra como usar `Get-ELBLoadBalancerPolicyType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os tipos de políticas compatíveis com o Elastic Load Balancing.**
```
Get-ELBLoadBalancerPolicyType
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo descreve o tipo de política especificado.**
```
Get-ELBLoadBalancerPolicyType -PolicyTypeName ProxyProtocolPolicyType
```
**Saída**:
```
Description PolicyAttributeTypeDescriptions PolicyTypeName
----------- ------------------------------- --------------
Policy that controls whether to incl... {ProxyProtocol} ProxyProtocolPolicyType
```
**Exemplo 3: esse exemplo exibe a descrição completa do tipo de política especificado.**
```
(Get-ELBLoadBalancerPolicyType -PolicyTypeName).Description
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeLoadBalancerPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELBResourceTag`
O código de exemplo a seguir mostra como usar `Get-ELBResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as tags para os balanceadores de carga especificados.**
```
Get-ELBResourceTag -LoadBalancerName @("my-load-balancer","my-internal-load-balancer")
```
**Saída**:
```
LoadBalancerName Tags
---------------- ----
my-load-balancer {project, department}
my-internal-load-balancer {project, department}
```
**Exemplo 2: esse exemplo descreve as tags para o balanceador de carga especificado.**
```
(Get-ELBResourceTag -LoadBalancerName my-load-balancer).Tags
```
**Saída**:
```
Key Value
--- -----
project lima
department digital-media
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Join-ELBSecurityGroupToLoadBalancer`
O código de exemplo a seguir mostra como usar `Join-ELBSecurityGroupToLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui o grupo de segurança atual do balanceador de carga especificado pelo grupo de segurança especificado.**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup sg-87654321
```
**Saída**:
```
sg-87654321
```
**Exemplo 2: para manter o grupo de segurança atual e especificar um grupo de segurança adicional, especifique os grupos de segurança existentes e os novos.**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup @("sg-12345678", "sg-87654321")
```
**Saída**:
```
sg-12345678
sg-87654321
```
+ Para obter detalhes da API, consulte [ApplySecurityGroupsToLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELBAppCookieStickinessPolicy`
O código de exemplo a seguir mostra como usar `New-ELBAppCookieStickinessPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma política de permanência com os tempos de vida de sessão persistente do cookie gerado pela aplicação.**
```
New-ELBAppCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-app-cookie-policy -CookieName my-app-cookie
```
+ Para obter detalhes da API, consulte [CreateAppCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELBLBCookieStickinessPolicy`
O código de exemplo a seguir mostra como usar `New-ELBLBCookieStickinessPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo gera uma política de persistência com tempos de duração de sessão persistente controlados por um período de validade especificado (em segundos).**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy -CookieExpirationPeriod 60
```
**Exemplo 2: esse exemplo cria uma política de persistência em que o tempo de vida da sessão persistente é controlado pelo tempo de vida do navegador (usuário-agente).**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
+ Para obter detalhes da API, consulte [CreateLbCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELBLoadBalancer`
O código de exemplo a seguir mostra como usar `New-ELBLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um balanceador de carga com um receptor HTTP em uma 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
```
**Exemplo 2: Este exemplo cria um balanceador de carga com um ouvinte HTTP em EC2 -Classic.**
```
New-ELBLoadBalancer -LoadBalancerName my-classic-load-balancer -AvailabilityZone us-west-2a` -Listener $httpListener
```
**Saída**:
```
my-classic-load-balancer-123456789.us-west-2.elb.amazonaws.com
```
**Exemplo 3: esse exemplo cria um balanceador de carga com um receptor 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 obter detalhes da API, consulte [CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELBLoadBalancerListener`
O código de exemplo a seguir mostra como usar `New-ELBLoadBalancerListener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona um receptor HTTPS ao balanceador 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 obter detalhes da API, consulte [CreateLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELBLoadBalancerPolicy`
O código de exemplo a seguir mostra como usar `New-ELBLoadBalancerPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma política de protocolo de proxy para um balanceador 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 obter detalhes da API, consulte [CreateLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-ELBInstanceWithLoadBalancer`
O código de exemplo a seguir mostra como usar `Register-ELBInstanceWithLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo registra a EC2 instância especificada com o balanceador de carga especificado.**
```
Register-ELBInstanceWithLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Saída**:
```
InstanceId
----------
i-12345678
i-87654321
```
+ Para obter detalhes da API, consulte [RegisterInstancesWithLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELBInstanceFromLoadBalancer`
O código de exemplo a seguir mostra como usar `Remove-ELBInstanceFromLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo remove a EC2 instância especificada do balanceador de carga especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-ELBInstanceFromLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**Saída**:
```
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 obter detalhes da API, consulte [DeregisterInstancesFromLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELBLoadBalancer`
O código de exemplo a seguir mostra como usar `Remove-ELBLoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o balanceador de carga especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELBLoadBalancerListener`
O código de exemplo a seguir mostra como usar `Remove-ELBLoadBalancerListener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o receptor da porta 80 do balanceador de carga especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-ELBLoadBalancerListener -LoadBalancerName my-load-balancer -LoadBalancerPort 80
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELBLoadBalancerPolicy`
O código de exemplo a seguir mostra como usar `Remove-ELBLoadBalancerPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a política especificada do balanceador de carga especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force.**
```
Remove-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELBResourceTag`
O código de exemplo a seguir mostra como usar `Remove-ELBResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag especificada do balanceador de carga especificado. Você recebe uma solicitação de confirmação antes de prosseguir com a operação, a menos que também especifique o parâmetro Force. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
Remove-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project" }
```
**Saída**:
```
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"):
```
**Exemplo 2: com o PowerShell versão 2, é necessário usar New-Object para criar a tag para o parâmetro de Tag.**
```
$tag = New-Object Amazon.ElasticLoadBalancing.Model.TagKeyOnly
$tag.Key = "project"
Remove-ELBResourceTag -Tag $tag -Force
```
+ Para obter detalhes da API, consulte [RemoveTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELBHealthCheck`
O código de exemplo a seguir mostra como usar `Set-ELBHealthCheck`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo define as configurações de verificação de integridade do balanceador 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
```
**Saída**:
```
HealthyThreshold : 2
Interval : 30
Target : HTTP:80/ping
Timeout : 3
UnhealthyThreshold : 2
```
+ Para obter detalhes da API, consulte [ConfigureHealthCheck](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELBLoadBalancerListenerSSLCertificate`
O código de exemplo a seguir mostra como usar `Set-ELBLoadBalancerListenerSSLCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui o certificado que encerra as conexões SSL para o receptor especificado.**
```
Set-ELBLoadBalancerListenerSSLCertificate -LoadBalancerName my-load-balancer `
>> -LoadBalancerPort 443 `
>> -SSLCertificateId "arn:aws:iam::123456789012:server-certificate/new-server-cert"
```
+ Para obter detalhes da API, consulte [SetLoadBalancerListenerSslCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELBLoadBalancerPolicyForBackendServer`
O código de exemplo a seguir mostra como usar `Set-ELBLoadBalancerPolicyForBackendServer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui as políticas da porta especificada pela política especificada.**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80 -PolicyName my-ProxyProtocol-policy
```
**Exemplo 2: esse exemplo remove todas as políticas associadas à porta especificada.**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80
```
+ Para obter detalhes da API, consulte [SetLoadBalancerPoliciesForBackendServer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELBLoadBalancerPolicyOfListener`
O código de exemplo a seguir mostra como usar `Set-ELBLoadBalancerPolicyOfListener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo substitui as políticas do receptor especificado pela política especificada.**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443 -PolicyName my-SSLNegotiation-policy
```
**Exemplo 2: esse exemplo remove todas as políticas associadas ao receptor especificado.**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443
```
+ Para obter detalhes da API, consulte [SetLoadBalancerPoliciesOfListener](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Elastic Load Balancing - Exemplos da versão 2 usando ferramentas para V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Elastic Load Balancing - Versão 2.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-ELB2ListenerCertificate`
O código de exemplo a seguir mostra como usar `Add-ELB2ListenerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona um certificado adicional ao receptor 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'}
```
**Saída**:
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97 False
```
+ Para obter detalhes da API, consulte [AddListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-ELB2Tag`
O código de exemplo a seguir mostra como usar `Add-ELB2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona uma nova tag ao recurso `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 obter detalhes da API, consulte [AddTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELB2Listener`
O código de exemplo a seguir mostra como usar `Edit-ELB2Listener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica a ação padrão do receptor especificado para resposta fixa.**
```
$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
```
**Saída**:
```
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 obter detalhes da API, consulte [ModifyListener](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELB2LoadBalancerAttribute`
O código de exemplo a seguir mostra como usar `Edit-ELB2LoadBalancerAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica os atributos do balanceador 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'}
```
**Saída**:
```
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 obter detalhes da API, consulte [ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELB2Rule`
O código de exemplo a seguir mostra como usar `Edit-ELB2Rule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica as configurações especificadas da regra do receptor.**
```
$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
```
**Saída**:
```
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 obter detalhes da API, consulte [ModifyRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELB2TargetGroup`
O código de exemplo a seguir mostra como usar `Edit-ELB2TargetGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica as propriedades do 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
```
**Saída**:
```
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 obter detalhes da API, consulte [ModifyTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-ELB2TargetGroupAttribute`
O código de exemplo a seguir mostra como usar `Edit-ELB2TargetGroupAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica o atributo deregistration\$1delay do 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}
```
**Saída**:
```
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 obter detalhes da API, consulte [ModifyTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2AccountLimit`
O código de exemplo a seguir mostra como usar `Get-ELB2AccountLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando lista os limites ELB2 da conta para uma determinada região.**
```
Get-ELB2AccountLimit
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2Listener`
O código de exemplo a seguir mostra como usar `Get-ELB2Listener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve os receptores do ALB/NLB especificado.**
```
Get-ELB2Listener -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeListeners](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2ListenerCertificate`
O código de exemplo a seguir mostra como usar `Get-ELB2ListenerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o certificado do receptor especificado.**
```
Get-ELB2ListenerCertificate -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Saída**:
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/5fc7c092-68bf-4862-969c-22fd48b6e17c True
```
+ Para obter detalhes da API, consulte [DescribeListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2LoadBalancer`
O código de exemplo a seguir mostra como usar `Get-ELB2LoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe todos os balanceadores de carga de determinada região.**
```
Get-ELB2LoadBalancer
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2LoadBalancerAttribute`
O código de exemplo a seguir mostra como usar `Get-ELB2LoadBalancerAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando descreve os atributos de determinado balanceador de carga.**
```
Get-ELB2LoadBalancerAttribute -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/test-elb/238d34ad8d94bc2e'
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2Rule`
O código de exemplo a seguir mostra como usar `Get-ELB2Rule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as regras do receptor para o ARN do receptor especificado.**
```
Get-ELB2Rule -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeRules](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2SSLPolicy`
O código de exemplo a seguir mostra como usar `Get-ELB2SSLPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista todas as políticas de ouvinte disponíveis para a ElasticLoadBalancing V2.**
```
Get-ELB2SSLPolicy
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeSslPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2Tag`
O código de exemplo a seguir mostra como usar `Get-ELB2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as tags para o recurso especificado.**
```
Get-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Saída**:
```
ResourceArn Tags
----------- ----
arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f {stage, internalName, version}
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2TargetGroup`
O código de exemplo a seguir mostra como usar `Get-ELB2TargetGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve o grupo de destino especificado.**
```
Get-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeTargetGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2TargetGroupAttribute`
O código de exemplo a seguir mostra como usar `Get-ELB2TargetGroupAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve os atributos do grupo de destino especificado.**
```
Get-ELB2TargetGroupAttribute -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ELB2TargetHealth`
O código de exemplo a seguir mostra como usar `Get-ELB2TargetHealth`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o status de integridade dos destinos presentes no grupo de destino especificado.**
```
Get-ELB2TargetHealth -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**Saída**:
```
HealthCheckPort Target TargetHealth
--------------- ------ ------------
80 Amazon.ElasticLoadBalancingV2.Model.TargetDescription Amazon.ElasticLoadBalancingV2.Model.TargetHealth
```
+ Para obter detalhes da API, consulte [DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELB2Listener`
O código de exemplo a seguir mostra como usar `New-ELB2Listener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um receptor do ALB com a ação padrão “Encaminhar” para enviar tráfego ao 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
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateListener](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELB2LoadBalancer`
O código de exemplo a seguir mostra como usar `New-ELB2LoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um Application Load Balancer voltado para a internet com duas sub-redes.**
```
New-ELB2LoadBalancer -Type application -Scheme internet-facing -IpAddressType ipv4 -Name 'New-Test-ALB' -SecurityGroup 'sg-07c3414abb8811cbd' -subnet 'subnet-c37a67a6','subnet-fc02eea0'
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELB2Rule`
O código de exemplo a seguir mostra como usar `New-ELB2Rule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma regra de receptor com ação de resposta fixa com base no valor do cabeçalho do cliente para o receptor 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
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ELB2TargetGroup`
O código de exemplo a seguir mostra como usar `New-ELB2TargetGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um grupo de destino com os parâmetros fornecidos.**
```
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'
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-ELB2Target`
O código de exemplo a seguir mostra como usar `Register-ELB2Target`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra a instância “i-0672a4c4cdeae3111” com o 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 obter detalhes da API, consulte [RegisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2Listener`
O código de exemplo a seguir mostra como usar `Remove-ELB2Listener`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o receptor especificado.**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo remove o receptor especificado do balanceador de carga.**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteListener](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2ListenerCertificate`
O código de exemplo a seguir mostra como usar `Remove-ELB2ListenerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o certificado especificado do 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'
```
**Saída**:
```
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 obter detalhes da API, consulte [RemoveListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2LoadBalancer`
O código de exemplo a seguir mostra como usar `Remove-ELB2LoadBalancer`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o balanceador de carga especificado.**
```
Remove-ELB2LoadBalancer -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2Rule`
O código de exemplo a seguir mostra como usar `Remove-ELB2Rule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a regra especificada do receptor**
```
Remove-ELB2Rule -RuleArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/3873f123b98f7618/4b25eb10a42e33ab'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteRule](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2Tag`
O código de exemplo a seguir mostra como usar `Remove-ELB2Tag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag para a chave especificada.**
```
Remove-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -TagKey 'productVersion'
```
**Saída**:
```
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 obter detalhes da API, consulte [RemoveTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-ELB2TargetGroup`
O código de exemplo a seguir mostra como usar `Remove-ELB2TargetGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o grupo de destino especificado.**
```
Remove-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testsssss/4e0b6076bc6483a7'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELB2IpAddressType`
O código de exemplo a seguir mostra como usar `Set-ELB2IpAddressType`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo altera o tipo de endereço IP do balanceador de carga de 'IPv4' para 'DualStack'.**
```
Set-ELB2IpAddressType -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -IpAddressType dualstack
```
**Saída**:
```
Value
-----
dualstack
```
+ Para obter detalhes da API, consulte [SetIpAddressType](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELB2RulePriority`
O código de exemplo a seguir mostra como usar `Set-ELB2RulePriority`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera a prioridade da regra de receptor especificada.**
```
Set-ELB2RulePriority -RulePriority -RulePriority @{Priority = 11; RuleArn = 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/a4eb199fa5046f80/dbf4c6dcef3ec6f8'}
```
**Saída**:
```
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 obter detalhes da API, consulte [SetRulePriorities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELB2SecurityGroup`
O código de exemplo a seguir mostra como usar `Set-ELB2SecurityGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona o grupo de segurança “sg-07c3414abb8811cbd” ao balanceador de carga especificado.**
```
Set-ELB2SecurityGroup -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -SecurityGroup 'sg-07c3414abb8811cbd'
```
**Saída**:
```
sg-07c3414abb8811cbd
```
+ Para obter detalhes da API, consulte [SetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-ELB2Subnet`
O código de exemplo a seguir mostra como usar `Set-ELB2Subnet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo modifica as sub-redes do balanceador de carga especificado.**
```
Set-ELB2Subnet -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Subnet 'subnet-7d8a0a51','subnet-c37a67a6'
```
**Saída**:
```
LoadBalancerAddresses SubnetId ZoneName
--------------------- -------- --------
{} subnet-7d8a0a51 us-east-1c
{} subnet-c37a67a6 us-east-1b
```
+ Para obter detalhes da API, consulte [SetSubnets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-ELB2Target`
O código de exemplo a seguir mostra como usar `Unregister-ELB2Target`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela o registro da instância “i-0672a4c4cdeae3111” do 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 obter detalhes da API, consulte [DeregisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# FSx Exemplos da Amazon usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com a Amazon FSx.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-FSXResourceTag`
O código de exemplo a seguir mostra como usar `Add-FSXResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona tags ao recurso em questão.**
```
Add-FSXResourceTag -ResourceARN "arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a" -Tag @{Key="Users";Value="Test"}
```
**Saída**:
```
arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-FSXBackup`
O código de exemplo a seguir mostra como usar `Get-FSXBackup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca backups criados desde ontem para o ID do sistema de arquivos fornecido.**
```
Get-FSXBackup -Filter @{Name="file-system-id";Values=$fsx.FileSystemId} | Where-Object CreationTime -gt (Get-Date).AddDays(-1)
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeBackups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-FSXFileSystem`
O código de exemplo a seguir mostra como usar `Get-FSXFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna a descrição de determinado filesystemId.**
```
Get-FSXFileSystem -FileSystemId fs-01cd23bc4bdf5678a
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-FSXResourceTagList`
O código de exemplo a seguir mostra como usar `Get-FSXResourceTagList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as tags para o ARN de recurso fornecido.**
```
Get-FSXResourceTagList -ResourceARN $fsx.ResourceARN
```
**Saída**:
```
Key Value
--- -----
FSx-Service Windows
Users Dev
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-FSXBackup`
O código de exemplo a seguir mostra como usar `New-FSXBackup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um backup do sistema de arquivos fornecido.**
```
New-FSXBackup -FileSystemId fs-0b1fac2345623456ba
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateBackup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-FSXFileSystem`
O código de exemplo a seguir mostra como usar `New-FSXFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um sistema de arquivos do Windows de 300 GB, permitindo acesso pela sub-rede especificada, que permite throughput de até 8 megabytes por segundo. O novo sistema de arquivos é automaticamente associado ao Microsoft Active Directory especificado.**
```
New-FSXFileSystem -FileSystemType WINDOWS -StorageCapacity 300 -SubnetId subnet-1a2b3c4d5e6f -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId='d-1a2b3c4d'}
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-FSXFileSystemFromBackup`
O código de exemplo a seguir mostra como usar `New-FSXFileSystemFromBackup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um novo sistema de FSx arquivos da Amazon a partir de um backup existente do Amazon FSx para 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}
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateFileSystemFromBackup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-FSXBackup`
O código de exemplo a seguir mostra como usar `Remove-FSXBackup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o ID de backup fornecido.**
```
Remove-FSXBackup -BackupId $backupID
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteBackup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-FSXFileSystem`
O código de exemplo a seguir mostra como usar `Remove-FSXFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o ID do sistema de arquivos do FSX fornecido.**
```
Remove-FSXFileSystem -FileSystemId fs-012ff34e567890120
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-FSXResourceTag`
O código de exemplo a seguir mostra como usar `Remove-FSXResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag de recurso para o ARN de recurso do sistema de arquivos do FSX fornecido.**
```
Remove-FSXResourceTag -ResourceARN $FSX.ResourceARN -TagKey Users
```
**Saída**:
```
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 obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-FSXFileSystem`
O código de exemplo a seguir mostra como usar `Update-FSXFileSystem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo atualiza os dias de retenção automática de backup do sistema de arquivos FSX. UpdateFileSystemWindowsConfiguration**
```
$UpdateFSXWinConfig = [Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration]::new()
$UpdateFSXWinConfig.AutomaticBackupRetentionDays = 35
Update-FSXFileSystem -FileSystemId $FSX.FileSystemId -WindowsConfiguration $UpdateFSXWinConfig
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon Glacier usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon Glacier.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-GLCJob`
O código de exemplo a seguir mostra como usar `Get-GLCJob`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exibir detalhes do trabalho especificado. Quando o trabalho é concluído com êxito, o cmdlet GCJob Read-Output pode ser usado para recuperar o conteúdo do trabalho (um arquivo ou uma lista de inventário) para o sistema de arquivos local.**
```
Get-GLCJob -VaultName myvault -JobId "op1x...JSbthM"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeJob](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-GLCVault`
O código de exemplo a seguir mostra como usar `New-GLCVault`.
**Ferramentas para PowerShell V5**
**Exemplo 1: criar novo cofre para a conta do usuário. Como nenhum valor foi fornecido ao AccountId parâmetro -, os cmdlets usam o padrão “-” indicando a conta atual.**
```
New-GLCVault -VaultName myvault
```
**Saída**:
```
/01234567812/vaults/myvault
```
+ Para obter detalhes da API, consulte [CreateVault](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Read-GLCJobOutput`
O código de exemplo a seguir mostra como usar `Read-GLCJobOutput`.
**Ferramentas para PowerShell V5**
**Exemplo 1: baixar o conteúdo do arquivo que foi agendado para recuperação na tarefa especificada e armazená-lo em um arquivo no disco. O download valida a soma de verificação para você, se houver uma disponível. Se desejado, toda a resposta, incluindo a soma de verificação, pode ser exibida especificando `-Select '*'`.**
```
Read-GLCJobOutput -VaultName myvault -JobId "HSWjArc...Zq2XLiW" -FilePath "c:\temp\blue.bin"
```
+ Para obter detalhes da API, consulte [GetJobOutput](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-GLCJob`
O código de exemplo a seguir mostra como usar `Start-GLCJob`.
**Ferramentas para PowerShell V5**
**Exemplo 1: iniciar um trabalho para recuperar um arquivo do cofre especificado de propriedade do usuário. O status do trabalho pode ser verificado usando o GLCJob cmdlet Get-. Quando o trabalho é concluído com êxito, o cmdlet GCJob Read-Output pode ser usado para recuperar o conteúdo do arquivamento no sistema de arquivos local.**
```
Start-GLCJob -VaultName myvault -JobType "archive-retrieval" -JobDescription "archive retrieval" -ArchiveId "o9O9j...TX-TpIhQJw"
```
**Saída**:
```
JobId JobOutputPath Location
----- ------------- --------
op1x...JSbthM /012345678912/vaults/test/jobs/op1xe...I4HqCHkSJSbthM
```
+ Para obter detalhes da API, consulte [InitiateJob](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-GLCArchive`
O código de exemplo a seguir mostra como usar `Write-GLCArchive`.
**Ferramentas para PowerShell V5**
**Exemplo 1: carregar um único arquivo no cofre especificado, exibindo o ID do arquivo e a soma de verificação computada.**
```
Write-GLCArchive -VaultName myvault -FilePath c:\temp\blue.bin
```
**Saída**:
```
FilePath ArchiveId Checksum
-------- --------- --------
C:\temp\blue.bin o9O9jUUs...TTX-TpIhQJw 79f3e...f4395b
```
**Exemplo 2: carregar o conteúdo de uma hierarquia de pastas no cofre especificado na conta do usuário. Para cada arquivo carregado, o cmdlet emite o nome do arquivo, o ID do arquivo correspondente e a soma de verificação computada do arquivo.**
```
Write-GLCArchive -VaultName myvault -FolderPath . -Recurse
```
**Saída**:
```
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 obter detalhes da API, consulte [UploadArchive](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Glue exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Glue.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `New-GLUEJob`
O código de exemplo a seguir mostra como usar `New-GLUEJob`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo cria uma nova tarefa no AWS Glue. O valor do nome do comando é sempre`glueetl`. AWS O Glue é compatível com a execução de scripts de tarefas escritos em Python ou Scala. Neste exemplo, o script de trabalho (MyTestGlueJob.py) é escrito em Python. Os parâmetros do Python são especificados na `$DefArgs` variável e, em seguida, passados para o PowerShell comando no `DefaultArguments` parâmetro, que aceita uma tabela de hash. Os parâmetros na `$JobParams` variável vêm da CreateJob API, documentados no tópico Jobs (https://docs.aws.amazon.com/glue/latest/dg/aws- glue-api-jobs-job .html) da referência da 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 obter detalhes da API, consulte [CreateJob](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Health exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Health.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-HLTHEvent`
O código de exemplo a seguir mostra como usar `Get-HLTHEvent`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna eventos do AWS Personal Health Dashboard. O usuário adiciona o parâmetro -Region para ver os eventos disponíveis para o serviço na região Leste dos EUA (Norte da Virgínia), mas o parâmetro -Filter\$1Region filtra os eventos registrados nas regiões UE (Londres) e Oeste dos EUA (Oregon) (eu-west-2 e us-west-2). O StartTime parâmetro -Filter\$1 filtra por um intervalo de vezes em que os eventos podem começar, enquanto o EndTime parâmetro -Filter\$1 filtra por um intervalo de vezes em que os eventos podem terminar. O resultado é um evento de manutenção programada para o RDS que começa dentro do intervalo -Filter\$1 especificado e termina dentro do StartTime intervalo programado -Filter\$1. 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"}
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeEvents](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de IAM usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a Ferramentas da AWS para PowerShell V5 com o IAM.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-IAMClientIDToOpenIDConnectProvider`
O código de exemplo a seguir mostra como usar `Add-IAMClientIDToOpenIDConnectProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando adiciona o ID do cliente (ou público) `my-application-ID` ao provedor OIDC existente denominado `server.example.com`.**
```
Add-IAMClientIDToOpenIDConnectProvider -ClientID "my-application-ID" -OpenIDConnectProviderARN "arn:aws:iam::123456789012:oidc-provider/server.example.com"
```
+ Para obter detalhes da API, consulte [AddClientIdToOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-IAMRoleTag`
O código de exemplo a seguir mostra como usar `Add-IAMRoleTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo adiciona uma tag ao perfil no Identity Management Service**
```
Add-IAMRoleTag -RoleName AdminRoleacess -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ Para obter detalhes da API, consulte [TagRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-IAMRoleToInstanceProfile`
O código de exemplo a seguir mostra como usar `Add-IAMRoleToInstanceProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando adiciona o perfil denominado `S3Access` a um perfil de instância existente denominado `webserver`. Para criar o perfil de instância, use o comando `New-IAMInstanceProfile`. Depois de criar o perfil da instância e associá-lo a uma função usando esse comando, você pode anexá-lo a uma EC2 instância. Para isso, use o cmdlet `New-EC2Instance` com o parâmetro `InstanceProfile_Arn` ou `InstanceProfile-Name` para executar a nova instância.**
```
Add-IAMRoleToInstanceProfile -RoleName "S3Access" -InstanceProfileName "webserver"
```
+ Para obter detalhes da API, consulte [AddRoleToInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-IAMUserTag`
O código de exemplo a seguir mostra como usar `Add-IAMUserTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo adiciona uma tag ao usuário no Identity Management Service**
```
Add-IAMUserTag -UserName joe -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ Para obter detalhes da API, consulte [TagUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Add-IAMUserToGroup`
O código de exemplo a seguir mostra como usar `Add-IAMUserToGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando adiciona o usuário chamado `Bob` ao grupo denominado `Admins`.**
```
Add-IAMUserToGroup -UserName "Bob" -GroupName "Admins"
```
+ Para obter detalhes da API, consulte [AddUserToGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Disable-IAMMFADevice`
O código de exemplo a seguir mostra como usar `Disable-IAMMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando desabilita o dispositivo de MFA de hardware associado ao usuário `Bob` que tem o número de série `123456789012`.**
```
Disable-IAMMFADevice -UserName "Bob" -SerialNumber "123456789012"
```
**Exemplo 2: este comando desativa o dispositivo de MFA virtual associado ao usuário `David` que tem o ARN `arn:aws:iam::210987654321:mfa/David`. Observe que o dispositivo de MFA virtual não é excluído da conta. O dispositivo virtual ainda está presente e aparece na saída do comando `Get-IAMVirtualMFADevice`. Antes de criar um dispositivo de MFA virtual para o mesmo usuário, você deve excluir o antigo usando o comando `Remove-IAMVirtualMFADevice`.**
```
Disable-IAMMFADevice -UserName "David" -SerialNumber "arn:aws:iam::210987654321:mfa/David"
```
+ Para obter detalhes da API, consulte [DeactivateMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-IAMPassword`
O código de exemplo a seguir mostra como usar `Edit-IAMPassword`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando altera a senha do usuário que está executando o comando. Esse comando pode ser chamado somente por usuários do IAM. Se esse comando for chamado quando você estiver conectado com as credenciais da AWS conta (raiz), o comando retornará um erro. `InvalidUserType`**
```
Edit-IAMPassword -OldPassword "MyOldP@ssw0rd" -NewPassword "MyNewP@ssw0rd"
```
+ Para obter detalhes da API, consulte [ChangePassword](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Enable-IAMMFADevice`
O código de exemplo a seguir mostra como usar `Enable-IAMMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando habilita o dispositivo de MFA de hardware com o número de série `987654321098` e associa o dispositivo ao usuário `Bob`. Ele inclui os dois primeiros códigos em sequência do dispositivo.**
```
Enable-IAMMFADevice -UserName "Bob" -SerialNumber "987654321098" -AuthenticationCode1 "12345678" -AuthenticationCode2 "87654321"
```
**Exemplo 2: este exemplo cria e habilita um dispositivo de MFA virtual. O primeiro comando cria o dispositivo virtual e retorna a representação de objeto do dispositivo na variável `$MFADevice`. Você pode usar as propriedades `.Base32StringSeed` ou `QRCodePng` para configurar a aplicação de software do usuário. O comando final atribui o dispositivo ao usuário `David`, identificando o dispositivo pelo número de série. O comando também sincroniza o dispositivo com AWS a inclusão dos dois primeiros códigos em sequência do dispositivo de 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 obter detalhes da API, consulte [EnableMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccessKey`
O código de exemplo a seguir mostra como usar `Get-IAMAccessKey`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando lista as chaves de acesso do usuário do IAM chamado `Bob`. Observe que não é possível listar as chaves de acesso secretas dos usuários do IAM. Se as chaves de acesso secretas forem perdidas, você deverá criar novas chaves de acesso com o cmdlet `New-IAMAccessKey`.**
```
Get-IAMAccessKey -UserName "Bob"
```
**Saída**:
```
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 obter detalhes da API, consulte [ListAccessKeys](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccessKeyLastUsed`
O código de exemplo a seguir mostra como usar `Get-IAMAccessKeyLastUsed`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o nome de usuário proprietário e as informações do último uso da chave de acesso fornecida.**
```
Get-IAMAccessKeyLastUsed -AccessKeyId ABCDEXAMPLE
```
+ Para obter detalhes da API, consulte [GetAccessKeyLastUsed](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccountAlias`
O código de exemplo a seguir mostra como usar `Get-IAMAccountAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna o alias da conta da Conta da AWS.**
```
Get-IAMAccountAlias
```
**Saída**:
```
ExampleCo
```
+ Para obter detalhes da API, consulte [ListAccountAliases](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccountAuthorizationDetail`
O código de exemplo a seguir mostra como usar `Get-IAMAccountAuthorizationDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo obtém detalhes de autorização sobre as identidades na AWS conta e exibe a lista de elementos do objeto retornado, incluindo usuários, grupos e funções. Por exemplo, a propriedade `UserDetailList` exibe detalhes sobre os usuários. Informações semelhantes estão disponíveis nas propriedades `RoleDetailList` e `GroupDetailList`.**
```
$Details=Get-IAMAccountAuthorizationDetail
$Details
```
**Saída**:
```
GroupDetailList : {Administrators, Developers, Testers, Backup}
IsTruncated : False
Marker :
RoleDetailList : {TestRole1, AdminRole, TesterRole, clirole...}
UserDetailList : {Administrator, Bob, BackupToS3, }
```
```
$Details.UserDetailList
```
**Saída**:
```
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 obter detalhes da API, consulte [GetAccountAuthorizationDetails](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccountPasswordPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMAccountPasswordPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre a política de senha da conta atual. Se nenhuma política de senha estiver definida na conta, o comando retorna um erro `NoSuchEntity`.**
```
Get-IAMAccountPasswordPolicy
```
**Saída**:
```
AllowUsersToChangePassword : True
ExpirePasswords : True
HardExpiry : False
MaxPasswordAge : 90
MinimumPasswordLength : 8
PasswordReusePrevention : 20
RequireLowercaseCharacters : True
RequireNumbers : True
RequireSymbols : False
RequireUppercaseCharacters : True
```
+ Para obter detalhes da API, consulte [GetAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAccountSummary`
O código de exemplo a seguir mostra como usar `Get-IAMAccountSummary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna informações sobre o uso atual da entidade do IAM e das cotas atuais da entidade do IAM na Conta da AWS.**
```
Get-IAMAccountSummary
```
**Saída**:
```
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 obter detalhes da API, consulte [GetAccountSummary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAttachedGroupPolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMAttachedGroupPolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna os nomes e ARNs as políticas gerenciadas que estão anexadas ao grupo do IAM nomeado `Admins` na AWS conta. Para ver a lista de políticas em linha incorporadas no grupo, use o comando `Get-IAMGroupPolicyList`.**
```
Get-IAMAttachedGroupPolicyList -GroupName "Admins"
```
**Saída**:
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
arn:aws:iam::aws:policy/AdministratorAccess AdministratorAccess
```
+ Para obter detalhes da API, consulte [ListAttachedGroupPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAttachedRolePolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMAttachedRolePolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna os nomes e ARNs as políticas gerenciadas anexadas à função do IAM nomeada `SecurityAuditRole` na AWS conta. Para ver a lista de políticas em linha incorporadas no perfil, use o comando `Get-IAMRolePolicyList`.**
```
Get-IAMAttachedRolePolicyList -RoleName "SecurityAuditRole"
```
**Saída**:
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
```
+ Para obter detalhes da API, consulte [ListAttachedRolePolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMAttachedUserPolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMAttachedUserPolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna os nomes e ARNs as políticas gerenciadas do usuário do IAM nomeado `Bob` na AWS conta. Para ver a lista de políticas em linha incorporadas no usuário do IAM, use o comando `Get-IAMUserPolicyList`.**
```
Get-IAMAttachedUserPolicyList -UserName "Bob"
```
**Saída**:
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/TesterPolicy TesterPolicy
```
+ Para obter detalhes da API, consulte [ListAttachedUserPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMContextKeysForCustomPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMContextKeysForCustomPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo busca todas as chaves de contexto presentes no JSON da política fornecida. A fim de produzir várias políticas, você pode fornecer uma lista de valores separados por vírgula.**
```
$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 obter detalhes da API, consulte [GetContextKeysForCustomPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMContextKeysForPrincipalPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMContextKeysForPrincipalPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo busca todas as chaves de contexto presentes no JSON da política fornecida e as políticas anexadas à entidade do IAM (usuário, perfil etc.). Para - PolicyInputList você pode fornecer uma lista de vários valores como valores separados por vírgula.**
```
$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 obter detalhes da API, consulte [GetContextKeysForPrincipalPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMCredentialReport`
O código de exemplo a seguir mostra como usar `Get-IAMCredentialReport`.
**Ferramentas para PowerShell V5**
**Exemplo1: este exemplo abre o relatório retornado e o envia ao pipeline como uma matriz de linhas de texto. A primeira linha é o cabeçalho com nomes de colunas separados por vírgula. Cada linha sucessiva é a linha de detalhes de um usuário, com cada campo separado por vírgulas. Antes de visualizar o relatório, você deve gerá-lo com o cmdlet `Request-IAMCredentialReport`. Para recuperar o relatório como uma única string, use `-Raw` em vez de `-AsTextArray`. O alias `-SplitLines` também é aceito no switch `-AsTextArray`. Para obter a lista completa de colunas na saída, consulte a referência de API do serviço. Observe que, se não usar `-AsTextArray` ou `-SplitLines`, você deve extrair o texto da propriedade `.Content` usando a classe `StreamReader` .NET.**
```
Request-IAMCredentialReport
```
**Saída**:
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
```
Get-IAMCredentialReport -AsTextArray
```
**Saída**:
```
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 obter detalhes da API, consulte [GetCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMEntitiesForPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMEntitiesForPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna uma lista de grupos, perfis e usuários do IAM que têm a política `arn:aws:iam::123456789012:policy/TestPolicy` anexada.**
```
Get-IAMEntitiesForPolicy -PolicyArn "arn:aws:iam::123456789012:policy/TestPolicy"
```
**Saída**:
```
IsTruncated : False
Marker :
PolicyGroups : {}
PolicyRoles : {testRole}
PolicyUsers : {Bob, Theresa}
```
+ Para obter detalhes da API, consulte [ListEntitiesForPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMGroup`
O código de exemplo a seguir mostra como usar `Get-IAMGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre o grupo do IAM `Testers`, incluindo uma compilação de todos os usuários do IAM que pertencem ao grupo.**
```
$results = Get-IAMGroup -GroupName "Testers"
$results
```
**Saída**:
```
Group IsTruncated Marker Users
----- ----------- ------ -----
Amazon.IdentityManagement.Model.Group False {Theresa, David}
```
```
$results.Group
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : 3RHNZZGQJ7QHMAEXAMPLE1
GroupName : Testers
Path : /
```
```
$results.Users
```
**Saída**:
```
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 obter detalhes da API, consulte [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMGroupForUser`
O código de exemplo a seguir mostra como usar `Get-IAMGroupForUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a lista de grupos do IAM aos quais o usuário do IAM `David` pertence.**
```
Get-IAMGroupForUser -UserName David
```
**Saída**:
```
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 obter detalhes da API, consulte [ListGroupsForUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMGroupList`
O código de exemplo a seguir mostra como usar `Get-IAMGroupList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo retorna uma coleção de todos os grupos do IAM definidos no atual Conta da AWS.**
```
Get-IAMGroupList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMGroupPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMGroupPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre a política em linha incorporada denominada `PowerUserAccess-Testers` do grupo `Testers`. A propriedade `PolicyDocument` é codificada em URL. Ela é decodificada neste exemplo com o método .NET `UrlDecode`.**
```
$results = Get-IAMGroupPolicy -GroupName Testers -PolicyName PowerUserAccess-Testers
$results
```
**Saída**:
```
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 obter detalhes da API, consulte [GetGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMGroupPolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMGroupPolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna uma lista das políticas em linha incorporadas no grupo `Testers`. Para obter as políticas gerenciadas anexadas ao grupo, use o comando `Get-IAMAttachedGroupPolicyList`.**
```
Get-IAMGroupPolicyList -GroupName Testers
```
**Saída**:
```
Deny-Assume-S3-Role-In-Production
PowerUserAccess-Testers
```
+ Para obter detalhes da API, consulte [ListGroupPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMInstanceProfile`
O código de exemplo a seguir mostra como usar `Get-IAMInstanceProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo retorna detalhes do nome `ec2instancerole` do perfil da instância definido na AWS conta atual.**
```
Get-IAMInstanceProfile -InstanceProfileName ec2instancerole
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obter detalhes da API, consulte [GetInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMInstanceProfileForRole`
O código de exemplo a seguir mostra como usar `Get-IAMInstanceProfileForRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes do perfil de instância associado ao perfil `ec2instancerole`.**
```
Get-IAMInstanceProfileForRole -RoleName ec2instancerole
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obter detalhes da API, consulte [ListInstanceProfilesForRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMInstanceProfileList`
O código de exemplo a seguir mostra como usar `Get-IAMInstanceProfileList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo retorna uma coleção dos perfis de instância definidos na versão atual Conta da AWS.**
```
Get-IAMInstanceProfileList
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ Para obter detalhes da API, consulte [ListInstanceProfiles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMLoginProfile`
O código de exemplo a seguir mostra como usar `Get-IAMLoginProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a data de criação da senha e se uma redefinição de senha é necessária para o usuário do IAM `David`.**
```
Get-IAMLoginProfile -UserName David
```
**Saída**:
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
12/10/2014 3:39:44 PM False David
```
+ Para obter detalhes da API, consulte [GetLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMMFADevice`
O código de exemplo a seguir mostra como usar `Get-IAMMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre o dispositivo de MFA atribuído ao usuário do IAM `David`. Neste exemplo, você percebe que é um dispositivo virtual porque o `SerialNumber` é um ARN em vez do número de série real de um dispositivo físico.**
```
Get-IAMMFADevice -UserName David
```
**Saída**:
```
EnableDate SerialNumber UserName
---------- ------------ --------
4/8/2015 9:41:10 AM arn:aws:iam::123456789012:mfa/David David
```
+ Para obter detalhes da API, consulte [ListMfaDevices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMOpenIDConnectProvider`
O código de exemplo a seguir mostra como usar `Get-IAMOpenIDConnectProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre o provedor OpenID Connect cujo ARN é `arn:aws:iam::123456789012:oidc-provider/accounts.google.com`. A `ClientIDList` propriedade é uma coleção que contém todo o Cliente IDs definido para esse provedor.**
```
Get-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/oidc.example.com
```
**Saída**:
```
ClientIDList CreateDate ThumbprintList Url
------------ ---------- -------------- ---
{MyOIDCApp} 2/3/2015 3:00:30 PM {12345abcdefghijk67890lmnopqrst98765uvwxy} oidc.example.com
```
+ Para obter detalhes da API, consulte [GetOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMOpenIDConnectProviderList`
O código de exemplo a seguir mostra como usar `Get-IAMOpenIDConnectProviderList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna uma lista de ARNS de todos os provedores OpenID Connect definidos na Conta da AWS atual.**
```
Get-IAMOpenIDConnectProviderList
```
**Saída**:
```
Arn
---
arn:aws:iam::123456789012:oidc-provider/server.example.com
arn:aws:iam::123456789012:oidc-provider/another.provider.com
```
+ Para obter detalhes da API, consulte [ListOpenIdConnectProviders](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna detalhes sobre a política gerenciada cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`.**
```
Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**Saída**:
```
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 obter detalhes da API, consulte [GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMPolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMPolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo retorna uma coleção das três primeiras políticas gerenciadas disponíveis na AWS conta atual. Como não `-scope` está especificado, ele usa como padrão `all` e inclui políticas AWS gerenciadas e gerenciadas pelo cliente.**
```
Get-IAMPolicyList -MaxItem 3
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo retorna uma coleção das duas primeiras políticas gerenciadas pelo cliente disponíveis na AWS conta corrente. Ele usa `-Scope local` para limitar a saída somente às políticas gerenciadas pelo cliente.**
```
Get-IAMPolicyList -Scope local -MaxItem 2
```
**Saída**:
```
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 obter detalhes da API, consulte [ListPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMPolicyVersion`
O código de exemplo a seguir mostra como usar `Get-IAMPolicyVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o documento da política na versão `v2` da política cujo ARN é `arn:aws:iam::123456789012:policy/MyManagedPolicy`. O documento da política na propriedade `Document` é codificado em URL, sendo decodificado neste exemplo com o método .NET `UrlDecode`.**
```
$results = Get-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy -VersionId v2
$results
```
**Saída**:
```
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 obter detalhes da API, consulte [GetPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMPolicyVersionList`
O código de exemplo a seguir mostra como usar `Get-IAMPolicyVersionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a lista de versões disponíveis da política cujo ARN é `arn:aws:iam::123456789012:policy/MyManagedPolicy`. Para obter o documento de política de uma versão específica, use o comando `Get-IAMPolicyVersion` e especifique o `VersionId` do que você deseja.**
```
Get-IAMPolicyVersionList -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy
```
**Saída**:
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
2/12/2015 9:39:53 AM True v2
2/12/2015 9:39:09 AM False v1
```
+ Para obter detalhes da API, consulte [ListPolicyVersions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMRole`
O código de exemplo a seguir mostra como usar `Get-IAMRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna os detalhes do `lamda_exec_role`. Ele inclui o documento da política de confiança que especifica quem pode assumir esse perfil. O documento da política é codificado em URL e pode ser decodificado usando o método .NET `UrlDecode`. Neste exemplo, todos os espaços em branco da política original foram removidos antes de ela ser carregada na política. Para ver os documentos da política de permissões que determinam o que alguém que assume o perfil pode fazer, use `Get-IAMRolePolicy` para políticas em linha e `Get-IAMPolicyVersion` para políticas gerenciadas anexadas.**
```
$results = Get-IamRole -RoleName lambda_exec_role
$results | Format-List
```
**Saída**:
```
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
```
**Saída**:
```
{"Version":"2012-10-17", "Statement":[{"Sid":"","Effect":"Allow","Principal":{"Service":"lambda.amazonaws.com"},"Action":"sts:AssumeRole"}]}
```
+ Para obter detalhes da API, consulte [GetRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMRoleList`
O código de exemplo a seguir mostra como usar `Get-IAMRoleList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera uma lista de todos os perfis do IAM na Conta da AWS.**
```
Get-IAMRoleList
```
+ Para obter detalhes da API, consulte [ListRoles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMRolePolicy`
O código de exemplo a seguir mostra como usar `Get-IAMRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna o documento da política de permissões da política denominada `oneClick_lambda_exec_role_policy` incorporada no perfil do IAM `lamda_exec_role`. O documento resultante da política é codificado em URL. Ela é decodificada neste exemplo com o método .NET `UrlDecode`.**
```
$results = Get-IAMRolePolicy -RoleName lambda_exec_role -PolicyName oneClick_lambda_exec_role_policy
$results
```
**Saída**:
```
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)
```
**Saída**:
```
{
"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 obter detalhes da API, consulte [GetRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMRolePolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMRolePolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a lista de nomes de políticas em linha incorporadas no perfil do IAM `lamda_exec_role`. Para ver os detalhes de uma política em linha, use o comando `Get-IAMRolePolicy`.**
```
Get-IAMRolePolicyList -RoleName lambda_exec_role
```
**Saída**:
```
oneClick_lambda_exec_role_policy
```
+ Para obter detalhes da API, consulte [ListRolePolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMRoleTagList`
O código de exemplo a seguir mostra como usar `Get-IAMRoleTagList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo busca a tag associada ao perfil.**
```
Get-IAMRoleTagList -RoleName MyRoleName
```
+ Para obter detalhes da API, consulte [ListRoleTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMSAMLProvider`
O código de exemplo a seguir mostra como usar `Get-IAMSAMLProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera os detalhes sobre o provedor SAML 2.0 cujo ARM é arn:aws:iam::123456789012:saml-provider/SAMLADFS. A resposta inclui o documento de metadados que você obteve do provedor de identidade para criar a entidade do provedor AWS SAML, bem como as datas de criação e expiração.**
```
Get-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS
```
**Saída**:
```
CreateDate SAMLMetadataDocument ValidUntil
---------- -------------------- ----------
12/23/2014 12:16:55 PM
O código de exemplo a seguir mostra como usar `Get-IAMSAMLProviderList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera a lista de provedores SAML 2.0 criados na Conta da AWS atual. Ele retorna o ARN, a data de criação e a data de expiração de cada provedor SAML.**
```
Get-IAMSAMLProviderList
```
**Saída**:
```
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 obter detalhes da API, consulte [Lista SAMLProviders](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMServerCertificate`
O código de exemplo a seguir mostra como usar `Get-IAMServerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera detalhes sobre o certificado do servidor denominado `MyServerCertificate`. Você pode encontrar os detalhes do certificado nas propriedades `CertificateBody` e `ServerCertificateMetadata`.**
```
$result = Get-IAMServerCertificate -ServerCertificateName MyServerCertificate
$result | format-list
```
**Saída**:
```
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
```
**Saída**:
```
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 obter detalhes da API, consulte [GetServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMServerCertificateList`
O código de exemplo a seguir mostra como usar `Get-IAMServerCertificateList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera a lista de certificados de servidor enviados à Conta da AWS atual.**
```
Get-IAMServerCertificateList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListServerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMServiceLastAccessedDetail`
O código de exemplo a seguir mostra como usar `Get-IAMServiceLastAccessedDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo fornece detalhes do último serviço acessado pela entidade do IAM (usuário, grupo, perfil ou política) associada na chamada de solicitação.**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
**Saída**:
```
f0b7a819-eab0-929b-dc26-ca598911cb9f
```
```
Get-IAMServiceLastAccessedDetail -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f
```
+ Para obter detalhes da API, consulte [GetServiceLastAccessedDetails](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMServiceLastAccessedDetailWithEntity`
O código de exemplo a seguir mostra como usar `Get-IAMServiceLastAccessedDetailWithEntity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo fornece o carimbo de data e hora do último acesso do serviço na solicitação pela respectiva entidade do IAM.**
```
$results = Get-IAMServiceLastAccessedDetailWithEntity -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f -ServiceNamespace ec2
$results
```
**Saída**:
```
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
```
**Saída**:
```
EntityInfo LastAuthenticated
---------- -----------------
Amazon.IdentityManagement.Model.EntityInfo 11/16/19 3:47:00 PM
```
```
$results.EntityInfo
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:user/TestUser
Id : AIDA4NBK5CXF5TZHU1234
Name : TestUser
Path : /
Type : USER
```
+ Para obter detalhes da API, consulte [GetServiceLastAccessedDetailsWithEntities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMSigningCertificate`
O código de exemplo a seguir mostra como usar `Get-IAMSigningCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera detalhes sobre o certificado de assinatura associado ao usuário chamado `Bob`.**
```
Get-IAMSigningCertificate -UserName Bob
```
**Saída**:
```
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 obter detalhes da API, consulte [ListSigningCertificates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMUser`
O código de exemplo a seguir mostra como usar `Get-IAMUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera detalhes sobre o usuário chamado `David`.**
```
Get-IAMUser -UserName David
```
**Saída**:
```
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
```
**Exemplo 2: este exemplo recupera detalhes sobre o usuário do IAM atualmente conectado.**
```
Get-IAMUser
```
**Saída**:
```
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 obter detalhes da API, consulte [GetUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMUserList`
O código de exemplo a seguir mostra como usar `Get-IAMUserList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo recupera uma coleção de usuários no atual Conta da AWS.**
```
Get-IAMUserList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListUsers](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMUserPolicy`
O código de exemplo a seguir mostra como usar `Get-IAMUserPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera os detalhes da política em linha denominada `Davids_IAM_Admin_Policy` incorporada no usuário do IAM chamado `David`. O documento de política é codificado em URL.**
```
$results = Get-IAMUserPolicy -PolicyName Davids_IAM_Admin_Policy -UserName David
$results
```
**Saída**:
```
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 obter detalhes da API, consulte [GetUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMUserPolicyList`
O código de exemplo a seguir mostra como usar `Get-IAMUserPolicyList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera a lista de nomes das políticas em linha incorporadas no usuário do IAM chamado `David`.**
```
Get-IAMUserPolicyList -UserName David
```
**Saída**:
```
Davids_IAM_Admin_Policy
```
+ Para obter detalhes da API, consulte [ListUserPolicies](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMUserTagList`
O código de exemplo a seguir mostra como usar `Get-IAMUserTagList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo busca a tag associada ao usuário.**
```
Get-IAMUserTagList -UserName joe
```
+ Para obter detalhes da API, consulte [ListUserTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-IAMVirtualMFADevice`
O código de exemplo a seguir mostra como usar `Get-IAMVirtualMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo recupera uma coleção dos dispositivos virtuais de MFA atribuídos aos usuários na AWS conta. A propriedade do `User` de cada um é um objeto com detalhes do usuário do IAM ao qual o dispositivo está atribuído.**
```
Get-IAMVirtualMFADevice -AssignmentStatus Assigned
```
**Saída**:
```
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 obter detalhes da API, consulte [ListVirtualMfaDevices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMAccessKey`
O código de exemplo a seguir mostra como usar `New-IAMAccessKey`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma chave de acesso e um par de chaves de acesso secreto e os atribui ao usuário `David`. Certifique-se de salvar os valores `AccessKeyId` e `SecretAccessKey` em um arquivo, pois este é o único momento em que você pode obter a `SecretAccessKey`. Não será possível recuperá-la depois. Caso perca a chave secreta, você deve criar um par de chaves de acesso.**
```
New-IAMAccessKey -UserName David
```
**Saída**:
```
AccessKeyId : AKIAIOSFODNN7EXAMPLE
CreateDate : 4/13/2015 1:00:42 PM
SecretAccessKey : wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Status : Active
UserName : David
```
+ Para obter detalhes da API, consulte [CreateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMAccountAlias`
O código de exemplo a seguir mostra como usar `New-IAMAccountAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo altera o alias da AWS conta para`mycompanyaws`. O endereço da página de login do usuário muda para panyaws.signin.aws.amazon.com/console https://mycom. O URL original usando o número de ID da conta em vez do alias (https://.signin.aws.amazon.com/console) continua funcionando. No entanto, qualquer alias previamente definido deixa de URLs funcionar.**
```
New-IAMAccountAlias -AccountAlias mycompanyaws
```
+ Para obter detalhes da API, consulte [CreateAccountAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMGroup`
O código de exemplo a seguir mostra como usar `New-IAMGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um grupo do IAM denominado `Developers`.**
```
New-IAMGroup -GroupName Developers
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 4/14/2015 11:21:31 AM
GroupId : QNEJ5PM4NFSQCEXAMPLE1
GroupName : Developers
Path : /
```
+ Para obter detalhes da API, consulte [CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMInstanceProfile`
O código de exemplo a seguir mostra como usar `New-IAMInstanceProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um perfil de instância do IAM denominado `ProfileForDevEC2Instance`. Você deve executar o comando `Add-IAMRoleToInstanceProfile` separadamente para associar o perfil de instância a um perfil do IAM existente que fornece permissões à instância. Por fim, anexe o perfil da EC2 instância a uma instância ao executá-la. Para isso, use o cmdlet `New-EC2Instance` com o parâmetro `InstanceProfile_Arn` ou `InstanceProfile_Name`.**
```
New-IAMInstanceProfile -InstanceProfileName ProfileForDevEC2Instance
```
**Saída**:
```
Arn : arn:aws:iam::123456789012:instance-profile/ProfileForDevEC2Instance
CreateDate : 4/14/2015 11:31:39 AM
InstanceProfileId : DYMFXL556EY46EXAMPLE1
InstanceProfileName : ProfileForDevEC2Instance
Path : /
Roles : {}
```
+ Para obter detalhes da API, consulte [CreateInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMLoginProfile`
O código de exemplo a seguir mostra como usar `New-IAMLoginProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma senha (temporária) para o usuário do IAM chamado Bob e define a sinalização que exige que o usuário altere a senha na próxima vez que `Bob` fizer login.**
```
New-IAMLoginProfile -UserName Bob -Password P@ssw0rd -PasswordResetRequired $true
```
**Saída**:
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
4/14/2015 12:26:30 PM True Bob
```
+ Para obter detalhes da API, consulte [CreateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMOpenIDConnectProvider`
O código de exemplo a seguir mostra como usar `New-IAMOpenIDConnectProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um provedor OIDC do IAM associado ao serviço do provedor compatível com OIDC encontrado no URL `https://example.oidcprovider.com` e no ID do cliente `my-testapp-1`. O provedor OIDC fornece a impressão digital. Para autenticar a impressão digital, siga as etapas em 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
```
**Saída**:
```
arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ Para obter detalhes da API, consulte [CreateOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMPolicy`
O código de exemplo a seguir mostra como usar `New-IAMPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova política do IAM na AWS conta atual chamada `MySamplePolicy` O arquivo `MySamplePolicy.json` fornece o conteúdo da política. Observe que você deve usar o parâmetro switch `-Raw` para processar com êxito o arquivo de política JSON.**
```
New-IAMPolicy -PolicyName MySamplePolicy -PolicyDocument (Get-Content -Raw MySamplePolicy.json)
```
**Saída**:
```
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 obter detalhes da API, consulte [CreatePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMPolicyVersion`
O código de exemplo a seguir mostra como usar `New-IAMPolicyVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma versão "v2" da política do IAM cujo ARN é `arn:aws:iam::123456789012:policy/MyPolicy` e a torna a versão padrão. O arquivo `NewPolicyVersion.json` fornece o conteúdo da política. Observe que você deve usar o parâmetro switch `-Raw` para processar com êxito o arquivo de política JSON.**
```
New-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -PolicyDocument (Get-content -Raw NewPolicyVersion.json) -SetAsDefault $true
```
**Saída**:
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
4/15/2015 10:54:54 AM True v2
```
+ Para obter detalhes da API, consulte [CreatePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMRole`
O código de exemplo a seguir mostra como usar `New-IAMRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um perfil denominado `MyNewRole` e anexa a ele a política encontrada no arquivo `NewRoleTrustPolicy.json`. Observe que você deve usar o parâmetro switch `-Raw` para processar com êxito o arquivo de política JSON. O documento de política exibido na saída é codificado em URL. Ele é decodificado nesse exemplo com o método .NET `UrlDecode`.**
```
$results = New-IAMRole -AssumeRolePolicyDocument (Get-Content -raw NewRoleTrustPolicy.json) -RoleName MyNewRole
$results
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMSAMLProvider`
O código de exemplo a seguir mostra como usar `New-IAMSAMLProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma entidade provedora SAML no IAM. Ele é denominado `MySAMLProvider` e descrito pelo documento de metadados SAML encontrado no arquivo `SAMLMetaData.xml`, que foi baixado separadamente do site do provedor de serviços SAML.**
```
New-IAMSAMLProvider -Name MySAMLProvider -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
**Saída**:
```
arn:aws:iam::123456789012:saml-provider/MySAMLProvider
```
+ Para obter detalhes da API, consulte [Criar SAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMServiceLinkedRole`
O código de exemplo a seguir mostra como usar `New-IAMServiceLinkedRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um perfil vinculado ao serviço para o serviço de ajuste de escala automático.**
```
New-IAMServiceLinkedRole -AWSServiceName autoscaling.amazonaws.com -CustomSuffix RoleNameEndsWithThis -Description "My service-linked role to support autoscaling"
```
+ Para obter detalhes da API, consulte [CreateServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMUser`
O código de exemplo a seguir mostra como usar `New-IAMUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um usuário do IAM chamado `Bob`. Se Bob precisar entrar no AWS console, você deverá executar o comando separadamente `New-IAMLoginProfile` para criar um perfil de login com uma senha. Se Bob precisar executar AWS PowerShell comandos CLI multiplataforma ou AWS fazer chamadas de API, você deverá executar `New-IAMAccessKey` o comando separadamente para criar chaves de acesso.**
```
New-IAMUser -UserName Bob
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-IAMVirtualMFADevice`
O código de exemplo a seguir mostra como usar `New-IAMVirtualMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um dispositivo de MFA virtual. As linhas 2 e 3 extraem o valor de `Base32StringSeed` de que o programa de software de MFA virtual precisa para criar uma conta (como alternativa ao código QR). Depois de configurar o programa com o valor, obtenha dois códigos de autenticação sequencial do programa. Por fim, use o último comando para vincular o dispositivo de MFA virtual ao usuário do IAM `Bob` e sincronizar a conta com os dois códigos de autenticação.**
```
$Device = New-IAMVirtualMFADevice -VirtualMFADeviceName BobsMFADevice
$SR = New-Object System.IO.StreamReader($Device.Base32StringSeed)
$base32stringseed = $SR.ReadToEnd()
$base32stringseed
CZWZMCQNW4DEXAMPLE3VOUGXJFZYSUW7EXAMPLECR4NJFD65GX2SLUDW2EXAMPLE
```
**Saída**:
```
-- 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
```
**Exemplo 2: este exemplo cria um dispositivo de MFA virtual. As linhas 2 e 3 extraem o valor de `QRCodePNG` e o gravam em um arquivo. Essa imagem pode ser digitalizada pelo programa de software de MFA virtual para criar uma conta (como alternativa à inserção manual do valor StringSeed Base32). Depois de criar a conta no programa de MFA virtual, obtenha dois códigos de autenticação sequencial e insira-os nos últimos comandos para vincular o dispositivo MFA virtual ao usuário do IAM `Bob` e sincronizar a conta.**
```
$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
```
**Saída**:
```
-- Pause here to scan PNG with virtual MFA program to register account. --
Enable-IAMMFADevice -SerialNumber $Device.SerialNumber -UserName Bob -AuthenticationCode1 123456 -AuthenticationCode2 789012
```
+ Para obter detalhes da API, consulte [CreateVirtualMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Publish-IAMServerCertificate`
O código de exemplo a seguir mostra como usar `Publish-IAMServerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo faz upload de um novo certificado de servidor na conta do IAM. Os arquivos contendo o corpo do certificado, a chave privada e (opcionalmente) a cadeia de certificação devem ser codificados em PEM. Observe que os parâmetros exigem o conteúdo real dos arquivos em vez dos nomes deles. Você deve usar o parâmetro switch `-Raw` para processar com êxito o conteúdo do arquivo.**
```
Publish-IAMServerCertificate -ServerCertificateName MyTestCert -CertificateBody (Get-Content -Raw server.crt) -PrivateKey (Get-Content -Raw server.key)
```
**Saída**:
```
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 obter detalhes da API, consulte [UploadServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Publish-IAMSigningCertificate`
O código de exemplo a seguir mostra como usar `Publish-IAMSigningCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo faz upload de um novo certificado de assinatura X.509 e o associa ao usuário do IAM chamado `Bob`. O arquivo que contém o corpo do certificado é codificado em PEM. O parâmetro `CertificateBody` exige o conteúdo real do arquivo de certificado em vez do nome do arquivo. Você deve usar o parâmetro switch `-Raw` para processar o arquivo com êxito.**
```
Publish-IAMSigningCertificate -UserName Bob -CertificateBody (Get-Content -Raw SampleSigningCert.pem)
```
**Saída**:
```
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 obter detalhes da API, consulte [UploadSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-IAMGroupPolicy`
O código de exemplo a seguir mostra como usar `Register-IAMGroupPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo anexa a política gerenciada pelo cliente denominada `TesterPolicy` ao grupo do IAM `Testers`. Os usuários desse grupo são imediatamente afetados pelas permissões definidas na versão padrão dessa política.**
```
Register-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**Exemplo 2: Este exemplo anexa a política AWS gerenciada nomeada `AdministratorAccess` ao grupo `Admins` do IAM. Os usuários desse grupo são imediatamente afetados pelas permissões definidas na versão mais recente dessa política.**
```
Register-IAMGroupPolicy -GroupName Admins -PolicyArn arn:aws:iam::aws:policy/AdministratorAccess
```
+ Para obter detalhes da API, consulte [AttachGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-IAMRolePolicy`
O código de exemplo a seguir mostra como usar `Register-IAMRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo anexa a política AWS gerenciada nomeada `SecurityAudit` à função `CoSecurityAuditors` do IAM. Os usuários que assumem esse perfil são imediatamente afetados pelas permissões definidas na versão mais recente dessa política.**
```
Register-IAMRolePolicy -RoleName CoSecurityAuditors -PolicyArn arn:aws:iam::aws:policy/SecurityAudit
```
+ Para obter detalhes da API, consulte [AttachRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-IAMUserPolicy`
O código de exemplo a seguir mostra como usar `Register-IAMUserPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo anexa a política AWS gerenciada nomeada `AmazonCognitoPowerUser` ao usuário `Bob` do IAM. O usuário é imediatamente afetado pelas permissões definidas na versão mais recente dessa política.**
```
Register-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::aws:policy/AmazonCognitoPowerUser
```
+ Para obter detalhes da API, consulte [AttachUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMAccessKey`
O código de exemplo a seguir mostra como usar `Remove-IAMAccessKey`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui o par de chaves de AWS acesso com o ID `AKIAIOSFODNN7EXAMPLE` da chave do usuário chamado`Bob`.**
```
Remove-IAMAccessKey -AccessKeyId AKIAIOSFODNN7EXAMPLE -UserName Bob -Force
```
+ Para obter detalhes da API, consulte [DeleteAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMAccountAlias`
O código de exemplo a seguir mostra como usar `Remove-IAMAccountAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove o alias da conta do seu Conta da AWS. A página de login do usuário com o alias em https://mycom panyaws.signin.aws.amazon.com/console não funciona mais. Em vez disso, você deve usar o URL original com seu número de Conta da AWS identificação em https://.signin.aws.amazon.com/console.**
```
Remove-IAMAccountAlias -AccountAlias mycompanyaws
```
+ Para obter detalhes da API, consulte [DeleteAccountAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMAccountPasswordPolicy`
O código de exemplo a seguir mostra como usar `Remove-IAMAccountPasswordPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo exclui a política de senha do Conta da AWS e redefine todos os valores para seus padrões originais. Se uma política de senha não existir no momento, a seguinte mensagem de erro será exibida: A política de conta com nome PasswordPolicy não pode ser encontrada.**
```
Remove-IAMAccountPasswordPolicy
```
+ Para obter detalhes da API, consulte [DeleteAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMClientIDFromOpenIDConnectProvider`
O código de exemplo a seguir mostra como usar `Remove-IAMClientIDFromOpenIDConnectProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove o ID `My-TestApp-3` do cliente da lista de clientes IDs associados ao provedor IAM OIDC cujo ARN é. `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 obter detalhes da API, consulte [RemoveClientIdFromOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMGroup`
O código de exemplo a seguir mostra como usar `Remove-IAMGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o grupo do IAM denominado `MyTestGroup`. O primeiro comando remove todos os usuários do IAM que são membros do grupo, e o segundo exclui o grupo do IAM. Ambos os comandos funcionam sem nenhuma solicitação de confirmação.**
```
(Get-IAMGroup -GroupName MyTestGroup).Users | Remove-IAMUserFromGroup -GroupName MyTestGroup -Force
Remove-IAMGroup -GroupName MyTestGroup -Force
```
+ Para obter detalhes da API, consulte [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMGroupPolicy`
O código de exemplo a seguir mostra como usar `Remove-IAMGroupPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove a política em linha denominada `TesterPolicy` do grupo do IAM `Testers`. Os usuários desse grupo perdem imediatamente as permissões definidas nessa política.**
```
Remove-IAMGroupPolicy -GroupName Testers -PolicyName TestPolicy
```
+ Para obter detalhes da API, consulte [DeleteGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMInstanceProfile`
O código de exemplo a seguir mostra como usar `Remove-IAMInstanceProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo exclui o perfil da EC2 instância chamado`MyAppInstanceProfile`. O primeiro comando desassocia todos os perfis do perfil de instância e, em seguida, o segundo comando exclui o perfil de instância.**
```
(Get-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile).Roles | Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyAppInstanceProfile
Remove-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile
```
+ Para obter detalhes da API, consulte [DeleteInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMLoginProfile`
O código de exemplo a seguir mostra como usar `Remove-IAMLoginProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o perfil de login do usuário do IAM denominado `Bob`. Isso impede que o usuário faça login no AWS console. Isso não impede que o usuário execute nenhuma AWS chamada de CLI ou API usando chaves de AWS acesso que ainda possam estar anexadas à conta do usuário. PowerShell**
```
Remove-IAMLoginProfile -UserName Bob
```
+ Para obter detalhes da API, consulte [DeleteLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMOpenIDConnectProvider`
O código de exemplo a seguir mostra como usar `Remove-IAMOpenIDConnectProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o provedor OIDC do IAM que se conecta ao provedor `example.oidcprovider.com`. Certifique-se de atualizar ou excluir quaisquer perfis que façam referência a esse provedor no elemento `Principal` da política de confiança do perfil.**
```
Remove-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ Para obter detalhes da API, consulte [DeleteOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMPolicy`
O código de exemplo a seguir mostra como usar `Remove-IAMPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui a política cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`. Antes de excluir a política, exclua primeiro todas as versões, exceto a padrão, executando `Remove-IAMPolicyVersion`. Você também deve desassociar a política de qualquer usuário, grupo ou perfil do IAM.**
```
Remove-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**Exemplo 2: este exemplo exclui uma política excluindo primeiro todas as versões não padrão da política, desassociando-a de todas as entidades do IAM anexadas e, por fim, excluindo a própria política. A primeira linha recupera o objeto da política. A segunda linha recupera todas as versões da política que não estão marcadas como a versão padrão em uma compilação e depois exclui cada política na compilação. A terceira linha recupera todos os usuários, grupos e perfis do IAM aos quais a política está anexada. As linhas de quatro a seis desassociam a política de cada entidade anexada. A última linha usa esse comando para remover a política gerenciada e a versão padrão restante. O exemplo inclui o parâmetro switch `-Force` em qualquer linha que precise dele para suprimir solicitações de confirmação.**
```
$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 obter detalhes da API, consulte [DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMPolicyVersion`
O código de exemplo a seguir mostra como usar `Remove-IAMPolicyVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui a versão identificada como `v2` da política cujo ARN é `arn:aws:iam::123456789012:policy/MySamplePolicy`.**
```
Remove-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy -VersionID v2
```
**Exemplo 2: este exemplo exclui uma política excluindo primeiro todas as versões não padrão da política e depois excluindo a própria política. A primeira linha recupera o objeto da política. A segunda linha recupera todas as versões da política que não estão marcadas como padrão em uma compilação e, em seguida, usa esse comando para excluir cada política na compilação. A última linha remove a política em si, bem como a versão padrão restante. Observe que, para excluir com êxito uma política gerenciada, você também deve desassociar a política de qualquer usuário, grupo ou perfis usando os comandos `Unregister-IAMUserPolicy`, `Unregister-IAMGroupPolicy` e `Unregister-IAMRolePolicy`. Veja o exemplo do 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 obter detalhes da API, consulte [DeletePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMRole`
O código de exemplo a seguir mostra como usar `Remove-IAMRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o perfil denominado `MyNewRole` da conta atual do IAM. Antes de excluir o perfil, use primeiro o comando `Unregister-IAMRolePolicy` para desassociar todas as políticas gerenciadas. As políticas em linha são excluídas com o perfil.**
```
Remove-IAMRole -RoleName MyNewRole
```
**Exemplo 2: este exemplo desassocia todas as políticas gerenciadas do perfil denominado `MyNewRole` e depois o exclui. A primeira linha recupera todas as políticas gerenciadas anexadas ao perfil como uma compilação e, em seguida, desassocia cada política da compilação do perfil. A segunda linha exclui o perfil em si. As políticas em linha são excluídas com o perfil.**
```
Get-IAMAttachedRolePolicyList -RoleName MyNewRole | Unregister-IAMRolePolicy -RoleName MyNewRole
Remove-IAMRole -RoleName MyNewRole
```
+ Para obter detalhes da API, consulte [DeleteRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMRoleFromInstanceProfile`
O código de exemplo a seguir mostra como usar `Remove-IAMRoleFromInstanceProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo exclui a função nomeada `MyNewRole` do perfil da EC2 instância nomeado`MyNewRole`. Um perfil de instância criado no console do IAM sempre tem o mesmo nome do perfil, como neste exemplo. Se você os criar na API ou na CLI, eles poderão ter nomes diferentes.**
```
Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyNewRole -RoleName MyNewRole -Force
```
+ Para obter detalhes da API, consulte [RemoveRoleFromInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMRolePermissionsBoundary`
O código de exemplo a seguir mostra como usar `Remove-IAMRolePermissionsBoundary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra como remover o limite de permissões anexado a um perfil do IAM.**
```
Remove-IAMRolePermissionsBoundary -RoleName MyRoleName
```
+ Para obter detalhes da API, consulte [DeleteRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMRolePolicy`
O código de exemplo a seguir mostra como usar `Remove-IAMRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui a política em linha `S3AccessPolicy` incorporada no perfil do IAM `S3BackupRole`.**
```
Remove-IAMRolePolicy -PolicyName S3AccessPolicy -RoleName S3BackupRole
```
+ Para obter detalhes da API, consulte [DeleteRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMRoleTag`
O código de exemplo a seguir mostra como usar `Remove-IAMRoleTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove a tag da função chamada "MyRoleName" com a chave de tag como “abac”. Para remover várias tags, forneça uma lista de chaves de tag separadas por vírgulas.**
```
Remove-IAMRoleTag -RoleName MyRoleName -TagKey "abac","xyzw"
```
+ Para obter detalhes da API, consulte [UntagRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMSAMLProvider`
O código de exemplo a seguir mostra como usar `Remove-IAMSAMLProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o provedor SAML 2.0 do IAM cujo ARN é `arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider`.**
```
Remove-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider
```
+ Para obter detalhes da API, consulte [Excluir SAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMServerCertificate`
O código de exemplo a seguir mostra como usar `Remove-IAMServerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o certificado do servidor denominado `MyServerCert`.**
```
Remove-IAMServerCertificate -ServerCertificateName MyServerCert
```
+ Para obter detalhes da API, consulte [DeleteServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMServiceLinkedRole`
O código de exemplo a seguir mostra como usar `Remove-IAMServiceLinkedRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo excluiu o perfil vinculado ao serviço. Observe que, se o serviço ainda estiver usando esse perfil, esse comando resultará em uma falha.**
```
Remove-IAMServiceLinkedRole -RoleName AWSServiceRoleForAutoScaling_RoleNameEndsWithThis
```
+ Para obter detalhes da API, consulte [DeleteServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMSigningCertificate`
O código de exemplo a seguir mostra como usar `Remove-IAMSigningCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o certificado de assinatura com o ID `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` do usuário do IAM chamado `Bob`.**
```
Remove-IAMSigningCertificate -UserName Bob -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU
```
+ Para obter detalhes da API, consulte [DeleteSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMUser`
O código de exemplo a seguir mostra como usar `Remove-IAMUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o usuário do IAM chamado `Bob`.**
```
Remove-IAMUser -UserName Bob
```
**Exemplo 2: este exemplo exclui a usuária do IAM chamada `Theresa` com todos os elementos que devem ser excluídos primeiro.**
```
$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 obter detalhes da API, consulte [DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMUserFromGroup`
O código de exemplo a seguir mostra como usar `Remove-IAMUserFromGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove o usuário do IAM `Bob` do grupo `Testers`.**
```
Remove-IAMUserFromGroup -GroupName Testers -UserName Bob
```
**Exemplo 2: este exemplo encontra todos os grupos dos quais a usuária do IAM `Theresa` é membro e, em seguida, remove a `Theresa` desses grupos.**
```
$groups = Get-IAMGroupForUser -UserName Theresa
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName Theresa -Force }
```
**Exemplo 3: este exemplo mostra uma forma alternativa de remover o usuário do IAM `Bob` do grupo `Testers`.**
```
Get-IAMGroupForUser -UserName Bob | Remove-IAMUserFromGroup -UserName Bob -GroupName Testers -Force
```
+ Para obter detalhes da API, consulte [RemoveUserFromGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMUserPermissionsBoundary`
O código de exemplo a seguir mostra como usar `Remove-IAMUserPermissionsBoundary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra como remover o limite de permissões anexado a um usuário do IAM.**
```
Remove-IAMUserPermissionsBoundary -UserName joe
```
+ Para obter detalhes da API, consulte [DeleteUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMUserPolicy`
O código de exemplo a seguir mostra como usar `Remove-IAMUserPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui a política em linha denominada `AccessToEC2Policy` incorporada no usuário do IAM chamado `Bob`.**
```
Remove-IAMUserPolicy -PolicyName AccessToEC2Policy -UserName Bob
```
**Exemplo 2: este exemplo encontra todas as políticas em linha incorporadas na usuária do IAM chamada `Theresa` e depois as exclui.**
```
$inlinepols = Get-IAMUserPolicies -UserName Theresa
foreach ($pol in $inlinepols) { Remove-IAMUserPolicy -PolicyName $pol -UserName Theresa -Force}
```
+ Para obter detalhes da API, consulte [DeleteUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMUserTag`
O código de exemplo a seguir mostra como usar `Remove-IAMUserTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove a tag do usuário denominado “joe” com a chave de tag como “abac” e “xyzw”. Para remover várias tags, forneça uma lista de chaves de tag separadas por vírgulas.**
```
Remove-IAMUserTag -UserName joe -TagKey "abac","xyzw"
```
+ Para obter detalhes da API, consulte [UntagUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-IAMVirtualMFADevice`
O código de exemplo a seguir mostra como usar `Remove-IAMVirtualMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o dispositivo de MFA virtual do IAM cujo ARN é `arn:aws:iam::123456789012:mfa/bob`.**
```
Remove-IAMVirtualMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/bob
```
**Exemplo 2: este exemplo verifica se a usuária do IAM Theresa tem um dispositivo de MFA atribuído. Se for encontrado, o dispositivo é desabilitado para a usuária do IAM. Se o dispositivo for virtual, ele também é excluído.**
```
$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 obter detalhes da API, consulte [DeleteVirtualMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Request-IAMCredentialReport`
O código de exemplo a seguir mostra como usar `Request-IAMCredentialReport`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo solicita a geração de um novo relatório, que pode ser feito a cada quatro horas. Se o último relatório ainda for recente, o campo Estado será `COMPLETE`. Use `Get-IAMCredentialReport` para visualizar o relatório completo.**
```
Request-IAMCredentialReport
```
**Saída**:
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
+ Para obter detalhes da API, consulte [GenerateCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Request-IAMServiceLastAccessedDetail`
O código de exemplo a seguir mostra como usar `Request-IAMServiceLastAccessedDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo é um cmdlet equivalente da GenerateServiceLastAccessedDetails API. Isso fornece um ID de trabalho que pode ser usado em Get-IAMServiceLastAccessedDetail e Get- IAMService LastAccessedDetailWithEntity**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
+ Para obter detalhes da API, consulte [GenerateServiceLastAccessedDetails](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-IAMDefaultPolicyVersion`
O código de exemplo a seguir mostra como usar `Set-IAMDefaultPolicyVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo define a versão `v2` da política cujo ARN é `arn:aws:iam::123456789012:policy/MyPolicy` como versão ativa padrão.**
```
Set-IAMDefaultPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -VersionId v2
```
+ Para obter detalhes da API, consulte [SetDefaultPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-IAMRolePermissionsBoundary`
O código de exemplo a seguir mostra como usar `Set-IAMRolePermissionsBoundary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra como definir o limite de permissões de um perfil do IAM. Você pode definir políticas AWS gerenciadas ou políticas personalizadas como limite de permissão.**
```
Set-IAMRolePermissionsBoundary -RoleName MyRoleName -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ Para obter detalhes da API, consulte [PutRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-IAMUserPermissionsBoundary`
O código de exemplo a seguir mostra como usar `Set-IAMUserPermissionsBoundary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra como definir o limite de permissões do usuário. Você pode definir políticas AWS gerenciadas ou políticas personalizadas como limite de permissão.**
```
Set-IAMUserPermissionsBoundary -UserName joe -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ Para obter detalhes da API, consulte [PutUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Sync-IAMMFADevice`
O código de exemplo a seguir mostra como usar `Sync-IAMMFADevice`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo sincroniza o dispositivo de MFA associado ao usuário do IAM `Bob` e cujo ARN é `arn:aws:iam::123456789012:mfa/bob` com um programa autenticador que forneceu os dois códigos de autenticação.**
```
Sync-IAMMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/theresa -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Bob
```
**Exemplo 2: este exemplo sincroniza o dispositivo de MFA do IAM associado à usuária do IAM `Theresa` com um dispositivo físico que tem o número de série `ABCD12345678` e que forneceu os dois códigos de autenticação.**
```
Sync-IAMMFADevice -SerialNumber ABCD12345678 -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Theresa
```
+ Para obter detalhes da API, consulte [ResyncMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-IAMGroupPolicy`
O código de exemplo a seguir mostra como usar `Unregister-IAMGroupPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo desassocia a política de grupo gerenciado cujo ARN é `arn:aws:iam::123456789012:policy/TesterAccessPolicy` do grupo denominado `Testers`.**
```
Unregister-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterAccessPolicy
```
**Exemplo 2: este exemplo encontra todas as políticas gerenciadas que estão anexadas ao grupo denominado `Testers` e as desassocia do grupo.**
```
Get-IAMAttachedGroupPolicies -GroupName Testers | Unregister-IAMGroupPolicy -Groupname Testers
```
+ Para obter detalhes da API, consulte [DetachGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-IAMRolePolicy`
O código de exemplo a seguir mostra como usar `Unregister-IAMRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo desassocia a política de grupo gerenciado cujo ARN é `arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy` do perfil denominado `FedTesterRole`.**
```
Unregister-IAMRolePolicy -RoleName FedTesterRole -PolicyArn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy
```
**Exemplo 2: este exemplo encontra todas as políticas gerenciadas que estão anexadas ao perfil denominado `FedTesterRole` e as desassocia dele.**
```
Get-IAMAttachedRolePolicyList -RoleName FedTesterRole | Unregister-IAMRolePolicy -Rolename FedTesterRole
```
+ Para obter detalhes da API, consulte [DetachRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-IAMUserPolicy`
O código de exemplo a seguir mostra como usar `Unregister-IAMUserPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo desassocia a política gerenciada cujo ARN é `arn:aws:iam::123456789012:policy/TesterPolicy` do usuário do IAM chamado `Bob`.**
```
Unregister-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**Exemplo 2: este exemplo encontra todas as políticas gerenciadas que estão anexadas ao usuário do IAM chamado `Theresa` e as desassocia dele.**
```
Get-IAMAttachedUserPolicyList -UserName Theresa | Unregister-IAMUserPolicy -Username Theresa
```
+ Para obter detalhes da API, consulte [DetachUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMAccessKey`
O código de exemplo a seguir mostra como usar `Update-IAMAccessKey`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo altera para `Inactive` o status da chave de acesso `AKIAIOSFODNN7EXAMPLE` do usuário do IAM denominado `Bob`.**
```
Update-IAMAccessKey -UserName Bob -AccessKeyId AKIAIOSFODNN7EXAMPLE -Status Inactive
```
+ Para obter detalhes da API, consulte [UpdateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMAccountPasswordPolicy`
O código de exemplo a seguir mostra como usar `Update-IAMAccountPasswordPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a política de senha da conta com as configurações especificadas. Observe que quaisquer parâmetros que não estejam incluídos no comando não são modificados. Em vez disso, eles são redefinidos para os valores padrão.**
```
Update-IAMAccountPasswordPolicy -AllowUsersToChangePasswords $true -HardExpiry $false -MaxPasswordAge 90 -MinimumPasswordLength 8 -PasswordReusePrevention 20 -RequireLowercaseCharacters $true -RequireNumbers $true -RequireSymbols $true -RequireUppercaseCharacters $true
```
+ Para obter detalhes da API, consulte [UpdateAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMAssumeRolePolicy`
O código de exemplo a seguir mostra como usar `Update-IAMAssumeRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza o perfil do IAM denominado `ClientRole` com uma nova política de confiança, cujo conteúdo vem do arquivo `ClientRolePolicy.json`. Observe que você deve usar o parâmetro switch `-Raw` para processar com êxito o conteúdo do arquivo JSON.**
```
Update-IAMAssumeRolePolicy -RoleName ClientRole -PolicyDocument (Get-Content -raw ClientRolePolicy.json)
```
+ Para obter detalhes da API, consulte [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMGroup`
O código de exemplo a seguir mostra como usar `Update-IAMGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo renomeia o grupo do IAM `Testers` para `AppTesters`.**
```
Update-IAMGroup -GroupName Testers -NewGroupName AppTesters
```
**Exemplo 2: este exemplo altera o caminho do grupo do IAM `AppTesters` para `/Org1/Org2/`. Isso altera o ARN do grupo para `arn:aws:iam::123456789012:group/Org1/Org2/AppTesters`.**
```
Update-IAMGroup -GroupName AppTesters -NewPath /Org1/Org2/
```
+ Para obter detalhes da API, consulte [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMLoginProfile`
O código de exemplo a seguir mostra como usar `Update-IAMLoginProfile`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo define uma nova senha temporária para o usuário `Bob` do IAM e exige que a pessoa altere a senha na próxima vez que fizer login.**
```
Update-IAMLoginProfile -UserName Bob -Password "P@ssw0rd1234" -PasswordResetRequired $true
```
+ Para obter detalhes da API, consulte [UpdateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMOpenIDConnectProviderThumbprint`
O código de exemplo a seguir mostra como usar `Update-IAMOpenIDConnectProviderThumbprint`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a lista de impressões digitais do certificado do provedor OIDC cujo ARN é `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com`, a fim de usar uma nova impressão digital. O provedor OIDC compartilha o novo valor quando o certificado associado ao provedor é alterado.**
```
Update-IAMOpenIDConnectProviderThumbprint -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com -ThumbprintList 7359755EXAMPLEabc3060bce3EXAMPLEec4542a3
```
+ Para obter detalhes da API, consulte [UpdateOpenIdConnectProviderThumbprint](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMRole`
O código de exemplo a seguir mostra como usar `Update-IAMRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a descrição do perfil e o valor máximo da duração da sessão (em segundos) para o qual a sessão de um perfil pode ser solicitada.**
```
Update-IAMRole -RoleName MyRoleName -Description "My testing role" -MaxSessionDuration 43200
```
+ Para obter detalhes da API, consulte [UpdateRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMRoleDescription`
O código de exemplo a seguir mostra como usar `Update-IAMRoleDescription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a descrição de um perfil do IAM na sua conta.**
```
Update-IAMRoleDescription -RoleName MyRoleName -Description "My testing role"
```
+ Para obter detalhes da API, consulte [UpdateRoleDescription](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMSAMLProvider`
O código de exemplo a seguir mostra como usar `Update-IAMSAMLProvider`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza o provedor SAML no IAM cujo ARN é `arn:aws:iam::123456789012:saml-provider/SAMLADFS` com um novo documento de metadados SAML do arquivo `SAMLMetaData.xml`. Observe que você deve usar o parâmetro switch `-Raw` para processar com êxito o conteúdo do arquivo JSON.**
```
Update-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
+ Para obter detalhes da API, consulte [UpdateSamlProvider](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMServerCertificate`
O código de exemplo a seguir mostra como usar `Update-IAMServerCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo renomeia o certificado denominado `MyServerCertificate` para `MyRenamedServerCertificate`.**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewServerCertificateName MyRenamedServerCertificate
```
**Exemplo 2: este exemplo move o certificado denominado `MyServerCertificate` para o caminho /Org1/Org2/. Isso altera o ARN do recurso para `arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate`.**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewPath /Org1/Org2/
```
+ Para obter detalhes da API, consulte [UpdateServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMSigningCertificate`
O código de exemplo a seguir mostra como usar `Update-IAMSigningCertificate`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza o certificado associado ao usuário do IAM chamado `Bob` e cujo ID do certificado é `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` para marcá-lo como inativo.**
```
Update-IAMSigningCertificate -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU -UserName Bob -Status Inactive
```
+ Para obter detalhes da API, consulte [UpdateSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-IAMUser`
O código de exemplo a seguir mostra como usar `Update-IAMUser`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo renomeia o usuário do IAM `Bob` para `Robert`.**
```
Update-IAMUser -UserName Bob -NewUserName Robert
```
**Exemplo 2: este exemplo altera o caminho do usuário do IAM `Bob` para `/Org1/Org2/`, o que efetivamente altera o ARN do usuário para `arn:aws:iam::123456789012:user/Org1/Org2/bob`.**
```
Update-IAMUser -UserName Bob -NewPath /Org1/Org2/
```
+ Para obter detalhes da API, consulte [UpdateUser](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-IAMGroupPolicy`
O código de exemplo a seguir mostra como usar `Write-IAMGroupPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma política em linha denominada `AppTesterPolicy` e a incorpora no grupo do IAM `AppTesters`. Se já existir uma política em linha com o mesmo nome, ela será substituída. O conteúdo da política JSON vem no arquivo `apptesterpolicy.json`. Observe que você deve usar o parâmetro `-Raw` para processar com êxito o conteúdo do arquivo JSON.**
```
Write-IAMGroupPolicy -GroupName AppTesters -PolicyName AppTesterPolicy -PolicyDocument (Get-Content -Raw apptesterpolicy.json)
```
+ Para obter detalhes da API, consulte [PutGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-IAMRolePolicy`
O código de exemplo a seguir mostra como usar `Write-IAMRolePolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma política em linha denominada `FedTesterRolePolicy` e a incorpora no perfil do IAM `FedTesterRole`. Se já existir uma política em linha com o mesmo nome, ela será substituída. O conteúdo da política JSON vem do arquivo `FedTesterPolicy.json`. Observe que você deve usar o parâmetro `-Raw` para processar com êxito o conteúdo do arquivo JSON.**
```
Write-IAMRolePolicy -RoleName FedTesterRole -PolicyName FedTesterRolePolicy -PolicyDocument (Get-Content -Raw FedTesterPolicy.json)
```
+ Para obter detalhes da API, consulte [PutRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-IAMUserPolicy`
O código de exemplo a seguir mostra como usar `Write-IAMUserPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma política em linha denominada `EC2AccessPolicy` e a incorpora no usuário do IAM `Bob`. Se já existir uma política em linha com o mesmo nome, ela será substituída. O conteúdo da política JSON vem do arquivo `EC2AccessPolicy.json`. Observe que você deve usar o parâmetro `-Raw` para processar com êxito o conteúdo do arquivo JSON.**
```
Write-IAMUserPolicy -UserName Bob -PolicyName EC2AccessPolicy -PolicyDocument (Get-Content -Raw EC2AccessPolicy.json)
```
+ Para obter detalhes da API, consulte [PutUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Kinesis usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Kinesis.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-KINRecord`
O código de exemplo a seguir mostra como usar `Get-KINRecord`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra como retornar e extrair dados de uma série de um ou mais registros. O iterador fornecido Get-KINRecord determina a posição inicial dos registros a serem retornados, os quais, neste exemplo, são capturados em uma variável, \$1records. Cada registro individual pode então ser acessado indexando a coleção \$1records. Supondo que os dados no registro sejam texto codificado em UTF-8, o comando final mostra como você pode extrair os dados do MemoryStream objeto e retorná-los como texto para o console.**
```
$records
$records = Get-KINRecord -ShardIterator "AAAAAAAAAAGIc....9VnbiRNaP"
```
**Saída**:
```
MillisBehindLatest NextShardIterator Records
------------------ ----------------- -------
0 AAAAAAAAAAERNIq...uDn11HuUs {Key1, Key2}
```
```
$records.Records[0]
```
**Saída**:
```
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())
```
**Saída**:
```
test data from string
```
+ Para obter detalhes da API, consulte [GetRecords](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-KINShardIterator`
O código de exemplo a seguir mostra como usar `Get-KINShardIterator`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna um iterador de fragmentos para o fragmento e a posição inicial especificados. Detalhes dos identificadores de fragmentos e dos números de sequência podem ser obtidos na saída do Get-KINStream cmdlet, fazendo referência à coleção Shards do objeto de fluxo retornado. O iterador retornado pode ser usado com o Get-KINRecord cmdlet para extrair registros de dados no fragmento.**
```
Get-KINShardIterator -StreamName "mystream" -ShardId "shardId-000000000000" -ShardIteratorType AT_SEQUENCE_NUMBER -StartingSequenceNumber "495598645..."
```
**Saída**:
```
AAAAAAAAAAGIc....9VnbiRNaP
```
+ Para obter detalhes da API, consulte [GetShardIterator](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-KINStream`
O código de exemplo a seguir mostra como usar `Get-KINStream`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna detalhes do fluxo especificado.**
```
Get-KINStream -StreamName "mystream"
```
**Saída**:
```
HasMoreShards : False
RetentionPeriodHours : 24
Shards : {}
StreamARN : arn:aws:kinesis:us-west-2:123456789012:stream/mystream
StreamName : mystream
StreamStatus : ACTIVE
```
+ Para obter detalhes da API, consulte [DescribeStream](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-KINStream`
O código de exemplo a seguir mostra como usar `New-KINStream`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria um fluxo.**
```
New-KINStream -StreamName "mystream" -ShardCount 1
```
+ Para obter detalhes da API, consulte [CreateStream](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-KINStream`
O código de exemplo a seguir mostra como usar `Remove-KINStream`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui o fluxo especificado. A confirmação será solicitada antes que a operação continue. Para ignorar a solicitação de confirmação, use a opção -Force.**
```
Remove-KINStream -StreamName "mystream"
```
+ Para obter detalhes da API, consulte [DeleteStream](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-KINRecord`
O código de exemplo a seguir mostra como usar `Write-KINRecord`.
**Ferramentas para PowerShell V5**
**Exemplo 1: grava um registro contendo a string fornecida ao parâmetro -Text.**
```
Write-KINRecord -Text "test data from string" -StreamName "mystream" -PartitionKey "Key1"
```
**Exemplo 2: grava um registro contendo os dados contidos no arquivo especificado. O arquivo é tratado como uma sequência de bytes, portanto, se contiver texto, ele deverá ser gravado com qualquer codificação necessária antes de ser usado com esse cmdlet.**
```
Write-KINRecord -FilePath "C:\TestData.txt" -StreamName "mystream" -PartitionKey "Key2"
```
+ Para obter detalhes da API, consulte [PutRecord](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Lambda usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Lambda.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-LMResourceTag`
O código de exemplo a seguir mostra como usar `Add-LMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: adiciona as três tags (Washington, Oregon e Califórnia) e seus valores associados à função especificada identificada por seu ARN.**
```
Add-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -Tag @{ "Washington" = "Olympia"; "Oregon" = "Salem"; "California" = "Sacramento" }
```
+ Para obter detalhes da API, consulte [TagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMAccountSetting`
O código de exemplo a seguir mostra como usar `Get-LMAccountSetting`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo é apresentado para comparar o limite da conta e o uso da conta**
```
Get-LMAccountSetting | Select-Object @{Name="TotalCodeSizeLimit";Expression={$_.AccountLimit.TotalCodeSize}}, @{Name="TotalCodeSizeUsed";Expression={$_.AccountUsage.TotalCodeSize}}
```
**Saída**:
```
TotalCodeSizeLimit TotalCodeSizeUsed
------------------ -----------------
80530636800 15078795
```
+ Para obter detalhes da API, consulte [GetAccountSettings](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMAlias`
O código de exemplo a seguir mostra como usar `Get-LMAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera os pesos da configuração de roteamento para o alias de uma função do Lambda específica.**
```
Get-LMAlias -FunctionName "MylambdaFunction123" -Name "newlabel1" -Select RoutingConfig
```
**Saída**:
```
AdditionalVersionWeights
------------------------
{[1, 0.6]}
```
+ Para obter detalhes da API, consulte [GetAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMFunctionConcurrency`
O código de exemplo a seguir mostra como usar `Get-LMFunctionConcurrency`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo obtém a simultaneidade reservada para a função do Lambda**
```
Get-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -Select *
```
**Saída**:
```
ReservedConcurrentExecutions
----------------------------
100
```
+ Para obter detalhes da API, consulte [GetFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMFunctionConfiguration`
O código de exemplo a seguir mostra como usar `Get-LMFunctionConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a configuração específica de versão de uma função do Lambda.**
```
Get-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Qualifier "PowershellAlias"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMFunctionList`
O código de exemplo a seguir mostra como usar `Get-LMFunctionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra todas as funções do Lambda com tamanho de código classificado**
```
Get-LMFunctionList | Sort-Object -Property CodeSize | Select-Object FunctionName, RunTime, Timeout, CodeSize
```
**Saída**:
```
FunctionName Runtime Timeout CodeSize
------------ ------- ------- --------
test python2.7 3 243
MylambdaFunction123 python3.8 600 659
myfuncpython1 python3.8 303 675
```
+ Para obter detalhes da API, consulte [ListFunctions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMPolicy`
O código de exemplo a seguir mostra como usar `Get-LMPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo mostra a política de função da função do Lambda**
```
Get-LMPolicy -FunctionName test -Select Policy
```
**Saída**:
```
{"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 obter detalhes da API, consulte [GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMProvisionedConcurrencyConfig`
O código de exemplo a seguir mostra como usar `Get-LMProvisionedConcurrencyConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo obtém a configuração de simultaneidade provisionada para o alias especificado da função do Lambda.**
```
C:\>Get-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
**Saída**:
```
AllocatedProvisionedConcurrentExecutions : 0
AvailableProvisionedConcurrentExecutions : 0
LastModified : 2020-01-15T03:21:26+0000
RequestedProvisionedConcurrentExecutions : 70
Status : IN_PROGRESS
StatusReason :
```
+ Para obter detalhes da API, consulte [GetProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMProvisionedConcurrencyConfigList`
O código de exemplo a seguir mostra como usar `Get-LMProvisionedConcurrencyConfigList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera a lista de configurações de simultaneidade provisionada para uma função do Lambda.**
```
Get-LMProvisionedConcurrencyConfigList -FunctionName "MylambdaFunction123"
```
+ Para obter detalhes da API, consulte [ListProvisionedConcurrencyConfigs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMResourceTag`
O código de exemplo a seguir mostra como usar `Get-LMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera as tags e seus valores atualmente definidos na função especificada.**
```
Get-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
**Saída**:
```
Key Value
--- -----
California Sacramento
Oregon Salem
Washington Olympia
```
+ Para obter detalhes da API, consulte [ListTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-LMVersionsByFunction`
O código de exemplo a seguir mostra como usar `Get-LMVersionsByFunction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna a lista de configurações específicas de versão para cada versão da função do Lambda.**
```
Get-LMVersionsByFunction -FunctionName "MylambdaFunction123"
```
**Saída**:
```
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 obter detalhes da API, consulte [ListVersionsByFunction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-LMAlias`
O código de exemplo a seguir mostra como usar `New-LMAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um novo alias do Lambda para versão e configuração de roteamento especificadas a fim de indicar o percentual de solicitações de invocação que ele receberá.**
```
New-LMAlias -FunctionName "MylambdaFunction123" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6} -Description "Alias for version 4" -FunctionVersion 4 -Name "PowershellAlias"
```
+ Para obter detalhes da API, consulte [CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Publish-LMFunction`
O código de exemplo a seguir mostra como usar `Publish-LMFunction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria uma nova função C\$1 (dotnetcore1.0 runtime) nomeada no MyFunction AWS Lambda, fornecendo os binários compilados para a função a partir de um arquivo zip no sistema de arquivos local (caminhos relativos ou absolutos podem ser usados). As funções Lambda do C\$1 especificam o manipulador da função usando a designação: :Namespace. AssemblyName ClassName::MethodName. É necessário substituir adequadamente o nome da montagem (sem o sufixo .dll), o namespace, o nome da classe e o nome do método da especificação do manipulador. A nova função terá as variáveis de ambiente “envvar1” e “envvar2” configuradas com base nos valores fornecidos.**
```
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" }
```
**Saída**:
```
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 :
```
**Exemplo 2: este exemplo é semelhante ao anterior, com a exceção de que os binários da função são carregados primeiramente em um bucket do Amazon S3 (que deve estar na mesma região da função do Lambda desejada) e o objeto resultante do S3 será referenciado ao criar a função.**
```
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 obter detalhes da API, consulte [CreateFunction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Publish-LMVersion`
O código de exemplo a seguir mostra como usar `Publish-LMVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria uma versão para o snapshot existente do código da função do Lambda**
```
Publish-LMVersion -FunctionName "MylambdaFunction123" -Description "Publishing Existing Snapshot of function code as a new version through Powershell"
```
+ Para obter detalhes da API, consulte [PublishVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMAlias`
O código de exemplo a seguir mostra como usar `Remove-LMAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui o alias da função do Lambda mencionado no comando.**
```
Remove-LMAlias -FunctionName "MylambdaFunction123" -Name "NewAlias"
```
+ Para obter detalhes da API, consulte [DeleteAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMFunction`
O código de exemplo a seguir mostra como usar `Remove-LMFunction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo exclui uma versão específica de uma função do Lambda**
```
Remove-LMFunction -FunctionName "MylambdaFunction123" -Qualifier '3'
```
+ Para obter detalhes da API, consulte [DeleteFunction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMFunctionConcurrency`
O código de exemplo a seguir mostra como usar `Remove-LMFunctionConcurrency`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove a simultaneidade de função da função do Lambda.**
```
Remove-LMFunctionConcurrency -FunctionName "MylambdaFunction123"
```
+ Para obter detalhes da API, consulte [DeleteFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMPermission`
O código de exemplo a seguir mostra como usar `Remove-LMPermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo remove a política de função para o especificado StatementId de uma função Lambda.**
```
$policy = Get-LMPolicy -FunctionName "MylambdaFunction123" -Select Policy | ConvertFrom-Json| Select-Object -ExpandProperty Statement
Remove-LMPermission -FunctionName "MylambdaFunction123" -StatementId $policy[0].Sid
```
+ Para obter detalhes da API, consulte [RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMProvisionedConcurrencyConfig`
O código de exemplo a seguir mostra como usar `Remove-LMProvisionedConcurrencyConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo remove a configuração de simultaneidade provisionada para um alias específico.**
```
Remove-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
+ Para obter detalhes da API, consulte [DeleteProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-LMResourceTag`
O código de exemplo a seguir mostra como usar `Remove-LMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: remove as tags fornecidas de uma função. A menos que a opção -Force esteja especificada, o cmdlet solicitará a confirmação antes de continuar. Uma única chamada será feita para o serviço a fim de remover as tags.**
```
Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -TagKey "Washington","Oregon","California"
```
**Exemplo 2: remove as tags fornecidas de uma função. A menos que a opção -Force esteja especificada, o cmdlet solicitará a confirmação antes de continuar. Isso acontece porque a chamada para o serviço é feita pela tag fornecida.**
```
"Washington","Oregon","California" | Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
+ Para obter detalhes da API, consulte [UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-LMAlias`
O código de exemplo a seguir mostra como usar `Update-LMAlias`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a configuração de um alias de função do Lambda existente. Ele atualiza o RoutingConfiguration valor para transferir 60% (0,6) do tráfego para a versão 1**
```
Update-LMAlias -FunctionName "MylambdaFunction123" -Description " Alias for version 2" -FunctionVersion 2 -Name "newlabel1" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6}
```
+ Para obter detalhes da API, consulte [UpdateAlias](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-LMFunctionCode`
O código de exemplo a seguir mostra como usar `Update-LMFunctionCode`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza a função chamada 'MyFunction' com o novo conteúdo contido no arquivo zip especificado. Para uma função do Lambda em C\$1 .NET Core, o arquivo zip deve conter a montagem compilada.**
```
Update-LMFunctionCode -FunctionName MyFunction -ZipFilename .\UpdatedCode.zip
```
**Exemplo 2: este exemplo é semelhante ao anterior, mas usa um objeto do Amazon S3 contendo o código atualizado para atualizar a função.**
```
Update-LMFunctionCode -FunctionName MyFunction -BucketName amzn-s3-demo-bucket -Key UpdatedCode.zip
```
+ Para obter detalhes da API, consulte [UpdateFunctionCode](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-LMFunctionConfiguration`
O código de exemplo a seguir mostra como usar `Update-LMFunctionConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo atualiza a configuração da função do 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 obter detalhes da API, consulte [UpdateFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-LMFunctionConcurrency`
O código de exemplo a seguir mostra como usar `Write-LMFunctionConcurrency`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo aplica as configurações de simultaneidade para a função de maneira geral.**
```
Write-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -ReservedConcurrentExecution 100
```
+ Para obter detalhes da API, consulte [PutFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-LMProvisionedConcurrencyConfig`
O código de exemplo a seguir mostra como usar `Write-LMProvisionedConcurrencyConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo adiciona uma configuração de simultaneidade provisionada ao alias de uma função**
```
Write-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -ProvisionedConcurrentExecution 20 -Qualifier "NewAlias1"
```
+ Para obter detalhes da API, consulte [PutProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Amazon ML usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon ML.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-MLBatchPrediction`
O código de exemplo a seguir mostra como usar `Get-MLBatchPrediction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os metadados detalhados para uma previsão em lote com ID de identificação.**
```
Get-MLBatchPrediction -BatchPredictionId ID
```
+ Para obter detalhes da API, consulte [GetBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLBatchPredictionList`
O código de exemplo a seguir mostra como usar `Get-MLBatchPredictionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna uma lista de todos BatchPredictions os registros de dados associados que correspondem ao critério de pesquisa fornecido na solicitação.**
```
Get-MLBatchPredictionList
```
**Exemplo 2: Retorna uma lista de todos BatchPredictions com o status CONCLUÍDO.**
```
Get-MLBatchPredictionList -FilterVariable Status -EQ COMPLETED
```
+ Para obter detalhes da API, consulte [DescribeBatchPredictions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLDataSource`
O código de exemplo a seguir mostra como usar `Get-MLDataSource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna os metadados, o status e as informações do arquivo de dados de a DataSource com o ID de identificação**
```
Get-MLDataSource -DataSourceId ID
```
+ Para obter detalhes da API, consulte [GetDataSource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLDataSourceList`
O código de exemplo a seguir mostra como usar `Get-MLDataSourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna uma lista de todos DataSources e seus registros de dados associados.**
```
Get-MLDataSourceList
```
**Exemplo 2: Retorna uma lista de todos DataSources com o status CONCLUÍDO.**
```
Get-MLDataDourceList -FilterVariable Status -EQ COMPLETED
```
+ Para obter detalhes da API, consulte [DescribeDataSources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLEvaluation`
O código de exemplo a seguir mostra como usar `Get-MLEvaluation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna metadados e status para uma avaliação com ID de id.**
```
Get-MLEvaluation -EvaluationId ID
```
+ Para obter detalhes da API, consulte [GetEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLEvaluationList`
O código de exemplo a seguir mostra como usar `Get-MLEvaluationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna uma lista de todos os recursos de avaliação**
```
Get-MLEvaluationList
```
**Exemplo 2: retorna uma lista de todas as avaliações com o status COMPLETED.**
```
Get-MLEvaluationList -FilterVariable Status -EQ COMPLETED
```
+ Para obter detalhes da API, consulte [DescribeEvaluations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-MLModel`
O código de exemplo a seguir mostra como usar `Get-MLModel`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os metadados detalhados, o status, o esquema e as informações do arquivo de dados para um MLModel com ID de identificação.**
```
Get-MLModel -ModelId ID
```
+ Para obter detalhes da API, consulte [Get MLModel](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Get-MLModelList`
O código de exemplo a seguir mostra como usar `Get-MLModelList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna uma lista de todos os modelos e seus registros de dados associados.**
```
Get-MLModelList
```
**Exemplo 2: retorna uma lista de todos os modelos com o status COMPLETED.**
```
Get-MLModelList -FilterVariable Status -EQ COMPLETED
```
+ Para obter detalhes da API, consulte [Descrever MLModels](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `Get-MLPrediction`
O código de exemplo a seguir mostra como usar `Get-MLPrediction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: envie um registro para o URL do endpoint de previsão em tempo real para o modelo com ID de id.**
```
Get-MLPrediction -ModelId ID -PredictEndpoint URL -Record @{"A" = "B"; "C" = "D";}
```
+ Consulte detalhes da API em [Predict](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
### `New-MLBatchPrediction`
O código de exemplo a seguir mostra como usar `New-MLBatchPrediction`.
**Ferramentas para PowerShell V5**
**Exemplo 1: crie uma solicitação de previsão de lote para o modelo com ID de id e coloca a saída no local especificado do S3.**
```
New-MLBatchPrediction -ModelId ID -Name NAME -OutputURI s3://...
```
+ Para obter detalhes da API, consulte [CreateBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-MLDataSourceFromS3`
O código de exemplo a seguir mostra como usar `New-MLDataSourceFromS3`.
**Ferramentas para PowerShell V5**
**Exemplo 1: crie uma fonte de dados com dados de um local do S3, com um nome de NAME e um esquema de SCHEMA.**
```
New-MLDataSourceFromS3 -Name NAME -ComputeStatistics $true -DataSpec_DataLocationS3 "s3://BUCKET/KEY" -DataSchema SCHEMA
```
+ Para obter detalhes da API, consulte [CreateDataSourceFromS3](https://docs.aws.amazon.com/powershell/v5/reference) em *Referência de Ferramentas da AWS para PowerShell cmdlet (*V5).
### `New-MLEvaluation`
O código de exemplo a seguir mostra como usar `New-MLEvaluation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: crie uma avaliação para um determinado ID de fonte de dados e ID de modelo**
```
New-MLEvaluation -Name NAME -DataSourceId DSID -ModelId MID
```
+ Para obter detalhes da API, consulte [CreateEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-MLModel`
O código de exemplo a seguir mostra como usar `New-MLModel`.
**Ferramentas para PowerShell V5**
**Exemplo 1: crie um modelo com dados de treinamento.**
```
New-MLModel -Name NAME -ModelType BINARY -Parameter @{...} -TrainingDataSourceId ID
```
+ Para obter detalhes da API, consulte [Criar MLModel](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-MLRealtimeEndpoint`
O código de exemplo a seguir mostra como usar `New-MLRealtimeEndpoint`.
**Ferramentas para PowerShell V5**
**Exemplo 1: crie um endpoint de previsão em tempo real para o ID do modelo fornecido.**
```
New-MLRealtimeEndpoint -ModelId ID
```
+ Para obter detalhes da API, consulte [CreateRealtimeEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Macie usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Macie.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-MAC2FindingList`
O código de exemplo a seguir mostra como usar `Get-MAC2FindingList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna uma lista de descobertas contendo uma detecção FindingIds de dados confidenciais com o tipo “CREDIT\$1CARD\$1NUMBER” ou “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 obter detalhes da API, consulte [ListFindings](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS Price List exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS Price List.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-PLSAttributeValue`
O código de exemplo a seguir mostra como usar `Get-PLSAttributeValue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os valores do atributo 'volumeType' para a Amazon EC2 na região us-east-1.**
```
Get-PLSAttributeValue -ServiceCode AmazonEC2 -AttributeName "volumeType" -region us-east-1
```
**Saída**:
```
Value
-----
Cold HDD
General Purpose
Magnetic
Provisioned IOPS
Throughput Optimized HDD
```
+ Para obter detalhes da API, consulte [GetAttributeValues](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-PLSProduct`
O código de exemplo a seguir mostra como usar `Get-PLSProduct`.
**Ferramentas para PowerShell V5**
**Exemplo 1: devolve detalhes de todos os produtos da Amazon EC2.**
```
Get-PLSProduct -ServiceCode AmazonEC2 -Region us-east-1
```
**Saída**:
```
{"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"},...
```
**Exemplo 2: Retorna dados da Amazon EC2 na região us-east-1 filtrados por tipos de volume de “Uso geral” que são suportados 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
```
**Saída**:
```
{"product":{"productFamily":"Storage","attributes":{"storageMedia":"SSD-backed","maxThroughputvolume":"160 MB/sec","volumeType":"General Purpose","maxIopsvolume":"10000",...
```
+ Para obter detalhes da API, consulte [GetProducts](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-PLSService`
O código de exemplo a seguir mostra como usar `Get-PLSService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os metadados de todos os códigos de serviço disponíveis na região us-east-1.**
```
Get-PLSService -Region us-east-1
```
**Saída**:
```
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
...
```
**Exemplo 2: retorna os metadados do EC2 serviço da Amazon na região us-east-1.**
```
Get-PLSService -ServiceCode AmazonEC2 -Region us-east-1
```
**Saída**:
```
AttributeNames ServiceCode
-------------- -----------
{volumeType, maxIopsvolume, instanceCapacity10xlarge, locationType...} AmazonEC2
```
+ Para obter detalhes da API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de Resource Groups usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Resource Groups.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-RGResourceTag`
O código de exemplo a seguir mostra como usar `Add-RGResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona a chave de tag “Instances” com o valor “workboxes” ao ARN do grupo de recursos fornecido**
```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Saída**:
```
Arn Tags
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+ Consulte detalhes da API em [Tag](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
### `Find-RGResource`
O código de exemplo a seguir mostra como usar `Find-RGResource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um tipo de recurso ResourceQuery for Instance com filtros de tag e encontra 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
```
**Saída**:
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+ Para obter detalhes da API, consulte [SearchResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGGroup`
O código de exemplo a seguir mostra como usar `Get-RGGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera o grupo de recursos de acordo com o nome do grupo**
```
Get-RGGroup -GroupName auto-no
```
**Saída**:
```
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+ Para obter detalhes da API, consulte [GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGGroupList`
O código de exemplo a seguir mostra como usar `Get-RGGroupList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista o grupo de recursos já criado.**
```
Get-RGGroupList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGGroupQuery`
O código de exemplo a seguir mostra como usar `Get-RGGroupQuery`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca a consulta de recursos para determinado grupo de recursos**
```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**Saída**:
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+ Para obter detalhes da API, consulte [GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGGroupResourceList`
O código de exemplo a seguir mostra como usar `Get-RGGroupResourceList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista os recursos do grupo com base no filtro por tipo de recurso**
```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**Saída**:
```
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 obter detalhes da API, consulte [ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGResourceTag`
O código de exemplo a seguir mostra como usar `Get-RGResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista tags para o ARN do grupo de recursos fornecido**
```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**Saída**:
```
Key Value
--- -----
Instances workboxes
```
+ Para obter detalhes da API, consulte [GetTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-RGGroup`
O código de exemplo a seguir mostra como usar `New-RGGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo cria um novo grupo de AWS recursos de Resource Groups baseado em tags chamado TestPowerShellGroup. O grupo inclui EC2 instâncias da Amazon na região atual que são marcadas com a chave de tag “Nome” e o valor da tag “test2". O comando retorna a consulta, o tipo de grupo e os resultados da operação.**
```
$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."
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-RGGroup`
O código de exemplo a seguir mostra como usar `Remove-RGGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove o grupo de recursos nomeado**
```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-RGResourceTag`
O código de exemplo a seguir mostra como usar `Remove-RGResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag mencionada do grupo de recursos**
```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**Saída**:
```
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}
```
+ Consulte detalhes da API em [Untag](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
### `Update-RGGroup`
O código de exemplo a seguir mostra como usar `Update-RGGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza a descrição do grupo**
```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**Saída**:
```
Description GroupArn Name
----------- -------- ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+ Para obter detalhes da API, consulte [UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-RGGroupQuery`
O código de exemplo a seguir mostra como usar `Update-RGGroupQuery`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um objeto de consulta e atualiza a consulta para o 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
```
**Saída**:
```
GroupName ResourceQuery
--------- -------------
build600 Amazon.ResourceGroups.Model.ResourceQuery
```
+ Para obter detalhes da API, consulte [UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos da API de marcação de Resource Groups usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a API Ferramentas da AWS para PowerShell V5 com Resource Groups Tagging.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-RGTResourceTag`
O código de exemplo a seguir mostra como usar `Add-RGTResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona as chaves de tag “stage” e “version” com os valores “beta” e “preprod\$1test” a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de aplicar as tags.**
```
$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" }
```
**Exemplo 2: esse exemplo adiciona as tags e os valores especificados a um bucket do Amazon S3 e a uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o 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 obter detalhes da API, consulte [TagResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGTResource`
O código de exemplo a seguir mostra como usar `Get-RGTResource`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todos os recursos marcados em uma região e as chaves de tag associadas ao recurso. Se nenhum parâmetro -Region for fornecido ao cmdlet, ele tentará inferir a região a partir dos metadados do shell ou da instância. EC2 **
```
Get-RGTResource
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Exemplo 2: retorna todos os recursos marcados do tipo especificado em uma região. A string para cada nome de serviço e tipo de recurso é a mesma incorporada ao nome do recurso da Amazon (ARN) de um recurso.**
```
Get-RGTResource -ResourceType "s3"
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Exemplo 3: retorna todos os recursos marcados do tipo especificado em uma região. Observe que quando os tipos de recursos são canalizados para o cmdlet, uma chamada para o serviço é feita para cada tipo de recurso fornecido.**
```
"dynamodb","s3" | Get-RGTResource
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Exemplo 4: retorna todos os recursos marcados que correspondem ao filtro especificado.**
```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**Exemplo 5: retorna todos os recursos marcados que correspondem ao filtro e ao tipo de recurso especificados.**
```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
**Exemplo 6: retorna todos os recursos marcados que correspondem ao filtro especificado.**
```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**Saída**:
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
+ Para obter detalhes da API, consulte [GetResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGTTagKey`
O código de exemplo a seguir mostra como usar `Get-RGTTagKey`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todas as chaves de tag na região especificada. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região a partir da região padrão do shell ou dos metadados da instância. EC2 Observe que as chaves da tag não são retornadas em nenhuma ordem específica.**
```
Get-RGTTagKey -region us-west-2
```
**Saída**:
```
version
stage
```
+ Para obter detalhes da API, consulte [GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-RGTTagValue`
O código de exemplo a seguir mostra como usar `Get-RGTTagValue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o valor da tag especificada em uma região. Se o parâmetro -Region não for especificado, o cmdlet tentará inferir a região a partir da região padrão do shell ou dos metadados da instância. EC2 **
```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**Saída**:
```
beta
```
+ Para obter detalhes da API, consulte [GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-RGTResourceTag`
O código de exemplo a seguir mostra como usar `Remove-RGTResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Uma única chamada será feita para o serviço a fim de remover as tags. Antes que as tags sejam removidas, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o 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"
```
**Exemplo 2: remove as chaves de tag “stage” e “version” e os valores associados de um bucket do Amazon S3 e de uma tabela do Amazon DynamoDB. Duas chamadas são feitas para o serviço, uma para cada ARN de recurso canalizado para o cmdlet. Antes de cada chamada, o cmdlet solicitará a confirmação. Para ignorar a confirmação, adicione o 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 obter detalhes da API, consulte [UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Route 53 usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a Ferramentas da AWS para PowerShell V5 com o Route 53.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Edit-R53ResourceRecordSet`
O código de exemplo a seguir mostra como usar `Edit-R53ResourceRecordSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo cria um registro A para www.example.com e altera o registro A para test.example.com de 192.0.2.3 a 192.0.2.1. Observe que os valores dos registros do tipo TXT alterados devem estar entre aspas duplas. Consulte a documentação do Amazon Route 53 para obter mais detalhes. Você pode usar o Get-R53Change cmdlet para pesquisar para determinar quando as alterações foram concluídas.**
```
$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
```
**Exemplo 2: este exemplo mostra como criar conjuntos de registros de recurso do alias. 'Z222222222' é o ID da zona hospedada do Amazon Route 53 na qual você está criando o conjunto de registros de recurso do alias. 'exemplo.com' é o ápex da zona para o qual você deseja criar um alias e 'www.exemplo.com' é um subdomínio para o qual você também deseja criar um alias. 'Z1111111111111' é um exemplo de ID de zona hospedada para o balanceador de carga e 'example-load-balancer-1111111111.us-east-1.elb.amazonaws.com' é um exemplo de nome de domínio do balanceador de carga com o qual o Amazon Route 53 responde às consultas de example.com e www.example.com. Consulte a documentação do Amazon Route 53 para obter mais detalhes. Você pode usar o Get-R53Change cmdlet para pesquisar para determinar quando as alterações foram concluídas.**
```
$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
```
**Exemplo 3: este exemplo cria dois registros A para www.example.com. Um quarto das vezes (1/(1\$13)), o Amazon Route 53 responde às consultas para www.example.com com os dois valores para o primeiro conjunto de registros de recurso (192.0.2.9 e 192.0.2.10). Três quartos das vezes (3/(1\$13)), o Amazon Route 53 responde às consultas para www.example.com com os dois valores para o primeiro conjunto de registros de recurso (192.0.2.11 e 192.0.2.12). Consulte a documentação do Amazon Route 53 para obter mais detalhes. Você pode usar o Get-R53Change cmdlet para pesquisar para determinar quando as alterações foram concluídas.**
```
$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
```
**Exemplo 4: Este exemplo mostra como criar conjuntos de registros de recursos de alias ponderados, supondo que example.com seja o domínio para o qual você deseja criar conjuntos de registros de recursos de alias ponderados. SetIdentifier diferencia os dois conjuntos de registros de recursos de alias ponderados um do outro. Esse elemento é necessário porque os elementos Nome e Tipo têm os mesmos valores para os dois conjuntos de registros de recurso. Z11111111111 e Z333333333333333 são exemplos de zona hospedada para o balanceador de carga ELB especificado pelo valor de. IDs DNSName example-load-balancer-22222222.us-east-1.elb.amazonaws.com e example-load-balancer -4444444444.us-east-1.elb.amazonaws.com são exemplos de domínios do Elastic Load Balancing dos quais o Amazon Route 53 responde a consultas de example.com. Consulte a documentação do Amazon Route 53 para obter mais detalhes. Você pode usar o Get-R53Change cmdlet para pesquisar para determinar quando as alterações foram concluídas.**
```
$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
```
**Exemplo 5: este exemplo cria dois conjuntos de registros de recurso do alias de latência, um para um balanceador de carga do ELB na região Oeste dos EUA (Oregon) (us-west-2) e outro para um balanceador de carga na região Ásia-Pacífico (Singapura) (ap-southeast-1). Consulte a documentação do Amazon Route 53 para obter mais detalhes. Você pode usar o Get-R53Change cmdlet para pesquisar para determinar quando as alterações foram concluídas.**
```
$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 obter detalhes da API, consulte [ChangeResourceRecordSets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53AccountLimit`
O código de exemplo a seguir mostra como usar `Get-R53AccountLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o número máximo de zonas hospedadas que podem ser criadas usando a conta atual.**
```
Get-R53AccountLimit -Type MAX_HOSTED_ZONES_BY_OWNER
```
**Saída**:
```
15
```
+ Para obter detalhes da API, consulte [GetAccountLimit](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53CheckerIpRanges`
O código de exemplo a seguir mostra como usar `Get-R53CheckerIpRanges`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo retorna o CIDRs para os verificadores de saúde do Route53**
```
Get-R53CheckerIpRanges
```
**Saída**:
```
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 obter detalhes da API, consulte [GetCheckerIpRanges](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53HostedZone`
O código de exemplo a seguir mostra como usar `Get-R53HostedZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna detalhes da zona hospedada com a ID PJN98 FT9 Z1D633.**
```
Get-R53HostedZone -Id Z1D633PJN98FT9
```
+ Para obter detalhes da API, consulte [GetHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53HostedZoneCount`
O código de exemplo a seguir mostra como usar `Get-R53HostedZoneCount`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o número total de zonas hospedadas públicas e privadas da atual Conta da AWS.**
```
Get-R53HostedZoneCount
```
+ Para obter detalhes da API, consulte [GetHostedZoneCount](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53HostedZoneLimit`
O código de exemplo a seguir mostra como usar `Get-R53HostedZoneLimit`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o limite do número máximo de registros que podem ser criados na zona hospedada especificada.**
```
Get-R53HostedZoneLimit -HostedZoneId Z3MEQ8T7HAAAAF -Type MAX_RRSETS_BY_ZONE
```
**Saída**:
```
5
```
+ Para obter detalhes da API, consulte [GetHostedZoneLimit](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53HostedZoneList`
O código de exemplo a seguir mostra como usar `Get-R53HostedZoneList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: apresenta todas as zonas hospedadas públicas e privadas.**
```
Get-R53HostedZoneList
```
**Exemplo 2: Exibe todas as zonas hospedadas associadas ao conjunto de delegações reutilizáveis que tem o ID X2CISAMPLE NZ8**
```
Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE
```
+ Para obter detalhes da API, consulte [ListHostedZones](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53HostedZonesByName`
O código de exemplo a seguir mostra como usar `Get-R53HostedZonesByName`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todas as zonas hospedadas públicas e privadas em ordem ASCII por nome de domínio.**
```
Get-R53HostedZonesByName
```
**Exemplo 2: retorna as zonas hospedadas públicas e privadas em ordem ASCII por nome de domínio, a partir do nome DNS especificado.**
```
Get-R53HostedZonesByName -DnsName example2.com
```
+ Para obter detalhes da API, consulte [ListHostedZonesByName](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53QueryLoggingConfigList`
O código de exemplo a seguir mostra como usar `Get-R53QueryLoggingConfigList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo retorna todas as configurações de registro em log de consultas ao DNS associadas à Conta da AWS atual.**
```
Get-R53QueryLoggingConfigList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListQueryLoggingConfigs](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-R53ReusableDelegationSet`
O código de exemplo a seguir mostra como usar `Get-R53ReusableDelegationSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera informações sobre o conjunto de delegações especificado, incluindo os quatro servidores atribuídos ao conjunto de delegações.**
```
Get-R53ReusableDelegationSet -Id N23DS9X4AYEAAA
```
**Saída**:
```
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 obter detalhes da API, consulte [GetReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-R53HostedZone`
O código de exemplo a seguir mostra como usar `New-R53HostedZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: cria uma nova zona hospedada denominada 'example.com', associada a um conjunto de delegações reutilizável. Observe que você deve fornecer um valor para o CallerReference parâmetro para que as solicitações precisem ser repetidas, se necessário, sem o risco de executar a operação duas vezes. Como a zona hospedada está sendo criada em uma VPC, ela é automaticamente privada e você não deve definir o 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 obter detalhes da API, consulte [CreateHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-R53QueryLoggingConfig`
O código de exemplo a seguir mostra como usar `New-R53QueryLoggingConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma nova configuração de registro de consultas ao DNS do Route53 para a zona hospedada especificada. O Amazon Route53 publicará logs de consulta ao DNS no grupo de logs do Cloudwatch especificado.**
```
New-R53QueryLoggingConfig -HostedZoneId Z3MEQ8T7HAAAAF -CloudWatchLogsLogGroupArn arn:aws:logs:us-east-1:111111111111:log-group:/aws/route53/example.com:*
```
**Saída**:
```
QueryLoggingConfig Location
------------------ --------
Amazon.Route53.Model.QueryLoggingConfig https://route53.amazonaws.com/2013-04-01/queryloggingconfig/ee5aaa95-4e03-4fdc-9d28-9e24ddaaaaa3
```
+ Para obter detalhes da API, consulte [CreateQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-R53ReusableDelegationSet`
O código de exemplo a seguir mostra como usar `New-R53ReusableDelegationSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um conjunto de delegação reutilizável de quatro servidores de nomes que podem ser utilizados novamente por várias zonas hospedadas.**
```
New-R53ReusableDelegationSet -CallerReference testcallerreference
```
**Saída**:
```
DelegationSet Location
------------- --------
Amazon.Route53.Model.DelegationSet https://route53.amazonaws.com/2013-04-01/delegationset/N23DS9XAAAAAXM
```
+ Para obter detalhes da API, consulte [CreateReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-R53VPCWithHostedZone`
O código de exemplo a seguir mostra como usar `Register-R53VPCWithHostedZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa a VPC especificada à zona hospedada privada.**
```
Register-R53VPCWithHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**Saída**:
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C3SCAAA633Z6DX PENDING 01/28/2020 19:32:02
```
+ Para obter detalhes da API, consulte [Associate VPCWith HostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Remove-R53HostedZone`
O código de exemplo a seguir mostra como usar `Remove-R53HostedZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a zona hospedada com o ID especificado. Será solicitada uma confirmação antes que o comando continue, a menos que você adicione o parâmetro de opção -Force.**
```
Remove-R53HostedZone -Id Z1PA6795UKMFR9
```
+ Para obter detalhes da API, consulte [DeleteHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-R53QueryLoggingConfig`
O código de exemplo a seguir mostra como usar `Remove-R53QueryLoggingConfig`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a configuração especificada para o registro de consultas ao DNS.**
```
Remove-R53QueryLoggingConfig -Id ee528e95-4e03-4fdc-9d28-9e24daaa20063
```
+ Para obter detalhes da API, consulte [DeleteQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-R53ReusableDelegationSet`
O código de exemplo a seguir mostra como usar `Remove-R53ReusableDelegationSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o conjunto de delegações reutilizáveis especificado.**
```
Remove-R53ReusableDelegationSet -Id N23DS9X4AYAAAM
```
+ Para obter detalhes da API, consulte [DeleteReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-R53VPCFromHostedZone`
O código de exemplo a seguir mostra como usar `Unregister-R53VPCFromHostedZone`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo dissocia a VPC especificada da zona hospedada privada.**
```
Unregister-R53VPCFromHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**Saída**:
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C2XFCAAAA9HKZG PENDING 01/28/2020 10:35:55
```
+ Para obter detalhes da API, consulte [Disassociate VPCFrom HostedZone](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (*V5).
### `Update-R53HostedZoneComment`
O código de exemplo a seguir mostra como usar `Update-R53HostedZoneComment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando atualiza o comentário para a zona hospedada especificada.**
```
Update-R53HostedZoneComment -Id Z385PDS6AAAAAR -Comment "This is my first hosted zone"
```
**Saída**:
```
Id : /hostedzone/Z385PDS6AAAAAR
Name : example.com.
CallerReference : C5B55555-7147-EF04-8341-69131E805C89
Config : Amazon.Route53.Model.HostedZoneConfig
ResourceRecordSetCount : 9
LinkedService :
```
+ Para obter detalhes da API, consulte [UpdateHostedZoneComment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon S3 usando ferramentas para V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon S3.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Copy-S3Object`
O código de exemplo a seguir mostra como usar `Copy-S3Object`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando copia o objeto “sample.txt” do bucket “test-files” para o mesmo bucket, mas com uma nova chave de “sample-copy.txt”.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -DestinationKey sample-copy.txt
```
**Exemplo 2: este comando copia o objeto “sample.txt” do bucket “test-files” para o bucket “backup-files” com uma nova chave 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
```
**Exemplo 3: este comando baixa o objeto “sample.txt” do bucket “test-files” em um arquivo local com o nome “local-sample.txt”.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -LocalFile local-sample.txt
```
**Exemplo 4: um único objeto é baixado no arquivo especificado. O arquivo baixado encontra-se em c:\$1downloads\$1data\$1archive.zip**.
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key data/archive.zip -LocalFolder c:\downloads
```
**Exemplo 5: todos os objetos que correspondem ao prefixo de chave especificado são baixados na pasta local. A hierarquia relativa de chaves será preservada como subpastas no local geral do download.**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix data -LocalFolder c:\downloads
```
+ Para obter detalhes da API, consulte [CopyObject](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3Bucket`
O código de exemplo a seguir mostra como usar `Get-S3Bucket`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna todos os buckets do S3.**
```
Get-S3Bucket
```
**Exemplo 2: este comando retorna um bucket denominado “test-files”.**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [ListBuckets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketACL`
O código de exemplo a seguir mostra como usar `Get-S3BucketACL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando obtém os detalhes do proprietário do objeto do S3.**
```
(Get-S3BucketACL -BucketName 'amzn-s3-demo-bucket' -Select *).Owner
```
**Saída**:
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ Para obter detalhes da API, consulte [GetBucketAcl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketAccelerateConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3BucketAccelerateConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: se as configurações de aceleração de transferência estiverem habilitadas para o bucket especificado, este comando retornará o valor Habilitado.**
```
Get-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
Value
-----
Enabled
```
+ Para obter detalhes da API, consulte [GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketAnalyticsConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3BucketAnalyticsConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna os detalhes do filtro de análise com o nome “testfilter” no bucket do S3 em questão.**
```
Get-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ Para obter detalhes da API, consulte [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketAnalyticsConfigurationList`
O código de exemplo a seguir mostra como usar `Get-S3BucketAnalyticsConfigurationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna as cem primeiras análises do bucket do S3 em questão.**
```
Get-S3BucketAnalyticsConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketEncryption`
O código de exemplo a seguir mostra como usar `Get-S3BucketEncryption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna todas as regras de criptografia do lado do servidor associadas ao bucket em questão.**
```
Get-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketInventoryConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3BucketInventoryConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna os detalhes do inventário denominado “testinventory” para o bucket do S3 em questão.**
```
Get-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testinventory'
```
+ Para obter detalhes da API, consulte [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketInventoryConfigurationList`
O código de exemplo a seguir mostra como usar `Get-S3BucketInventoryConfigurationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna as cem primeiras configurações de inventário do bucket do S3 em questão.**
```
Get-S3BucketInventoryConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketLocation`
O código de exemplo a seguir mostra como usar `Get-S3BucketLocation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: se houver uma restrição, este comando retornará a restrição de localização do bucket “amzn-s3-demo-bucket”.**
```
Get-S3BucketLocation -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
Value
-----
ap-south-1
```
+ Para obter detalhes da API, consulte [GetBucketLocation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketLogging`
O código de exemplo a seguir mostra como usar `Get-S3BucketLogging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna o status de registro em log do bucket especificado.**
```
Get-S3BucketLogging -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
TargetBucketName Grants TargetPrefix
---------------- ------ ------------
testbucket1 {} testprefix
```
+ Para obter detalhes da API, consulte [GetBucketLogging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketMetricsConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3BucketMetricsConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna detalhes sobre o filtro de métricas denominado “testfilter” para o bucket do S3 em questão.**
```
Get-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testfilter'
```
+ Para obter detalhes da API, consulte [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketNotification`
O código de exemplo a seguir mostra como usar `Get-S3BucketNotification`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo recupera a configuração de notificação do bucket em questão.**
```
Get-S3BucketNotification -BucketName amzn-s3-demo-bucket | select -ExpandProperty TopicConfigurations
```
**Saída**:
```
Id Topic
-- -----
mimo arn:aws:sns:eu-west-1:123456789012:topic-1
```
+ Para obter detalhes da API, consulte [GetBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketPolicy`
O código de exemplo a seguir mostra como usar `Get-S3BucketPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando gera a política de bucket associada ao bucket do S3 em questão.**
```
Get-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketPolicyStatus`
O código de exemplo a seguir mostra como usar `Get-S3BucketPolicyStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna o status da política do bucket do S3 em questão, indicando se o bucket é público.**
```
Get-S3BucketPolicyStatus -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketPolicyStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketReplication`
O código de exemplo a seguir mostra como usar `Get-S3BucketReplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna as informações da configuração de replicação definida no bucket denominado “amzn-s3-demo-bucket”.**
```
Get-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [GetBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketRequestPayment`
O código de exemplo a seguir mostra como usar `Get-S3BucketRequestPayment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna as informações da configuração de pagamento de solicitação do bucket denominado “amzn-s3-demo-bucket”. Por padrão, o proprietário do bucket paga pelos downloads feitos no bucket.**
```
Get-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [GetBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketTagging`
O código de exemplo a seguir mostra como usar `Get-S3BucketTagging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna todas as tags associadas ao bucket em questão.**
```
Get-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketVersioning`
O código de exemplo a seguir mostra como usar `Get-S3BucketVersioning`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna o status de versionamento referente ao bucket em questão.**
```
Get-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3BucketWebsite`
O código de exemplo a seguir mostra como usar `Get-S3BucketWebsite`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando retorna os detalhes das configurações do site estático do bucket do S3 em questão.**
```
Get-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3CORSConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3CORSConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando retorna um objeto que contém todas as regras de configuração do CORS correspondentes ao bucket do S3 em questão.**
```
Get-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket' -Select Configuration.Rules
```
**Saída**:
```
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 obter detalhes da API, consulte [Get CORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Get-S3HeadBucket`
O código de exemplo a seguir mostra como usar `Get-S3HeadBucket`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna a saída com o código de status HTTP 200 OK para o bucket existente quando o usuário tem permissão para acessá-lo. BucketArn o parâmetro só é compatível com buckets de diretório do S3**.
```
Get-S3HeadBucket -BucketName amzn-s3-demo-bucket
```
**Saída**:
```
AccessPointAlias : False
BucketArn :
BucketLocationName :
BucketLocationType :
BucketRegion : us-east-2
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 0
HttpStatusCode : OK
```
**Exemplo 2: Esse comando gera um erro com o código de status HTTP NotFound para um bucket inexistente.**
```
Get-S3HeadBucket -BucketName amzn-s3-non-existing-bucket
```
**Saída**:
```
Get-S3HeadBucket: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.
```
**Exemplo 3: esse comando gera um erro com o código de status HTTP Proibido para um bucket existente em que o usuário não tem permissão para acessá-lo.**
```
Get-S3HeadBucket -BucketName amzn-s3-no-access-bucket
```
**Saída**:
```
Get-S3HeadBucket: Error making request with Error Code Forbidden and Http Status Code Forbidden. No further error information was returned by the service.
```
+ Para obter detalhes da API, consulte [HeadBucket](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3LifecycleConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3LifecycleConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera a configuração do ciclo de vida do bucket.**
```
Get-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket
```
**Saída**:
```
Rules
-----
{Remove-in-150-days, Archive-to-Glacier-in-30-days}
```
+ Para obter detalhes da API, consulte [GetLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3Object`
O código de exemplo a seguir mostra como usar `Get-S3Object`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando recupera as informações sobre todos os itens no bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket
```
**Exemplo 2: este comando recupera as informações sobre o item “sample.txt” do bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**Exemplo 3: este comando recupera as informações sobre todos os itens com prefixo “sample” do bucket “test-files”.**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample
```
+ Para obter detalhes da API, consulte [ListObjects](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3ObjectACL`
O código de exemplo a seguir mostra como usar `Get-S3ObjectACL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando obtém os detalhes do proprietário do objeto do S3.**
```
(Get-S3ObjectACL -BucketName 'amzn-s3-demo-bucket' -key 'initialize.ps1' -Select *).Owner
```
**Saída**:
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ Para obter detalhes da API, consulte [GetObjectAcl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3ObjectLockConfiguration`
O código de exemplo a seguir mostra como usar `Get-S3ObjectLockConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: se a configuração do Bloqueio de Objetos estiver habilitada para o bucket do S3 em questão, este comando retornará o valor “Habilitado”.**
```
Get-S3ObjectLockConfiguration -BucketName 'amzn-s3-demo-bucket' -Select ObjectLockConfiguration.ObjectLockEnabled
```
**Saída**:
```
Value
-----
Enabled
```
+ Para obter detalhes da API, consulte [GetObjectLockConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3ObjectMetadata`
O código de exemplo a seguir mostra como usar `Get-S3ObjectMetadata`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna os metadados do objeto com a chave 'ListTrusts.txt' no bucket S3 fornecido.**
```
Get-S3ObjectMetadata -BucketName 'amzn-s3-demo-bucket' -Key 'ListTrusts.txt'
```
**Saída**:
```
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 obter detalhes da API, consulte [GetObjectMetadata](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3ObjectRetention`
O código de exemplo a seguir mostra como usar `Get-S3ObjectRetention`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando retorna o modo e a data até a qual o objeto ficará retido.**
```
Get-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt'
```
+ Para obter detalhes da API, consulte [GetObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3ObjectTagSet`
O código de exemplo a seguir mostra como usar `Get-S3ObjectTagSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o exemplo retorna as tags associadas ao objeto presente no bucket do S3 em questão.**
```
Get-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
Key Value
--- -----
test value
```
+ Para obter detalhes da API, consulte [GetObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3PreSignedURL`
O código de exemplo a seguir mostra como usar `Get-S3PreSignedURL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando retorna um URL pré-assinado para uma chave especificada e uma data de validade.**
```
Get-S3PreSignedURL -BucketName 'amzn-s3-demo-bucket' -Key 'testkey' -Expires '2023-11-16'
```
**Exemplo 2: o comando retorna um URL pré-assinado para um bucket de diretório com a chave especificada e uma data de validade.**
```
[Amazon.AWSConfigsS3]::UseSignatureVersion4 = $true
Get-S3PreSignedURL -BucketName amzn-s3-demo-bucket--usw2-az1--x-s3 -Key 'testkey' -Expire '2023-11-17'
```
+ Para obter detalhes da API, consulte [GetPreSignedURL](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência do Ferramentas da AWS para PowerShell Cmdlet (V5)*.
### `Get-S3PublicAccessBlock`
O código de exemplo a seguir mostra como usar `Get-S3PublicAccessBlock`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando retorna a configuração do Bloqueio de Acesso Público do bucket do S3 em questão.**
```
Get-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [GetPublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-S3Version`
O código de exemplo a seguir mostra como usar `Get-S3Version`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando retorna os metadados sobre todas as versões dos objetos no bucket do S3 em questão.**
```
Get-S3Version -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
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 obter detalhes da API, consulte [ListVersions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-S3Bucket`
O código de exemplo a seguir mostra como usar `New-S3Bucket`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando cria um bucket privado chamado “sample-bucket”.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket
```
**Exemplo 2: esse comando cria um bucket chamado “sample-bucket” com permissões de leitura e gravação.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadWrite
```
**Exemplo 3: esse comando cria um novo bucket chamado “sample-bucket” com permissões somente de leitura.**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadOnly
```
**Exemplo 4: Esse comando cria um novo bucket de diretório chamado “amzn-s3-demo-bucket--use1-az5--x-s3" com. 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 obter detalhes da API, consulte [PutBucket](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Read-S3Object`
O código de exemplo a seguir mostra como usar `Read-S3Object`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando recupera o item "sample.txt" do bucket “amzn-s3-demo-bucket” e o salva em um arquivo chamado "local-sample.txt" no local atual. O arquivo “local-sample.txt” não precisa existir antes de esse comando ser chamado.**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -File local-sample.txt
```
**Exemplo 2: Esse comando recupera o diretório virtual “DIR” do bucket “amzn-s3-demo-bucket” e o salva em uma pasta chamada “Local-dir” no local atual. O arquivo “Local-DIR” não precisa existir antes de esse comando ser chamado.**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix DIR -Folder Local-DIR
```
**Exemplo 3: baixa todos os objetos com chaves terminadas em “.json” de buckets com “config” no respectivo nome em arquivos na pasta especificada. As chaves do objeto são usadas para definir o nome dos arquivos.**
```
Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
```
+ Para obter detalhes da API, consulte [GetObject](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3Bucket`
O código de exemplo a seguir mostra como usar `Remove-S3Bucket`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando remove todos os objetos e versões de objetos do bucket “test-files” e, em seguida, exclui o bucket. O comando solicitará a confirmação antes de continuar. Adicione a opção -Force para ignorar a confirmação. Observe que os buckets que não estão vazios não podem ser excluídos.**
```
Remove-S3Bucket -BucketName amzn-s3-demo-bucket -DeleteBucketContent
```
+ Para obter detalhes da API, consulte [DeleteBucket](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketAnalyticsConfiguration`
O código de exemplo a seguir mostra como usar `Remove-S3BucketAnalyticsConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando remove o filtro de análise com o nome “testfilter” no bucket do S3 em questão.**
```
Remove-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ Para obter detalhes da API, consulte [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketEncryption`
O código de exemplo a seguir mostra como usar `Remove-S3BucketEncryption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: isso desabilita a criptografia habilitada para o bucket do S3 fornecido.**
```
Remove-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketInventoryConfiguration`
O código de exemplo a seguir mostra como usar `Remove-S3BucketInventoryConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando remove o inventário chamado 'testInventoryName' correspondente ao determinado bucket do S3.**
```
Remove-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testInventoryName'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketMetricsConfiguration`
O código de exemplo a seguir mostra como usar `Remove-S3BucketMetricsConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando remove o filtro de métricas com o nome “testmetrics” no bucket do S3 em questão.**
```
Remove-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testmetrics'
```
+ Para obter detalhes da API, consulte [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketPolicy`
O código de exemplo a seguir mostra como usar `Remove-S3BucketPolicy`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando remove a política de bucket associada ao bucket do S3 em questão.**
```
Remove-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [DeleteBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketReplication`
O código de exemplo a seguir mostra como usar `Remove-S3BucketReplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: exclui a configuração de replicação associada ao bucket denominado “amzn-s3-demo-bucket”. Observe que essa operação requer permissão para a DeleteReplicationConfiguration ação s3:. Será solicitada uma confirmação antes que a operação continue. Para ignorar a confirmação, use a opção -Force.**
```
Remove-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [DeleteBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketTagging`
O código de exemplo a seguir mostra como usar `Remove-S3BucketTagging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando remove todas as tags associadas ao bucket do S3 em questão.**
```
Remove-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3BucketWebsite`
O código de exemplo a seguir mostra como usar `Remove-S3BucketWebsite`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando desabilita a propriedade de hospedagem de site estático do bucket do S3 em questão.**
```
Remove-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3CORSConfiguration`
O código de exemplo a seguir mostra como usar `Remove-S3CORSConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando remove a configuração CORS do bucket do S3 em questão.**
```
Remove-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**Saída**:
```
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 obter detalhes da API, consulte [Excluir CORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) na *referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3LifecycleConfiguration`
O código de exemplo a seguir mostra como usar `Remove-S3LifecycleConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando remove todas as regras do ciclo de vida do bucket do S3 em questão.**
```
Remove-S3LifecycleConfiguration -BucketName 'amzn-s3-demo-bucket'
```
+ Para obter detalhes da API, consulte [DeleteLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3MultipartUpload`
O código de exemplo a seguir mostra como usar `Remove-S3MultipartUpload`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando interrompe os carregamentos fracionados criados há mais de cinco dias.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -DaysBefore 5
```
**Exemplo 2: este comando interrompe os carregamentos fracionados criados antes de 2 de janeiro de 2014.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "Thursday, January 02, 2014"
```
**Exemplo 3: este comando interrompe os carregamentos fracionados criados antes de 2 de janeiro de 2014, às 10:45:37.**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "2014/01/02 10:45:37"
```
+ Para obter detalhes da API, consulte [AbortMultipartUpload](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3Object`
O código de exemplo a seguir mostra como usar `Remove-S3Object`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando remove o objeto “sample.txt” do bucket “test-files”. Será solicitada uma confirmação antes que o comando seja executado. Para ignorar a solicitação, use a opção -Force.**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**Exemplo 2: este comando remove a versão especificada do objeto “sample.txt” do bucket “test-files”, supondo que o bucket tenha sido configurado para habilitar versões de objetos.**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt
```
**Exemplo 3: este comando remove objetos “sample1.txt”, “sample2.txt” e “sample3.txt” do bucket “test-files” como uma operação em lote única. A resposta do serviço listará todas as chaves processadas, independentemente do status de êxito ou erro da exclusão. Para obter somente erros para chaves que não puderam ser processadas pelo serviço, adicione o ReportErrorsOnly parâmetro - (esse parâmetro também pode ser especificado com o alias -Quiet).**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )
```
**Exemplo 4: Este exemplo usa uma expressão embutida com o KeyCollection parâmetro - para obter as chaves dos objetos a serem excluídos. Get-S3Objectretorna uma coleção de instâncias Amazon.S3.Model.S3Object, cada uma com um membro-chave do tipo string identificando o objeto**.
```
Remove-S3Object -bucketname "amzn-s3-demo-bucket" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)
```
**Exemplo 5: este exemplo obtém todos os objetos que têm um prefixo de chave “prefix/subprefix” no bucket e os exclui. Observe que os objetos de entrada são processados um de cada vez. Para coleções grandes, considere passar a coleção para o parâmetro - InputObject (alias -S3ObjectCollection) do cmdlet para permitir que a exclusão ocorra como um lote com uma única chamada para o serviço.**
```
Get-S3Object -BucketName "amzn-s3-demo-bucket" -KeyPrefix "prefix/subprefix" | Remove-S3Object -Force
```
**Exemplo 6: Este exemplo envia uma coleção de ObjectVersion instâncias do Amazon.S3.Model.S3 que representam marcadores de exclusão para o cmdlet para exclusão. Observe que os objetos de entrada são processados um de cada vez. Para coleções grandes, considere passar a coleção para o parâmetro - InputObject (alias -S3ObjectCollection) do cmdlet para permitir que a exclusão ocorra como um lote com uma única chamada para o serviço.**
```
(Get-S3Version -BucketName "amzn-s3-demo-bucket").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-S3Object -Force
```
**Exemplo 7: Esse script mostra como realizar uma exclusão em lote de um conjunto de objetos (nesse caso, marcadores de exclusão) construindo uma matriz de objetos a serem usados com o 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 obter detalhes da API, consulte [DeleteObjects](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3ObjectTagSet`
O código de exemplo a seguir mostra como usar `Remove-S3ObjectTagSet`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando remove todas as tags associadas ao objeto com a chave “testfile.txt” no bucket do S3 em questão.**
```
Remove-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket' -Select '^Key'
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-S3PublicAccessBlock`
O código de exemplo a seguir mostra como usar `Remove-S3PublicAccessBlock`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando desativa a configuração do Bloqueio de Acesso Público do bucket em questão.**
```
Remove-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket' -Force -Select '^BucketName'
```
**Saída**:
```
amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [DeletePublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-S3BucketEncryption`
O código de exemplo a seguir mostra como usar `Set-S3BucketEncryption`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando ativa a criptografia padrão AES256 do lado do servidor com as chaves gerenciadas do Amazon S3 (SSE-S3) no bucket especificado.**
```
$Encryptionconfig = @{ServerSideEncryptionByDefault = @{ServerSideEncryptionAlgorithm = "AES256"}}
Set-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket' -ServerSideEncryptionConfiguration_ServerSideEncryptionRule $Encryptionconfig
```
+ Para obter detalhes da API, consulte [PutBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Test-S3Bucket`
O código de exemplo a seguir mostra como usar `Test-S3Bucket`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando retornará True se o bucket existir, caso contrário, False. O comando retornará True mesmo que o bucket não pertença ao usuário.**
```
Test-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ Para obter detalhes da API, consulte [Test-S3Bucket](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketAccelerateConfiguration`
O código de exemplo a seguir mostra como usar `Write-S3BucketAccelerateConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando habilita a aceleração de transferência do bucket do S3 em questão.**
```
$statusVal = New-Object Amazon.S3.BucketAccelerateStatus('Enabled')
Write-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket' -AccelerateConfiguration_Status $statusVal
```
+ Para obter detalhes da API, consulte [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketNotification`
O código de exemplo a seguir mostra como usar `Write-S3BucketNotification`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo configura a configuração do tópico do SNS para o evento do S3 ObjectRemovedDelete e ativa a notificação para o determinado bucket do s3**
```
$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
```
**Exemplo 2: Este exemplo habilita notificações ObjectCreatedAll para o determinado bucket, enviando-o para a função 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
```
**Exemplo 3: este exemplo cria duas configurações diferentes do Lambda com base em diferentes sufixos de chave e configura ambas em um único 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 obter detalhes da API, consulte [PutBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketReplication`
O código de exemplo a seguir mostra como usar `Write-S3BucketReplication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo define uma configuração de replicação com uma única regra que permite a replicação para o bucket 'amzn-s3-demo-bucket' de qualquer novo objeto criado com o prefixo de nome de chave "" no bucket '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
```
**Exemplo 2: Este exemplo define uma configuração de replicação com várias regras que permitem a replicação para o bucket 'amzn-s3-demo-bucket' de qualquer novo objeto criado com o prefixo de nome de chave "" ou "“. TaxDocs OtherDocs Os prefixos de chave não devem se sobrepor.**
```
$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
```
**Exemplo 3: Este exemplo atualiza a configuração de replicação no bucket especificado para desativar a regra que controla a replicação de objetos com o prefixo de nome de chave "TaxDocs" no bucket 'amzn-s3-demo-bucket'.**
```
$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 obter detalhes da API, consulte [PutBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketRequestPayment`
O código de exemplo a seguir mostra como usar `Write-S3BucketRequestPayment`.
**Ferramentas para PowerShell V5**
**Exemplo 1: atualiza a configuração de pagamento de solicitação do bucket denominado “amzn-s3-demo-bucket” para que a pessoa que está solicitando downloads pelo bucket seja cobrada pelo download. Por padrão, o proprietário do bucket paga pelos downloads. Para definir o pagamento da solicitação de volta ao padrão, use 'BucketOwner' para o parâmetro RequestPaymentConfiguration \$1Payer.**
```
Write-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket -RequestPaymentConfiguration_Payer Requester
```
+ Para obter detalhes da API, consulte [PutBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketTagging`
O código de exemplo a seguir mostra como usar `Write-S3BucketTagging`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando aplica duas tags a um bucket denominado `cloudtrail-test-2018` (uma tag com uma chave de Stage e um valor de Test e uma tag com uma chave de Environment e um valor de Alpha). Para verificar se as tags foram adicionadas ao bucket, execute `Get-S3BucketTagging -BucketName bucket_name`. Os resultados devem mostrar as tags que você aplicou ao bucket no primeiro comando. Observe que `Write-S3BucketTagging` substitui todo o conjunto de tags existente em um bucket. Para adicionar ou excluir tags individuais, execute os cmdlets da API de grupos de recursos e marcação: `Add-RGTResourceTag` e `Remove-RGTResourceTag`. Como alternativa, use o Editor de tags no console AWS de gerenciamento para gerenciar as tags de bucket do S3.**
```
Write-S3BucketTagging -BucketName amzn-s3-demo-bucket -TagSet @( @{ Key="Stage"; Value="Test" }, @{ Key="Environment"; Value="Alpha" } )
```
**Exemplo 2: este comando envia um bucket denominado `cloudtrail-test-2018` para o cmdlet `Write-S3BucketTagging`. Ele aplica as tags Stage:Production e Department:Finance ao bucket. Observe que `Write-S3BucketTagging` substitui todo o conjunto de tags existente em um bucket.**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket | Write-S3BucketTagging -TagSet @( @{ Key="Stage"; Value="Production" }, @{ Key="Department"; Value="Finance" } )
```
+ Para obter detalhes da API, consulte [PutBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketVersioning`
O código de exemplo a seguir mostra como usar `Write-S3BucketVersioning`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando habilita o versionamento do bucket do S3 em questão.**
```
Write-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket' -VersioningConfig_Status Enabled
```
+ Para obter detalhes da API, consulte [PutBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3BucketWebsite`
O código de exemplo a seguir mostra como usar `Write-S3BucketWebsite`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando habilita a hospedagem de sites para o bucket em questão com o documento de índice como “index.html” e o documento de erro como “error.html”.**
```
Write-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket' -WebsiteConfiguration_IndexDocumentSuffix 'index.html' -WebsiteConfiguration_ErrorDocument 'error.html'
```
+ Para obter detalhes da API, consulte [PutBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3LifecycleConfiguration`
O código de exemplo a seguir mostra como usar `Write-S3LifecycleConfiguration`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo grava/substitui a configuração fornecida no \$1NewRule. Essa configuração garante limitar os objetos do escopo com determinados valores de prefixo e tag.**
```
$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
```
**Exemplo 2: Este exemplo define várias regras com filtragem. \$1 ArchiveRule define os objetos a serem arquivados em 30 dias no Glacier e 120 no. DeepArchive \$1 ExpireRule expira as versões atual e anterior em 150 dias para objetos com prefixo 'py' e tag:key 'archieved' definida como 'sim'**.
```
$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 obter detalhes da API, consulte [PutLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3Object`
O código de exemplo a seguir mostra como usar `Write-S3Object`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este comando carrega o arquivo único “local-sample.txt” no Amazon S3, criando um objeto com a chave “sample.txt” no bucket “test-files”.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -File .\local-sample.txt
```
**Exemplo 2: este comando carrega o arquivo único “sample.txt” no Amazon S3, criando um objeto com a chave “sample.txt” no bucket “test-files”. Quando o parâmetro -Key não é fornecido, usa-se o nome do arquivo como chave do objeto do S3.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File .\sample.txt
```
**Exemplo 3: Esse comando carrega o arquivo único "local-sample.txt" para o Amazon S3, criando um objeto com a chave prefix/to/sample ".txt” no bucket “test-files”.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "prefix/to/sample.txt" -File .\local-sample.txt
```
**Exemplo 4: Esse comando carrega todos os arquivos no subdiretório “Scripts” para o bucket “test-files” e aplica o prefixo de chave comum "" a cada objeto. SampleScripts Cada arquivo enviado terá uma chave de "SampleScripts/filename", onde 'filename' varia.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\
```
**Exemplo 5: Esse comando carrega todos os arquivos\$1.ps1 no diretório local “Scripts” para o bucket “test-files” e aplica o prefixo de chave comum "" a cada objeto. SampleScripts Cada arquivo enviado terá uma chave de "SampleScripts/filename.ps1", onde 'filename' varia.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\ -SearchPattern *.ps1
```
**Exemplo 6: este comando cria um objeto do S3 contendo a string de conteúdo especificada com a chave “sample.txt”.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -Content "object contents"
```
**Exemplo 7: este comando carrega o arquivo especificado (o nome do arquivo é usado como chave) e aplica as tags especificadas ao novo objeto.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File "sample.txt" -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
**Exemplo 8: este comando carrega recursivamente a pasta especificada e aplica as tags especificadas a todos os novos objetos.**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder . -KeyPrefix "TaggedFiles" -Recurse -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
+ Para obter detalhes da API, consulte [PutObject](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-S3ObjectRetention`
O código de exemplo a seguir mostra como usar `Write-S3ObjectRetention`.
**Ferramentas para PowerShell V5**
**Exemplo 1: o comando habilita o modo de retenção de governança até a data “31st Dec 2019 00:00:00” para o objeto “testfile.txt” no bucket do S3 em questão.**
```
Write-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt' -Retention_Mode GOVERNANCE -Retention_RetainUntilDate "2019-12-31T00:00:00"
```
+ Para obter detalhes da API, consulte [PutObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos de CSPM do Security Hub usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Security Hub CSPM.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-SHUBFinding`
O código de exemplo a seguir mostra como usar `Get-SHUBFinding`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando recupera as descobertas do Security Hub do serviço 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
```
**Exemplo 2: Esse comando recupera as descobertas do Security Hub da ID da AWS conta 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
```
**Exemplo 3: esse comando recupera as descobertas do Security Hub geradas para o padrão “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
```
**Exemplo 4: esse comando recupera descobertas com gravidade crítica do Security Hub que têm um status de fluxo de trabalho de 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 obter detalhes da API, consulte [GetFindings](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon SES usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon SES.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Get-SESIdentity`
O código de exemplo a seguir mostra como usar `Get-SESIdentity`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse comando retorna uma lista contendo todas as identidades (endereços de e-mail e domínios) de uma AWS conta específica, independentemente do status da verificação.**
```
Get-SESIdentity
```
+ Para obter detalhes da API, consulte [ListIdentities](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SESSendQuota`
O código de exemplo a seguir mostra como usar `Get-SESSendQuota`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando retorna os limites de envio atuais do usuário.**
```
Get-SESSendQuota
```
+ Para obter detalhes da API, consulte [GetSendQuota](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SESSendStatistic`
O código de exemplo a seguir mostra como usar `Get-SESSendStatistic`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando retorna as estatísticas de envio do usuário. O resultado é uma lista de pontos de dados que representa as duas últimas semanas de atividades de envio. Cada ponto de dados na lista contém estatísticas para um intervalo de 15 minutos.**
```
Get-SESSendStatistic
```
+ Para obter detalhes da API, consulte [GetSendStatistics](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos da API v2 do Amazon SES usando ferramentas para PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a Ferramentas da AWS para PowerShell V5 com a API v2 do Amazon SES.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Send-SES2Email`
O código de exemplo a seguir mostra como usar `Send-SES2Email`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra como enviar uma mensagem de e-mail padrão.**
```
Send-SES2Email -FromEmailAddress "sender@example.com" -Destination_ToAddress "recipient@example.com" -Subject_Data "Email Subject" -Text_Data "Email Body"
```
+ Para obter detalhes da API, consulte [SendEmail](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon SNS usando ferramentas para V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon SNS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Publish-SNSMessage`
O código de exemplo a seguir mostra como usar `Publish-SNSMessage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo mostra a publicação de uma mensagem com uma única MessageAttribute declaração em linha.**
```
Publish-SNSMessage -TopicArn "arn:aws:sns:us-west-2:123456789012:my-topic" -Message "Hello" -MessageAttribute @{'City'=[Amazon.SimpleNotificationService.Model.MessageAttributeValue]@{DataType='String'; StringValue ='AnyCity'}}
```
**Exemplo 2: Este exemplo mostra a publicação de uma mensagem com várias MessageAttributes declaradas com antecedência.**
```
$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
```
+ Consulte detalhes da API em [Publish](https://docs.aws.amazon.com/powershell/v5/reference) na *Referência de cmdlet do Ferramentas da AWS para PowerShell (V5)*.
# Exemplos do Amazon SQS usando o Tools for V5 PowerShell
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon SQS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-SQSPermission`
O código de exemplo a seguir mostra como usar `Add-SQSPermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo permite que Conta da AWS o especificado envie mensagens da fila especificada.**
```
Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [AddPermission](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Clear-SQSQueue`
O código de exemplo a seguir mostra como usar `Clear-SQSQueue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui todas as mensagens da fila especificada.**
```
Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [PurgeQueue](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-SQSMessageVisibility`
O código de exemplo a seguir mostra como usar `Edit-SQSMessageVisibility`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o tempo limite de visibilidade da mensagem com o identificador de recebimento especificado na fila especificada para 10 horas (1 hora x 60 minutos x 60 segundos = 36.000 segundos).**
```
Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000
```
+ Para obter detalhes da API, consulte [ChangeMessageVisibility](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-SQSMessageVisibilityBatch`
O código de exemplo a seguir mostra como usar `Edit-SQSMessageVisibilityBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o tempo limite de visibilidade para duas mensagens com os identificadores de recebimento especificados na fila especificada. O tempo limite de visibilidade da primeira mensagem é alterado para 10 horas (10 horas x 60 minutos x 60 segundos = 36.000 segundos). O tempo limite de visibilidade da segunda mensagem é alterado para 5 horas (5 horas x 60 minutos x 60 segundos = 18.000 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
```
**Saída**:
```
Failed Successful
------ ----------
{} {Request2, Request1}
```
+ Para obter detalhes da API, consulte [ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SQSDeadLetterSourceQueue`
O código de exemplo a seguir mostra como usar `Get-SQSDeadLetterSourceQueue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista todas URLs as filas que dependem da fila especificada como fila de letras mortas.**
```
Get-SQSDeadLetterSourceQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
**Saída**:
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
```
+ Para obter detalhes da API, consulte [ListDeadLetterSourceQueues](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SQSQueue`
O código de exemplo a seguir mostra como usar `Get-SQSQueue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as filas.**
```
Get-SQSQueue
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo lista qualquer fila que comece com o nome especificado.**
```
Get-SQSQueue -QueueNamePrefix My
```
**Saída**:
```
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 obter detalhes da API, consulte [ListQueues](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SQSQueueAttribute`
O código de exemplo a seguir mostra como usar `Get-SQSQueueAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os atributos da fila especificada.**
```
Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Saída**:
```
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]...}
```
**Exemplo 2: esse exemplo lista separadamente somente os atributos especificados da fila especificada.**
```
Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Saída**:
```
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 obter detalhes da API, consulte [GetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SQSQueueUrl`
O código de exemplo a seguir mostra como usar `Get-SQSQueueUrl`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista o URL da fila com o nome especificado.**
```
Get-SQSQueueUrl -QueueName MyQueue
```
**Saída**:
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [GetQueueUrl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SQSQueue`
O código de exemplo a seguir mostra como usar `New-SQSQueue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma fila com o nome especificado.**
```
New-SQSQueue -QueueName MyQueue
```
**Saída**:
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [CreateQueue](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Receive-SQSMessage`
O código de exemplo a seguir mostra como usar `Receive-SQSMessage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as informações de até as próximas 10 mensagens a serem recebidas na fila especificada. As informações conterão valores para os atributos de mensagem especificados, se existirem.**
```
Receive-SQSMessage -AttributeName SenderId, SentTimestamp -MessageAttributeName StudentName, StudentGrade -MessageCount 10 -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**Saída**:
```
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 obter detalhes da API, consulte [ReceiveMessage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SQSMessage`
O código de exemplo a seguir mostra como usar `Remove-SQSMessage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a mensagem com os identificadores de recebimento especificados na fila especificada.**
```
Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q==
```
+ Para obter detalhes da API, consulte [DeleteMessage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SQSMessageBatch`
O código de exemplo a seguir mostra como usar `Remove-SQSMessageBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui duas mensagens com os identificadores de recebimento especificados na fila 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
```
**Saída**:
```
Failed Successful
------ ----------
{} {Request1, Request2}
```
+ Para obter detalhes da API, consulte [DeleteMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SQSPermission`
O código de exemplo a seguir mostra como usar `Remove-SQSPermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove as configurações permissão com o rótulo especificado da fila especificada.**
```
Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SQSQueue`
O código de exemplo a seguir mostra como usar `Remove-SQSQueue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a fila especificada.**
```
Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [DeleteQueue](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Send-SQSMessage`
O código de exemplo a seguir mostra como usar `Send-SQSMessage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo envia uma mensagem com os atributos e o corpo da mensagem especificados para a fila especificada com a entrega da mensagem atrasada por 10 segundos.**
```
$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
```
**Saída**:
```
MD5OfMessageAttributes MD5OfMessageBody MessageId
---------------------- ---------------- ---------
1d3e51347bc042efbdf6dda31EXAMPLE 51b0a3256d59467f973009b73EXAMPLE c35fed8f-c739-4d0c-818b-1820eEXAMPLE
```
+ Para obter detalhes da API, consulte [SendMessage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Send-SQSMessageBatch`
O código de exemplo a seguir mostra como usar `Send-SQSMessageBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo envia duas mensagens com os atributos especificados e corpos de mensagem para a fila especificada. A entrega é adiada por 15 segundos para a primeira mensagem e 10 segundos para a segunda mensagem.**
```
$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
```
**Saída**:
```
Failed Successful
------ ----------
{} {FirstMessage, SecondMessage}
```
+ Para obter detalhes da API, consulte [SendMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Set-SQSQueueAttribute`
O código de exemplo a seguir mostra como usar `Set-SQSQueueAttribute`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra como definir uma política para assinar um tópico do SNS com uma fila. Quando uma mensagem é publicada no tópico, ela é enviada à fila assinada.**
```
# 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 }
```
**Exemplo 2: esse exemplo define os atributos especificados da fila especificada.**
```
Set-SQSQueueAttribute -Attribute @{"DelaySeconds" = "10"; "MaximumMessageSize" = "131072"} -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ Para obter detalhes da API, consulte [SetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS STS exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS STS.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Convert-STSAuthorizationMessage`
O código de exemplo a seguir mostra como usar `Convert-STSAuthorizationMessage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: decodifica as informações adicionais contidas no conteúdo da mensagem codificada fornecida que foi retornada em resposta a uma solicitação. As informações adicionais são codificadas porque os detalhes do status da autorização podem constituir informações privilegiadas que o usuário responsável por solicitar a ação não deve ver.**
```
Convert-STSAuthorizationMessage -EncodedMessage "...encoded message..."
```
+ Para obter detalhes da API, consulte [DecodeAuthorizationMessage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-STSFederationToken`
O código de exemplo a seguir mostra como usar `Get-STSFederationToken`.
**Ferramentas para PowerShell V5**
**Exemplo 1: solicita um token federado válido por uma hora usando "Bob" como nome do usuário federado. Esse nome pode ser usado para referenciar o nome do usuário federado em uma política baseada em recursos (como uma política de bucket do Amazon S3). A política do IAM fornecida, no formato JSON, é usada para definir o escopo das permissões que estão disponíveis para o usuário do IAM. A política fornecida não pode conceder mais permissões do que as concedidas ao usuário solicitante, com as permissões finais do usuário federado sendo o conjunto mais restritivo com base na interseção da política aprovada com a política de usuário do IAM.**
```
Get-STSFederationToken -Name "Bob" -Policy "...JSON policy..." -DurationInSeconds 3600
```
+ Para obter detalhes da API, consulte [GetFederationToken](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-STSSessionToken`
O código de exemplo a seguir mostra como usar `Get-STSSessionToken`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna uma instância `Amazon.RuntimeAWSCredentials` contendo credenciais temporárias válidas por um determinado período. As credenciais usadas para solicitar credenciais temporárias são inferidas dos padrões atuais do shell. Para especificar outras credenciais, use os parâmetros - ProfileName ou - AccessKey /-SecretKey .**
```
Get-STSSessionToken
```
**Saída**:
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**Exemplo 2: retorna uma instância `Amazon.RuntimeAWSCredentials` contendo credenciais temporárias válidas por uma hora. As credenciais usadas para fazer a solicitação são obtidas do perfil especificado.**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile
```
**Saída**:
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**Exemplo 3: retorna uma instância `Amazon.RuntimeAWSCredentials` contendo credenciais temporárias válidas por uma hora usando o número de identificação do dispositivo de MFA associado à conta cujas credenciais estão especificadas no perfil 'myprofilename' e o valor fornecido pelo dispositivo.**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile -SerialNumber YourMFADeviceSerialNumber -TokenCode 123456
```
**Saída**:
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
+ Para obter detalhes da API, consulte [GetSessionToken](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Use-STSRole`
O código de exemplo a seguir mostra como usar `Use-STSRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna um conjunto de credenciais temporárias (chave de acesso, chave secreta e token de sessão) que podem ser usadas por uma hora para acessar AWS recursos aos quais o usuário solicitante normalmente não teria acesso. As credenciais retornadas têm as permissões permitidas pela política de acesso do perfil assumido e pela política fornecida (não é possível usar a política fornecida para conceder permissões além das definidas pela política de acesso do perfil que está sendo assumido).**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -Policy "...JSON policy..." -DurationInSeconds 3600
```
**Exemplo 2: retorna um conjunto de credenciais temporárias, válidas por uma hora, que têm as mesmas permissões definidas na política de acesso do perfil que está sendo assumido.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600
```
**Exemplo 3: retorna um conjunto de credenciais temporárias que fornecem o número de série e o token gerado de uma MFA associada às credenciais do usuário usadas para executar o cmdlet.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -SerialNumber "GAHT12345678" -TokenCode "123456"
```
**Exemplo 4: retorna um conjunto de credenciais temporárias que assumiram um perfil definido em uma conta de cliente. Para cada função que o terceiro possa assumir, a conta do cliente deve criar uma função usando um identificador que deve ser passado no ExternalId parâmetro - sempre que a função for assumida.**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -ExternalId "ABC123"
```
+ Para obter detalhes da API, consulte [AssumeRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Use-STSWebIdentityRole`
O código de exemplo a seguir mostra como usar `Use-STSWebIdentityRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna um conjunto temporário de credenciais, válido por uma hora, para um usuário que foi autenticado com o provedor de identidade Login with Amazon. As credenciais assumem a política de acesso associada ao perfil identificado pelo ARN do perfil. Opcionalmente, você pode transmitir uma política JSON ao parâmetro -Policy que refina ainda mais as permissões de acesso (não é possível conceder mais permissões do que as disponíveis nas permissões associadas ao perfil). O valor fornecido ao - WebIdentityToken é o identificador de usuário exclusivo que foi retornado pelo provedor de identidade.**
```
Use-STSWebIdentityRole -DurationInSeconds 3600 -ProviderId "www.amazon.com" -RoleSessionName "app1" -RoleArn "arn:aws:iam::123456789012:role/FederatedWebIdentityRole" -WebIdentityToken "Atza...DVI0r1"
```
+ Para obter detalhes da API, consulte [AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Suporte exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Suporte.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-ASACommunicationToCase`
O código de exemplo a seguir mostra como usar `Add-ASACommunicationToCase`.
**Ferramentas para PowerShell V5**
**Exemplo 1: adiciona o corpo de uma comunicação por e-mail ao caso especificado.**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"
```
**Exemplo 2: adiciona o corpo de uma comunicação por e-mail ao caso especificado mais um ou mais endereços de e-mail contidos na linha CC do e-mail.**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
```
+ Para obter detalhes da API, consulte [AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASACase`
O código de exemplo a seguir mostra como usar `Get-ASACase`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os detalhes de todos os casos de suporte.**
```
Get-ASACase
```
**Exemplo 2: retorna os detalhes de todos os casos de suporte desde a data e a hora especificadas.**
```
Get-ASACase -AfterTime "2013-09-10T03:06Z"
```
**Exemplo 3: retorna os detalhes dos primeiros 10 casos de suporte, incluindo aqueles que foram resolvidos.**
```
Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
```
**Exemplo 4: retorna os detalhes do único caso de suporte especificado.**
```
Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**Exemplo 5: retorna os detalhes dos casos de suporte especificados.**
```
Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
```
+ Para obter detalhes da API, consulte [DescribeCases](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASACommunication`
O código de exemplo a seguir mostra como usar `Get-ASACommunication`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todas as comunicações do caso especificado.**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**Exemplo 2: retorna todas as comunicações desde a meia-noite UTC de 1.º de janeiro de 2012 para o caso especificado.**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ Para obter detalhes da API, consulte [DescribeCommunications](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASAService`
O código de exemplo a seguir mostra como usar `Get-ASAService`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna todos os códigos de serviço, nomes e categorias disponíveis.**
```
Get-ASAService
```
**Exemplo 2: retorna o nome e as categorias do serviço com o código especificado.**
```
Get-ASAService -ServiceCodeList "amazon-cloudfront"
```
**Exemplo 3: retorna o nome e as categorias dos códigos de serviço especificados.**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")
```
**Exemplo 4: retorna o nome e as categorias (em japonês) dos códigos de serviço especificados. Atualmente, os códigos de idioma inglês (“en”) e japonês (“ja”) são compatíveis.**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
```
+ Para obter detalhes da API, consulte [DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASASeverityLevel`
O código de exemplo a seguir mostra como usar `Get-ASASeverityLevel`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Retorna a lista de níveis de severidade que podem ser atribuídos a um caso de AWS Support.**
```
Get-ASASeverityLevel
```
**Exemplo 2: Retorna a lista de níveis de severidade que podem ser atribuídos a um caso de AWS Support. Os nomes dos níveis são retornados em japonês.**
```
Get-ASASeverityLevel -Language "ja"
```
+ Para obter detalhes da API, consulte [DescribeSeverityLevels](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASATrustedAdvisorCheck`
O código de exemplo a seguir mostra como usar `Get-ASATrustedAdvisorCheck`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna a coleção de verificações do Trusted Advisor. Você deve especificar o parâmetro Language, que pode aceitar “en” para saída em inglês ou “ja” para saída em japonês.**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ Para obter detalhes da API, consulte [DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASATrustedAdvisorCheckRefreshStatus`
O código de exemplo a seguir mostra como usar `Get-ASATrustedAdvisorCheckRefreshStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o status atual das solicitações de atualização para as verificações especificadas. Solicitação - ASATrusted AdvisorCheckRefresh pode ser usada para solicitar que as informações de status das verificações sejam atualizadas.**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ Para obter detalhes da API, consulte [DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASATrustedAdvisorCheckResult`
O código de exemplo a seguir mostra como usar `Get-ASATrustedAdvisorCheckResult`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna os resultados de uma verificação do Trusted Advisor. A lista de verificações disponíveis do Trusted Advisor pode ser obtida usando Get- ASATrustedAdvisorChecks. A saída é o status geral da verificação, a data e hora em que a verificação foi executada pela última vez e o ID de verificação exclusivo da verificação específica. Para que os resultados sejam exibidos em japonês, adicione o parâmetro -Language “ja”.**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ Para obter detalhes da API, consulte [DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-ASATrustedAdvisorCheckSummary`
O código de exemplo a seguir mostra como usar `Get-ASATrustedAdvisorCheckSummary`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o resumo mais recente da verificação especificada do Trusted Advisor.**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**Exemplo 2: retorna os resumos mais recentes das verificações especificadas do Trusted Advisor.**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ Para obter detalhes da API, consulte [DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-ASACase`
O código de exemplo a seguir mostra como usar `New-ASACase`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Cria um novo caso no AWS Support Center. Os valores dos CategoryCode parâmetros - ServiceCode e - podem ser obtidos usando o Get-ASAService cmdlet. O valor do SeverityCode parâmetro - pode ser obtido usando o Get-ASASeverityLevel cmdlet. O valor do IssueType parâmetro - pode ser “atendimento ao cliente” ou “técnico”. Se for bem-sucedido, o número do caso de AWS Support será exibido. Por padrão, o caso será tratado em inglês. Para usar o japonês, adicione o parâmetro -Language “ja”. Os CommunicationBody parâmetros -ServiceCode, -CategoryCode, -Assunto e - são obrigatórios.**
```
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 obter detalhes da API, consulte [CreateCase](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Request-ASATrustedAdvisorCheckRefresh`
O código de exemplo a seguir mostra como usar `Request-ASATrustedAdvisorCheckRefresh`.
**Ferramentas para PowerShell V5**
**Exemplo 1: solicita uma atualização para a verificação especificada do Trusted Advisor.**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ Para obter detalhes da API, consulte [RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Resolve-ASACase`
O código de exemplo a seguir mostra como usar `Resolve-ASACase`.
**Ferramentas para PowerShell V5**
**Exemplo 1: retorna o estado inicial do caso especificado e o estado atual após a conclusão da chamada para resolvê-lo.**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ Para obter detalhes da API, consulte [ResolveCase](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Systems Manager usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com Systems Manager.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Add-SSMResourceTag`
O código de exemplo a seguir mostra como usar `Add-SSMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza uma janela de manutenção com novas tags. Não haverá saída se o comando for bem-sucedido. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$option1 = @{Key="Stack";Value=@("Production")}
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar cada tag. Não haverá saída se o comando for bem-sucedido.**
```
$tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag
$tag1.Key = "Stack"
$tag1.Value = "Production"
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1
```
+ Para obter detalhes da API, consulte [AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-SSMDocumentPermission`
O código de exemplo a seguir mostra como usar `Edit-SSMDocumentPermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona permissões de "compartilhamento" a todas as contas para um documento. Não haverá saída se o comando for bem-sucedido.**
```
Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all
```
**Exemplo 2: esse exemplo adiciona permissões de "compartilhamento" a uma conta específica para um documento. Não haverá saída se o comando for bem-sucedido.**
```
Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"
```
+ Para obter detalhes da API, consulte [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMActivation`
O código de exemplo a seguir mostra como usar `Get-SSMActivation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo fornece detalhes sobre as ativações em sua conta.**
```
Get-SSMActivation
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeActivations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAssociation`
O código de exemplo a seguir mostra como usar `Get-SSMAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve a associação entre uma instância e um documento.**
```
Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAssociationExecution`
O código de exemplo a seguir mostra como usar `Get-SSMAssociationExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna as execuções para o ID de associação fornecido**
```
Get-SSMAssociationExecution -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAssociationExecutionTarget`
O código de exemplo a seguir mostra como usar `Get-SSMAssociationExecutionTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe o ID do recurso e seu status de execução que fazem parte dos destinos de execução da associação**
```
Get-SSMAssociationExecutionTarget -AssociationId 123a45a0-c678-9012-3456-78901234db5e -ExecutionId 123a45a0-c678-9012-3456-78901234db5e | Select-Object ResourceId, Status
```
**Saída**:
```
ResourceId Status
---------- ------
i-0b1b2a3456f7a890b Success
i-01c12a45d6fc7a89f Success
i-0a1caf234f56d7dc8 Success
i-012a3fd45af6dbcfe Failed
i-0ddc1df23c4a5fb67 Success
```
**Exemplo 2: esse comando verifica a execução específica de uma automação específica desde ontem, onde documento de comandos está associado. Além disso, ele verifica se a execução da associação falhou e, em caso afirmativo, exibie os detalhes da invocação do comando para a execução junto com o ID da instância**
```
$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
}
}
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAssociationList`
O código de exemplo a seguir mostra como usar `Get-SSMAssociationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as associações para uma instância. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")}
Get-SSMAssociationList -AssociationFilterList $filter1
```
**Saída**:
```
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}
```
**Exemplo 2: esse exemplo lista todas as associações para um documento de configuração. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")}
Get-SSMAssociationList -AssociationFilterList $filter2
```
**Saída**:
```
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}
```
**Exemplo 3: Com a PowerShell versão 2, você deve usar New-Object para criar cada filtro.**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter
$filter1.Key = "InstanceId"
$filter1.Value = "i-0000293ffd8c57862"
Get-SSMAssociationList -AssociationFilterList $filter1
```
**Saída**:
```
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 obter detalhes da API, consulte [ListAssociations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAssociationVersionList`
O código de exemplo a seguir mostra como usar `Get-SSMAssociationVersionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera todas as versões da associação fornecida.**
```
Get-SSMAssociationVersionList -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**Saída**:
```
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 obter detalhes da API, consulte [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAutomationExecution`
O código de exemplo a seguir mostra como usar `Get-SSMAutomationExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe os detalhes de uma execução do Automation.**
```
Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
**Saída**:
```
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...}
```
**Exemplo 2: esse exemplo lista os detalhes da etapa para o ID de execução do Automation fornecido**
```
Get-SSMAutomationExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object -ExpandProperty StepExecutions | Select-Object StepName, Action, StepStatus, ValidNextSteps
```
**Saída**:
```
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 obter detalhes da API, consulte [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAutomationExecutionList`
O código de exemplo a seguir mostra como usar `Get-SSMAutomationExecutionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve todas as execuções do Automation ativas e encerradas associadas à sua conta.**
```
Get-SSMAutomationExecutionList
```
**Saída**:
```
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]]}
```
**Exemplo 2: Este exemplo exibe ExecutionID, documento e start/end data e hora de execução para execuções que não sejam 'Success' AutomationExecutionStatus **
```
Get-SSMAutomationExecutionList | Where-Object AutomationExecutionStatus -ne "Success" | Select-Object AutomationExecutionId, DocumentName, AutomationExecutionStatus, ExecutionStartTime, ExecutionEndTime | Format-Table -AutoSize
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAutomationStepExecution`
O código de exemplo a seguir mostra como usar `Get-SSMAutomationStepExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe informações sobre todas as execuções de etapas ativas e encerradas em um fluxo de trabalho do Automation.**
```
Get-SSMAutomationStepExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object StepName, Action, StepStatus
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMAvailablePatch`
O código de exemplo a seguir mostra como usar `Get-SSMAvailablePatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém todos os patches disponíveis para o Windows Server 2012 que apresentam gravidade MSRC crítica A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")}
$filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")}
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**Saída**:
```
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
...
```
**Exemplo 2: Com a PowerShell versão 2, você deve usar New-Object para criar 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
```
**Exemplo 3: Este exemplo busca todas as atualizações lançadas nos últimos 20 dias e aplicáveis aos produtos correspondentes WindowsServer a 2019**
```
Get-SSMAvailablePatch | Where-Object ReleaseDate -ge (Get-Date).AddDays(-20) | Where-Object Product -eq "WindowsServer2019" | Select-Object ReleaseDate, Product, Title
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMCommand`
O código de exemplo a seguir mostra como usar `Get-SSMCommand`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os comandos solicitados.**
```
Get-SSMCommand
```
**Saída**:
```
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 : {}
```
**Exemplo 2: esse exemplo obtém o status de um comando específico**
```
Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"
```
**Exemplo 3: esse exemplo recupera todos os comandos SSM invocados após 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
```
**Saída**:
```
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 obter detalhes da API, consulte [ListCommands](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMCommandInvocation`
O código de exemplo a seguir mostra como usar `Get-SSMCommandInvocation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as invocações de um comando.**
```
Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true
```
**Saída**:
```
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 :
```
**Exemplo 2: Este exemplo lista a invocação do ID de comando CommandPlugins e1eb2e3c-ed4c-5123-45c1-234f5612345f**
```
Get-SSMCommandInvocation -CommandId e1eb2e3c-ed4c-5123-45c1-234f5612345f -Detail:$true | Select-Object -ExpandProperty CommandPlugins
```
**Saída**:
```
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
```
+ Para obter detalhes da API, consulte [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMCommandInvocationDetail`
O código de exemplo a seguir mostra como usar `Get-SSMCommandInvocationDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe os detalhes de um comando executado em uma instância.**
```
Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMComplianceItemList`
O código de exemplo a seguir mostra como usar `Get-SSMComplianceItemList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra a lista de itens de conformidade para o ID e tipo de recurso fornecidos, filtrados pelo tipo de conformidade "Associação"**
```
Get-SSMComplianceItemList -ResourceId i-1a2caf345f67d0dc2 -ResourceType ManagedInstance -Filter @{Key="ComplianceType";Values="Association"}
```
**Saída**:
```
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 obter detalhes da API, consulte [ListComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMComplianceSummaryList`
O código de exemplo a seguir mostra como usar `Get-SSMComplianceSummaryList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo devolve uma contagem resumida de recursos em ou fora de conformidade para todos os tipos de conformidade.**
```
Get-SSMComplianceSummaryList
```
**Saída**:
```
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 obter detalhes da API, consulte [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMConnectionStatus`
O código de exemplo a seguir mostra como usar `Get-SSMConnectionStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera o status de conexão do Gerenciador de Sessões de uma instância para determinar se ela está conectada e pronta para receber conexões do Gerenciador de Sessões.**
```
Get-SSMConnectionStatus -Target i-0a1caf234f12d3dc4
```
**Saída**:
```
Status Target
------ ------
Connected i-0a1caf234f12d3dc4
```
+ Para obter detalhes da API, consulte [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDefaultPatchBaseline`
O código de exemplo a seguir mostra como usar `Get-SSMDefaultPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe a lista de referência de patches padrão.**
```
Get-SSMDefaultPatchBaseline
```
**Saída**:
```
arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966
```
+ Para obter detalhes da API, consulte [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDeployablePatchSnapshotForInstance`
O código de exemplo a seguir mostra como usar `Get-SSMDeployablePatchSnapshotForInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe o instantâneo atual da lista de referência de patches usada por uma instância. Esse comando deve ser executado da instância usando as credenciais da instância. Para garantir que use as credenciais da instância, o exemplo passa um objeto `Amazon.Runtime.InstanceProfileAWSCredentials` para o parâmetro Credentials.**
```
$credentials = [Amazon.Runtime.InstanceProfileAWSCredentials]::new()
Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" -Credentials $credentials
```
**Saída**:
```
InstanceId SnapshotDownloadUrl
---------- -------------------
i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...
```
**Exemplo 2: Este exemplo mostra como obter o completo SnapshotDownloadUrl. Esse comando deve ser executado da instância usando as credenciais da instância. Para garantir que ele use as credenciais da instância, o exemplo configura a PowerShell sessão para usar um `Amazon.Runtime.InstanceProfileAWSCredentials` objeto.**
```
Set-AWSCredential -Credential ([Amazon.Runtime.InstanceProfileAWSCredentials]::new())
(Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl
```
**Saída**:
```
https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...
```
+ Para obter detalhes da API, consulte [GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDocument`
O código de exemplo a seguir mostra como usar `Get-SSMDocument`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna o conteúdo de um documento.**
```
Get-SSMDocument -Name "RunShellScript"
```
**Saída**:
```
Content
-------
{...
```
**Exemplo 2: esse exemplo exibe o conteúdo completo de um 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 obter detalhes da API, consulte [GetDocument](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDocumentDescription`
O código de exemplo a seguir mostra como usar `Get-SSMDocumentDescription`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna informações sobre um documento.**
```
Get-SSMDocumentDescription -Name "RunShellScript"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeDocument](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDocumentList`
O código de exemplo a seguir mostra como usar `Get-SSMDocumentList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: lista todos os documentos de configuração em sua conta.**
```
Get-SSMDocumentList
```
**Saída**:
```
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
...
```
**Exemplo 2: esse exemplo recupera todos os documentos de automação com o nome correspondente a "Plataform"**
```
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
```
**Saída**:
```
DocumentFormat : JSON
DocumentType : Automation
DocumentVersion : 7
Name : KT-Get-Platform
Owner : 987654123456
PlatformTypes : {Windows, Linux}
SchemaVersion : 0.3
Tags : {}
TargetType :
VersionName :
```
+ Para obter detalhes da API, consulte [ListDocuments](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDocumentPermission`
O código de exemplo a seguir mostra como usar `Get-SSMDocumentPermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as versões de um documento.**
```
Get-SSMDocumentVersionList -Name "RunShellScript"
```
**Saída**:
```
CreatedDate DocumentVersion IsDefaultVersion Name
----------- --------------- ---------------- ----
2/24/2017 5:25:13 AM 1 True RunShellScript
```
+ Para obter detalhes da API, consulte [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMDocumentVersionList`
O código de exemplo a seguir mostra como usar `Get-SSMDocumentVersionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as versões de um documento.**
```
Get-SSMDocumentVersionList -Name "AWS-UpdateSSMAgent"
```
**Saída**:
```
CreatedDate : 6/1/2021 5:19:10 PM
DocumentFormat : JSON
DocumentVersion : 1
IsDefaultVersion : True
Name : AWS-UpdateSSMAgent
Status : Active
```
+ Para obter detalhes da API, consulte [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMEffectiveInstanceAssociationList`
O código de exemplo a seguir mostra como usar `Get-SSMEffectiveInstanceAssociationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo descreve as associações efetivas de uma instância.**
```
Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5
```
**Saída**:
```
AssociationId Content
------------- -------
d8617c07-2079-4c18-9847-1655fc2698b0 {...
```
**Exemplo 2: esse exemplo exibe o conteúdo das associações efetivas de uma instância.**
```
(Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content
```
**Saída**:
```
{
"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 obter detalhes da API, consulte [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMEffectivePatchesForPatchBaseline`
O código de exemplo a seguir mostra como usar `Get-SSMEffectivePatchesForPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra todas as listas de referência de patches, com uma lista de resultados máxima de 1.**
```
Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1
```
**Saída**:
```
Patch PatchStatus
----- -----------
Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus
```
**Exemplo 2: esse exemplo mostra o status do patch para todas as listas de referência de patches, com uma lista de resultados máxima de 1.**
```
(Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus
```
**Saída**:
```
ApprovalDate DeploymentStatus
------------ ----------------
12/21/2010 6:00:00 PM APPROVED
```
+ Para obter detalhes da API, consulte [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInstanceAssociationsStatus`
O código de exemplo a seguir mostra como usar `Get-SSMInstanceAssociationsStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra detalhes das associações de uma instância.**
```
Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo verifica o status da associação da instância para o ID da instância fornecido e exibe o status de execução dessas associações**
```
Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInstanceInformation`
O código de exemplo a seguir mostra como usar `Get-SSMInstanceInformation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra detalhes de cada uma de suas instâncias.**
```
Get-SSMInstanceInformation
```
**Saída**:
```
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
```
**Exemplo 2: Este exemplo mostra como usar o parâmetro -Filter para filtrar os resultados somente para as instâncias do AWS Systems Manager na região `us-east-1` com um `AgentVersion` de`2.2.800.0`. Você pode encontrar uma lista de valores-chave válidos de -Filter no tópico de referência da 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
```
**Saída**:
```
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
```
**Exemplo 3: Este exemplo mostra como usar o InstanceInformationFilterList parâmetro - para filtrar os resultados somente para as instâncias do AWS Systems Manager na região `us-east-1` com `PlatformTypes` `Windows` ou`Linux`. Você pode encontrar uma lista de InstanceInformationFilterList valores-chave válidos no tópico de referência da InstanceInformationFilter API (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1 InstanceInformationFilter .html).**
```
$Filters = @{
Key="PlatformTypes"
ValueSet=("Windows","Linux")
}
Get-SSMInstanceInformation -Region us-east-1 -InstanceInformationFilterList $Filters
```
**Saída**:
```
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
```
**Exemplo 4: Este exemplo lista as instâncias e exportações InstanceId gerenciadas por ssm LastPingDateTime e PlatformName em um arquivo csv. PingStatus**
```
Get-SSMInstanceInformation | Select-Object InstanceId, PingStatus, LastPingDateTime, PlatformName | Export-Csv Instance-details.csv -NoTypeInformation
```
+ Para obter detalhes da API, consulte [DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInstancePatch`
O código de exemplo a seguir mostra como usar `Get-SSMInstancePatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os detalhes de conformidade do patch para uma instância.**
```
Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"
```
+ Para obter detalhes da API, consulte [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInstancePatchState`
O código de exemplo a seguir mostra como usar `Get-SSMInstancePatchState`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os estados resumidos de patches para uma instância.**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"
```
**Exemplo 2: esse exemplo obtém os estados resumidos de patches para duas instâncias.**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"
```
+ Para obter detalhes da API, consulte [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInstancePatchStatesForPatchGroup`
O código de exemplo a seguir mostra como usar `Get-SSMInstancePatchStatesForPatchGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os estados de resumo de patches por instância de um grupo de patches.**
```
Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"
```
+ Para obter detalhes da API, consulte [DescribeInstancePatchStatesForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInventory`
O código de exemplo a seguir mostra como usar `Get-SSMInventory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os metadados personalizados do seu inventário.**
```
Get-SSMInventory
```
**Saída**:
```
Data Id
---- --
{[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f
```
+ Para obter detalhes da API, consulte [GetInventory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInventoryEntriesList`
O código de exemplo a seguir mostra como usar `Get-SSMInventoryEntriesList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as entradas de inventário personalizadas para uma instância.**
```
Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo"
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo lista os detalhes.**
```
(Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries
```
**Saída**:
```
Key Value
--- -----
RackLocation Bay B/Row C/Rack D/Shelf E
```
+ Para obter detalhes da API, consulte [ListInventoryEntries](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMInventoryEntryList`
O código de exemplo a seguir mostra como usar `Get-SSMInventoryEntryList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo recupera entradas de inventário do tipo `AWS:Network` da instância.**
```
Get-SSMInventoryEntryList -InstanceId mi-088dcb0ecea37b076 -TypeName AWS:Network | Select-Object -ExpandProperty Entries
```
**Saída**:
```
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 obter detalhes da API, consulte [Get- SSMInventory EntryList](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Get-SSMInventorySchema`
O código de exemplo a seguir mostra como usar `Get-SSMInventorySchema`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo retorna uma lista de nomes de tipos de inventário para a conta.**
```
Get-SSMInventorySchema
```
+ Para obter detalhes da API, consulte [GetInventorySchema](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMLatestEC2Image`
O código de exemplo a seguir mostra como usar `Get-SSMLatestEC2Image`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo lista todas as versões mais recentes do Windows AMIs.**
```
PS Get-SSMLatestEC2Image -Path ami-windows-latest
```
**Saída**:
```
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
...
```
**Exemplo 2: esse exemplo recupera o ID da AMI de uma imagem específica do Amazon Linux para a região us-west-2.**
```
PS Get-SSMLatestEC2Image -Path ami-amazon-linux-latest -ImageName amzn-ami-hvm-x86_64-ebs -Region us-west-2
```
**Saída**:
```
ami-09b92cd132204c704
```
**Exemplo 3: Este exemplo lista todas as últimas janelas que AMIs correspondem à expressão curinga especificada.**
```
Get-SSMLatestEC2Image -Path ami-windows-latest -ImageName *Windows*2019*English*
```
**Saída**:
```
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 obter detalhes da API, consulte [Get- SSMLatest EC2 Image](https://docs.aws.amazon.com/powershell/v5/reference) in *Ferramentas da AWS para PowerShell Cmdlet Reference (V5)*.
### `Get-SSMMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém detalhes sobre uma janela de manutenção.**
```
Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowExecution`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista informações sobre uma tarefa que foi executada como parte da execução de uma janela de manutenção.**
```
Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetMaintenanceWindowExecution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowExecutionList`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowExecutionList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as execuções para uma janela de manutenção.**
```
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d"
```
**Saída**:
```
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
```
**Exemplo 2: esse exemplo lista todas as execuções para uma janela de manutenção antes de uma data especificada.**
```
$option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
**Exemplo 3: esse exemplo lista todas as execuções para uma janela de manutenção após uma data especificada.**
```
$option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
+ Para obter detalhes da API, consulte [DescribeMaintenanceWindowExecutions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowExecutionTask`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowExecutionTask`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista informações sobre uma tarefa que fazia parte da execução de uma janela de manutenção.**
```
Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetMaintenanceWindowExecutionTask](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowExecutionTaskInvocationList`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowExecutionTaskInvocationList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as invocações de uma tarefa executada como parte da execução de uma janela de manutenção.**
```
Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeMaintenanceWindowExecutionTaskInvocations](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowExecutionTaskList`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowExecutionTaskList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as tarefas associadas à execução de uma janela de manutenção.**
```
Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeMaintenanceWindowExecutionTasks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowList`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as janelas de manutenção em sua conta.**
```
Get-SSMMaintenanceWindowList
```
**Saída**:
```
Cutoff : 1
Duration : 4
Enabled : True
Name : My-First-Maintenance-Window
WindowId : mw-06d59c1a07c022145
```
+ Para obter detalhes da API, consulte [DescribeMaintenanceWindows](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowTarget`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowTarget`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os destinos para uma janela de manutenção.**
```
Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeMaintenanceWindowTargets](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMMaintenanceWindowTaskList`
O código de exemplo a seguir mostra como usar `Get-SSMMaintenanceWindowTaskList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todas as tarefas para uma janela de manutenção.**
```
Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f"
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeMaintenanceWindowTasks](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMParameterHistory`
O código de exemplo a seguir mostra como usar `Get-SSMParameterHistory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista o histórico de valores de um parâmetro.**
```
Get-SSMParameterHistory -Name "Welcome"
```
**Saída**:
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:55:25 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
Value : helloWorld
```
+ Para obter detalhes da API, consulte [GetParameterHistory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMParameterList`
O código de exemplo a seguir mostra como usar `Get-SSMParameterList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista todos os parâmetros.**
```
Get-SSMParameterList
```
**Saída**:
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ Para obter detalhes da API, consulte [DescribeParameters](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMParameterValue`
O código de exemplo a seguir mostra como usar `Get-SSMParameterValue`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista os valores de um parâmetro.**
```
Get-SSMParameterValue -Name "Welcome"
```
**Saída**:
```
InvalidParameters Parameters
----------------- ----------
{} {Welcome}
```
**Exemplo 2: esse exemplo retorna os detalhes do valor.**
```
(Get-SSMParameterValue -Name "Welcome").Parameters
```
**Saída**:
```
Name Type Value
---- ---- -----
Welcome String Good day, Sunshine!
```
+ Para obter detalhes da API, consulte [GetParameters](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMPatchBaseline`
O código de exemplo a seguir mostra como usar `Get-SSMPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo mostra todas as listas de referência de patches.**
```
Get-SSMPatchBaseline
```
**Saída**:
```
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...
```
**Exemplo 2: Este exemplo lista todas as linhas de base de patch fornecidas pelo. AWS A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$filter1 = @{Key="OWNER";Values=@("AWS")}
```
**Saída**:
```
Get-SSMPatchBaseline -Filter $filter1
```
**Exemplo 3: esse exemplo mostra todas as listas de referência de patches pertencentes a você. A sintaxe usada neste exemplo requer a PowerShell versão 3 ou posterior.**
```
$filter1 = @{Key="OWNER";Values=@("Self")}
```
**Saída**:
```
Get-SSMPatchBaseline -Filter $filter1
```
**Exemplo 4: Com a PowerShell versão 2, você deve usar New-Object para criar cada tag.**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "OWNER"
$filter1.Values = "AWS"
Get-SSMPatchBaseline -Filter $filter1
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribePatchBaselines](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMPatchBaselineDetail`
O código de exemplo a seguir mostra como usar `Get-SSMPatchBaselineDetail`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe os detalhes de uma lista de referência de patches.**
```
Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639"
```
**Saída**:
```
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 obter detalhes da API, consulte [GetPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMPatchBaselineForPatchGroup`
O código de exemplo a seguir mostra como usar `Get-SSMPatchBaselineForPatchGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exibe a lista de referência de patches para um grupo de patches.**
```
Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production"
```
**Saída**:
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ Para obter detalhes da API, consulte [GetPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMPatchGroup`
O código de exemplo a seguir mostra como usar `Get-SSMPatchGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista os registros do grupo de patches.**
```
Get-SSMPatchGroup
```
**Saída**:
```
BaselineIdentity PatchGroup
---------------- ----------
Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production
```
+ Para obter detalhes da API, consulte [DescribePatchGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMPatchGroupState`
O código de exemplo a seguir mostra como usar `Get-SSMPatchGroupState`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém o resumo da conformidade de patches de alto nível para um grupo de patches.**
```
Get-SSMPatchGroupState -PatchGroup "Production"
```
**Saída**:
```
Instances : 4
InstancesWithFailedPatches : 1
InstancesWithInstalledOtherPatches : 4
InstancesWithInstalledPatches : 3
InstancesWithMissingPatches : 0
InstancesWithNotApplicablePatches : 0
```
+ Para obter detalhes da API, consulte [DescribePatchGroupState](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMResourceComplianceSummaryList`
O código de exemplo a seguir mostra como usar `Get-SSMResourceComplianceSummaryList`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém uma contagem resumida em nível de recurso. O resumo inclui informações sobre status de conformidade e não conformidade e contagens detalhadas de gravidade de itens de conformidade para produtos que correspondem a "Windows10". Como o MaxResult padrão é 100 se o parâmetro não for especificado e esse valor não for válido, o MaxResult parâmetro será adicionado e o valor será definido como 50.**
```
$FilterValues = @{
"Key"="Product"
"Type"="EQUAL"
"Values"="Windows10"
}
Get-SSMResourceComplianceSummaryList -Filter $FilterValues -MaxResult 50
```
+ Para obter detalhes da API, consulte [ListResourceComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-SSMResourceTag`
O código de exemplo a seguir mostra como usar `Get-SSMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo lista as tags para uma janela de manutenção.**
```
Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow"
```
**Saída**:
```
Key Value
--- -----
Stack Production
```
+ Para obter detalhes da API, consulte [ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMActivation`
O código de exemplo a seguir mostra como usar `New-SSMActivation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma instância gerenciada.**
```
New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10
```
**Saída**:
```
ActivationCode ActivationId
-------------- ------------
KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363
```
+ Para obter detalhes da API, consulte [CreateActivation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMAssociation`
O código de exemplo a seguir mostra como usar `New-SSMAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo associa um documento de configuração a uma instância, usando instance IDs.**
```
New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
**Saída**:
```
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 :
```
**Exemplo 2: esse exemplo associa um documento de configuração a uma instância usando destinos.**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $target
```
**Saída**:
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**Exemplo 3: esse exemplo associa um documento de configuração a uma instância usando destinos e 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
```
**Saída**:
```
Name : Configure-CloudWatch
InstanceId :
Date : 5/17/2018 3:17:44 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**Exemplo 4: esse exemplo cria uma associação com todas as instâncias na região, com `AWS-GatherSoftwareInventory`. Ele também fornece arquivos personalizados e locais de registro nos parâmetros a serem coletados**
```
$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)"
```
**Saída**:
```
Name : AWS-GatherSoftwareInventory
InstanceId :
Date : 6/9/2019 8:57:56 AM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ Para obter detalhes da API, consulte [CreateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMAssociationFromBatch`
O código de exemplo a seguir mostra como usar `New-SSMAssociationFromBatch`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo associa um documento de configuração a várias instâncias. A saída retorna uma lista de operações bem e malsucedidas, se aplicável.**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
New-SSMAssociationFromBatch -Entry $option1,$option2
```
**Saída**:
```
Failed Successful
------ ----------
{} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...
```
**Exemplo 2: esse exemplo mostrará os detalhes completos de uma operação bem-sucedida.**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
(New-SSMAssociationFromBatch -Entry $option1,$option2).Successful
```
+ Para obter detalhes da API, consulte [CreateAssociationBatch](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMDocument`
O código de exemplo a seguir mostra como usar `New-SSMDocument`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um documento na sua conta. O documento deve estar em formato JSON. Para obter mais informações sobre como escrever um documento de configuração, consulte Documento de configuração na Referência da API do SSM.**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateDocument](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMMaintenanceWindow`
O código de exemplo a seguir mostra como usar `New-SSMMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma nova janela de manutenção com o nome especificado que é executada às 16h toda terça-feiras por 4 horas, com um limite de 1 hora, e que permite destinos não associados.**
```
New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)"
```
**Saída**:
```
mw-03eb53e1ea7383998
```
+ Para obter detalhes da API, consulte [CreateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-SSMPatchBaseline`
O código de exemplo a seguir mostra como usar `New-SSMPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria uma lista de referência de patches que aprova patches, sete dias após serem lançados pela Microsoft, para instâncias gerenciadas que executam o Windows Server 2019 em um ambiente de produção.**
```
$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
```
**Saída**:
```
pb-0z4z6221c4296b23z
```
+ Para obter detalhes da API, consulte [CreatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-SSMDefaultPatchBaseline`
O código de exemplo a seguir mostra como usar `Register-SSMDefaultPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: este exemplo registra uma lista de referência de patches como a lista de referência de patches padrão.**
```
Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639"
```
**Saída**:
```
pb-03da896ca3b68b639
```
+ Para obter detalhes da API, consulte [RegisterDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-SSMPatchBaselineForPatchGroup`
O código de exemplo a seguir mostra como usar `Register-SSMPatchBaselineForPatchGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma lista de referência de patches para um grupo de patches.**
```
Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production"
```
**Saída**:
```
BaselineId PatchGroup
---------- ----------
pb-03da896ca3b68b639 Production
```
+ Para obter detalhes da API, consulte [RegisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-SSMTargetWithMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Register-SSMTargetWithMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma instância com uma janela de manutenção.**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**Saída**:
```
d8e47760-23ed-46a5-9f28-927337725398
```
**Exemplo 2: esse exemplo registra várias instâncias com uma janela de manutenção.**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**Saída**:
```
6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
**Exemplo 3: Esse exemplo registra uma instância com uma janela de manutenção usando EC2 tags.**
```
$option1 = @{Key="tag:Environment";Values=@("Production")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE"
```
**Saída**:
```
2994977e-aefb-4a71-beac-df620352f184
```
+ Para obter detalhes da API, consulte [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-SSMTaskWithMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Register-SSMTaskWithMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra uma tarefa com uma janela de manutenção usando um ID de instância. A saída é o ID da tarefa.**
```
$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
```
**Saída**:
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**Exemplo 2: esse exemplo registra uma tarefa com uma janela de manutenção usando um ID de destino. A saída é o ID da tarefa.**
```
$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
```
**Saída**:
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**Exemplo 3: esse exemplo cria um objeto de parâmetro para o documento de comandos de execução `AWS-RunPowerShellScript` e cria uma tarefa com uma janela de manutenção determinada usando o ID de destino. A saída devolvida é o ID da tarefa.**
```
$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
```
**Saída**:
```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**Exemplo 4: Este exemplo registra uma tarefa do AWS Systems Manager Automation usando um documento chamado`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 obter detalhes da API, consulte [RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMActivation`
O código de exemplo a seguir mostra como usar `Remove-SSMActivation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui uma ativação. Não haverá saída se o comando for bem-sucedido.**
```
Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"
```
+ Para obter detalhes da API, consulte [DeleteActivation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMAssociation`
O código de exemplo a seguir mostra como usar `Remove-SSMAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui a associação entre uma instância e um documento. Não haverá saída se o comando for bem-sucedido.**
```
Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
+ Para obter detalhes da API, consulte [DeleteAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMDocument`
O código de exemplo a seguir mostra como usar `Remove-SSMDocument`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui um documento. Não haverá saída se o comando for bem-sucedido.**
```
Remove-SSMDocument -Name "RunShellScript"
```
+ Para obter detalhes da API, consulte [DeleteDocument](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Remove-SSMMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove uma janela de manutenção.**
```
Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145"
```
**Saída**:
```
mw-06d59c1a07c022145
```
+ Para obter detalhes da API, consulte [DeleteMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMParameter`
O código de exemplo a seguir mostra como usar `Remove-SSMParameter`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui um parâmetro. Não haverá saída se o comando for bem-sucedido.**
```
Remove-SSMParameter -Name "helloWorld"
```
+ Para obter detalhes da API, consulte [DeleteParameter](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMPatchBaseline`
O código de exemplo a seguir mostra como usar `Remove-SSMPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui uma lista de referência de patches.**
```
Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda"
```
**Saída**:
```
pb-045f10b4f382baeda
```
+ Para obter detalhes da API, consulte [DeletePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-SSMResourceTag`
O código de exemplo a seguir mostra como usar `Remove-SSMResourceTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove uma tag de uma janela de manutenção. Não haverá saída se o comando for bem-sucedido.**
```
Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"
```
+ Para obter detalhes da API, consulte [RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Send-SSMCommand`
O código de exemplo a seguir mostra como usar `Send-SSMCommand`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo executa um comando echo em uma instância de destino.**
```
Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
```
**Saída**:
```
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}
```
**Exemplo 2: esse exemplo mostra como executar um comando que aceita parâmetros aninhados.**
```
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 obter detalhes da API, consulte [SendCommand](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-SSMAutomationExecution`
O código de exemplo a seguir mostra como usar `Start-SSMAutomationExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo executa um documento especificando uma função de automação, uma ID de origem da AMI e uma função de EC2 instância da Amazon.**
```
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
```
**Saída**:
```
3a532a4f-0382-11e7-9df7-6f11185f6dd1
```
+ Para obter detalhes da API, consulte [StartAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Start-SSMSession`
O código de exemplo a seguir mostra como usar `Start-SSMSession`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo inicia uma conexão com um destino para uma sessão do Session Manager, habilitando o encaminhamento de portas. Nota: Você precisa adicionar o parâmetro Região, se ainda não estiver definido usando AWSCredentials.**
```
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' } -Region 'us-west-1'
```
**Saída**:
```
Starting session with SessionId: testUser-xi4glew849asyeryde34u4dfsdfy
Port 8080 opened for sessionId testUser-xi4glew849asyeryde34u4dfsdfy.
Waiting for connections...
```
**Exemplo 2: esse exemplo cria uma sessão interativa com uma instância especificada para uma sessão do Session Manager.**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1'
```
**Saída**:
```
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>
```
**Exemplo 3: Este exemplo cria uma sessão sem se conectar a ela e retorna as TokenValue propriedades SessionId StreamUrl,, e necessárias para se conectar à sessão.**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1' -DisablePluginInvocation
```
**Saída**:
```
SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
StreamUrl : {StreamUrl value redacted}
TokenValue : {Token value redacted}
ContentLength : 1207
HttpStatusCode : OK
```
+ Para obter detalhes da API, consulte [StartSession](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-SSMAutomationExecution`
O código de exemplo a seguir mostra como usar `Stop-SSMAutomationExecution`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo interrompe uma execução do Automation. Não haverá saída se o comando for bem-sucedido.**
```
Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
+ Para obter detalhes da API, consulte [StopAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-SSMCommand`
O código de exemplo a seguir mostra como usar `Stop-SSMCommand`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo tenta cancelar um comando. Não haverá saída se a operação for bem-sucedida.**
```
Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"
```
+ Para obter detalhes da API, consulte [CancelCommand](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-SSMManagedInstance`
O código de exemplo a seguir mostra como usar `Unregister-SSMManagedInstance`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela o registro de uma instância gerenciada. Não haverá saída se o comando for bem-sucedido.**
```
Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"
```
+ Para obter detalhes da API, consulte [DeregisterManagedInstance](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-SSMPatchBaselineForPatchGroup`
O código de exemplo a seguir mostra como usar `Unregister-SSMPatchBaselineForPatchGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cancela o registro de um grupo de patches de uma lista de referência de patches.**
```
Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production"
```
**Saída**:
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ Para obter detalhes da API, consulte [DeregisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-SSMTargetFromMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Unregister-SSMTargetFromMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove um destino de uma janela de manutenção.**
```
Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f"
```
**Saída**:
```
WindowId WindowTargetId
-------- --------------
mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
+ Para obter detalhes da API, consulte [DeregisterTargetFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-SSMTaskFromMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Unregister-SSMTaskFromMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove uma tarefa de uma janela de manutenção.**
```
Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0"
```
**Saída**:
```
WindowId WindowTaskId
-------- ------------
mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
+ Para obter detalhes da API, consulte [DeregisterTaskFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMAssociation`
O código de exemplo a seguir mostra como usar `Update-SSMAssociation`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza uma associação com uma nova versão de documento.**
```
Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1"
```
**Saída**:
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ Para obter detalhes da API, consulte [UpdateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMAssociationStatus`
O código de exemplo a seguir mostra como usar `Update-SSMAssociationStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza o status da associação entre uma instância e um documento de configuração.**
```
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"
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateAssociationStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMDocument`
O código de exemplo a seguir mostra como usar `Update-SSMDocument`.
**Ferramentas para PowerShell V5**
**Exemplo 1: isso cria uma nova versão de um documento com o conteúdo atualizado do arquivo json que você especificar. O documento deve estar em formato JSON. Você pode obter a versão do documento com o cmdlet “Get- SSMDocumentVersionList”.**
```
Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json")
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdateDocument](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMDocumentDefaultVersion`
O código de exemplo a seguir mostra como usar `Update-SSMDocumentDefaultVersion`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza a versão padrão de um documento. Você pode obter as versões disponíveis do documento com o cmdlet “Get- SSMDocumentVersionList”.**
```
Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2"
```
**Saída**:
```
DefaultVersion Name
-------------- ----
2 RunShellScript
```
+ Para obter detalhes da API, consulte [UpdateDocumentDefaultVersion](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMMaintenanceWindow`
O código de exemplo a seguir mostra como usar `Update-SSMMaintenanceWindow`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza o nome de uma janela de manutenção.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW"
```
**Saída**:
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**Exemplo 2: esse exemplo habilita uma janela de manutenção.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true
```
**Saída**:
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**Exemplo 3: esse exemplo desabilita uma janela de manutenção.**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false
```
**Saída**:
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : False
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ Para obter detalhes da API, consulte [UpdateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMManagedInstanceRole`
O código de exemplo a seguir mostra como usar `Update-SSMManagedInstanceRole`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atualiza o perfil de uma instância gerenciada. Não haverá saída se o comando for bem-sucedido.**
```
Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"
```
+ Para obter detalhes da API, consulte [UpdateManagedInstanceRole](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Update-SSMPatchBaseline`
O código de exemplo a seguir mostra como usar `Update-SSMPatchBaseline`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona dois patches como rejeitados e um patch como aprovado a uma lista de referência de patches existente.**
```
Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261"
```
**Saída**:
```
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 obter detalhes da API, consulte [UpdatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-SSMComplianceItem`
O código de exemplo a seguir mostra como usar `Write-SSMComplianceItem`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo grava um item de conformidade personalizado para a instância gerenciada 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 obter detalhes da API, consulte [PutComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-SSMInventory`
O código de exemplo a seguir mostra como usar `Write-SSMInventory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo atribui informações de localização de rack a uma instância. Não haverá saída se o comando for bem-sucedido.**
```
$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 obter detalhes da API, consulte [PutInventory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Write-SSMParameter`
O código de exemplo a seguir mostra como usar `Write-SSMParameter`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo cria um parâmetro. Não haverá saída se o comando for bem-sucedido.**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"
```
**Exemplo 2: esse exemplo altera um parâmetro. Não haverá saída se o comando for bem-sucedido.**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
```
+ Para obter detalhes da API, consulte [PutParameter](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# Exemplos do Amazon Translate usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com o Amazon Translate.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `ConvertTo-TRNTargetLanguage`
O código de exemplo a seguir mostra como usar `ConvertTo-TRNTargetLanguage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: converte o texto em inglês especificado em francês. O texto a ser convertido também pode ser passado como o parâmetro -Text.**
```
"Hello World" | ConvertTo-TRNTargetLanguage -SourceLanguageCode en -TargetLanguageCode fr
```
+ Para obter detalhes da API, consulte [TranslateText](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# AWS WAFV2 exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com AWS WAFV2.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `New-WAF2WebACL`
O código de exemplo a seguir mostra como usar `New-WAF2WebACL`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse comando cria uma ACL da web chamada “waf-test”. Observe que, de acordo com a documentação da API de serviço, 'DefaultAction' é uma propriedade obrigatória. Portanto, o valor de '- DefaultAction \$1Allow' '- and/or DefaultAction \$1Block' deve ser especificado. Como '- DefaultAction \$1Allow' e '- DefaultAction \$1Block 'não são as propriedades obrigatórias, o valor '@ \$1\$1' pode ser usado como espaço reservado, conforme mostrado no exemplo acima.**
```
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 @{}
```
**Saída**:
```
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 obter detalhes da API, consulte [CreateWebAcl](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
# WorkSpaces exemplos usando o Tools for PowerShell V5
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o Ferramentas da AWS para PowerShell V5 com WorkSpaces.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `Approve-WKSIpRule`
O código de exemplo a seguir mostra como usar `Approve-WKSIpRule`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona regras a um 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 obter detalhes da API, consulte [AuthorizeIpRules](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Copy-WKSWorkspaceImage`
O código de exemplo a seguir mostra como usar `Copy-WKSWorkspaceImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Este exemplo copia a imagem do espaço de trabalho com o ID especificado de us-west-2 para a região atual com o nome "" CopiedImageTest**
```
Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6
```
**Saída**:
```
wsi-456abaqfe
```
+ Para obter detalhes da API, consulte [CopyWorkspaceImage](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSClientProperty`
O código de exemplo a seguir mostra como usar `Edit-WKSClientProperty`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo permite a reconexão para o cliente do Workspaces**
```
Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369
```
+ Para obter detalhes da API, consulte [ModifyClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSSelfServicePermission`
O código de exemplo a seguir mostra como usar `Edit-WKSSelfServicePermission`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo concede permissões de autoatendimento para alterar o tipo de computação e aumentar o tamanho do volume para o diretório especificado**
```
Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED
```
+ Para obter detalhes da API, consulte [ModifySelfservicePermissions](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSWorkspaceAccessProperty`
O código de exemplo a seguir mostra como usar `Edit-WKSWorkspaceAccessProperty`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo permite o acesso ao Workspace no Android e no Chrome OS para o diretório especificado**
```
Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceAccessProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSWorkspaceCreationProperty`
O código de exemplo a seguir mostra como usar `Edit-WKSWorkspaceCreationProperty`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo permite que o Modo de Manutenção e Acesso à Internet seja verdadeiro como valores padrão ao criar um espaço de trabalho**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSWorkspaceProperty`
O código de exemplo a seguir mostra como usar `Edit-WKSWorkspaceProperty`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera a propriedade do modo de execução do espaço de trabalho para interrupção automática referente ao espaço de trabalho especificado**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Edit-WKSWorkspaceState`
O código de exemplo a seguir mostra como usar `Edit-WKSWorkspaceState`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o estado do espaço de trabalho especificado para Disponível**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSClientProperty`
O código de exemplo a seguir mostra como usar `Get-WKSClientProperty`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém as propriedades do cliente do Workspace Client para o diretório especificado**
```
Get-WKSClientProperty -ResourceId d-223562a123
```
+ Para obter detalhes da API, consulte [DescribeClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSIpGroup`
O código de exemplo a seguir mostra como usar `Get-WKSIpGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo obtém os detalhes do grupo de IP especificado na região especificada**
```
Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45
```
**Saída**:
```
GroupDesc GroupId GroupName UserRules
--------- ------- --------- ---------
wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}
```
+ Para obter detalhes da API, consulte [DescribeIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSTag`
O código de exemplo a seguir mostra como usar `Get-WKSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca a tag para o espaço de trabalho fornecido**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Saída**:
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspace`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.**
```
Get-WKSWorkspace
```
**Saída**:
```
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
```
**Exemplo 2: esse comando mostra os valores das propriedades secundárias de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. Para obter mais informações sobre as propriedades secundárias 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
```
**Saída**:
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Exemplo 3: esse comando mostra o valor da propriedade secundária `RootVolumeSizeGib` de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. O tamanho do volume raiz, em GiB, é 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Saída**:
```
80
```
+ Para obter detalhes da API, consulte [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspaceBundle`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspaceBundle`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra busca detalhes de todos os pacotes do Workspace na região atual**
```
Get-WKSWorkspaceBundle
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspaceDirectory`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspaceDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra lista os detalhes do diretório para diretórios registrados**
```
Get-WKSWorkspaceDirectory
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspaceImage`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspaceImage`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra busca todos os detalhes de todas as imagens na região**
```
Get-WKSWorkspaceImage
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceImages](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspaceSnapshot`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspaceSnapshot`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra mostra o carimbo de data/hora do snapshot mais recente criado para o espaço de trabalho especificado**
```
Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v
```
**Saída**:
```
RebuildSnapshots RestoreSnapshots
---------------- ----------------
{Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}
```
+ Para obter detalhes da API, consulte [DescribeWorkspaceSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Get-WKSWorkspacesConnectionStatus`
O código de exemplo a seguir mostra como usar `Get-WKSWorkspacesConnectionStatus`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra busca o status da conexão para o espaço de trabalho especificado**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obter detalhes da API, consulte [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-WKSIpGroup`
O código de exemplo a seguir mostra como usar `New-WKSIpGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Esse exemplo cria um grupo de IP vazio chamado FreshEmptyIpGroup**
```
New-WKSIpGroup -GroupName "FreshNewIPGroup"
```
**Saída**:
```
wsipg-w45rty4ty
```
+ Para obter detalhes da API, consulte [CreateIpGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-WKSTag`
O código de exemplo a seguir mostra como usar `New-WKSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona uma nova tag a um espaço de trabalho chamado `ws-wsname`. A tag tem uma chave de “Name” e um valor-chave de `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
```
**Exemplo 2: esse exemplo adiciona várias tags a um espaço de trabalho chamado `ws-wsname`. Uma tag tem uma chave de “Name” e um valor-chave de `AWS_Workspace`; a outra tag tem uma chave de tag de “Stage” e um valor-chave de “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 obter detalhes da API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `New-WKSWorkspace`
O código de exemplo a seguir mostra como usar `New-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Crie um WorkSpace para o pacote, o diretório e o usuário fornecidos.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Exemplo 2: Este exemplo cria vários WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obter detalhes da API, consulte [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-WKSIpGroup`
O código de exemplo a seguir mostra como usar `Register-WKSIpGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra o grupo de IP especificado com o diretório especificado**
```
Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
```
+ Para obter detalhes da API, consulte [AssociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Register-WKSWorkspaceDirectory`
O código de exemplo a seguir mostra como usar `Register-WKSWorkspaceDirectory`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra o diretório especificado para o Workspaces Service**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obter detalhes da API, consulte [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-WKSIpGroup`
O código de exemplo a seguir mostra como usar `Remove-WKSIpGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo exclui o grupo de IP especificado**
```
Remove-WKSIpGroup -GroupId wsipg-32fhgtred
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteIpGroup](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-WKSTag`
O código de exemplo a seguir mostra como usar `Remove-WKSTag`.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag associada ao espaço de trabalho**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Remove-WKSWorkspace`
O código de exemplo a seguir mostra como usar `Remove-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Encerra vários WorkSpaces. O uso da opção -Force impede que o cmdlet solicite confirmação.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Exemplo 2: Recupera a coleção de todas as suas WorkSpaces e canaliza IDs para o WorkSpaceId parâmetro - de Remove-WKSWorkspace, encerrando todas as. WorkSpaces O cmdlet avisará antes que cada um WorkSpace seja encerrado. Para ignorar a solicitação de confirmação, adicione a opção -Force.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar TerminateRequest objetos definindo o WorkSpaces a ser encerrado. O cmdlet solicitará a confirmação antes de continuar, a menos que o parâmetro da opção -Force também seja especificado.**
```
$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 obter detalhes da API, consulte [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Reset-WKSWorkspace`
O código de exemplo a seguir mostra como usar `Reset-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: reconstrói o especificado. WorkSpace**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Reset-WKSWorkspace, fazendo com que o WorkSpaces seja reconstruído.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Restart-WKSWorkspace`
O código de exemplo a seguir mostra como usar `Restart-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Reinicializa o especificado WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Reinicializa várias WorkSpaces.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Exemplo 3: recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Restart-WKSWorkspace, fazendo com que o WorkSpaces seja reiniciado.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Stop-WKSWorkspace`
O código de exemplo a seguir mostra como usar `Stop-WKSWorkspace`.
**Ferramentas para PowerShell V5**
**Exemplo 1: Interrompe várias WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e canaliza o IDs WorkSpaceId parâmetro - de Stop- WKSWorkspace fazendo com que o WorkSpaces seja interrompido.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar StopRequest objetos definindo o WorkSpaces a ser parado.**
```
$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 obter detalhes da API, consulte [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
### `Unregister-WKSIpGroup`
O código de exemplo a seguir mostra como usar `Unregister-WKSIpGroup`.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra cancela o registro do grupo de IP especificado do diretório especificado**
```
Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123
```
+ Para obter detalhes da API, consulte [DisassociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.